update website latest
diff --git a/docs/latest/_images/anonymous_blocking01.png b/docs/latest/_images/anonymous_blocking01.png
new file mode 100644
index 0000000..bda89db
--- /dev/null
+++ b/docs/latest/_images/anonymous_blocking01.png
Binary files differ
diff --git a/docs/latest/_images/anonymous_blocking02.png b/docs/latest/_images/anonymous_blocking02.png
new file mode 100644
index 0000000..0b74046
--- /dev/null
+++ b/docs/latest/_images/anonymous_blocking02.png
Binary files differ
diff --git a/docs/latest/_images/ds-profile.png b/docs/latest/_images/ds-profile.png
new file mode 100644
index 0000000..97ee6f8
--- /dev/null
+++ b/docs/latest/_images/ds-profile.png
Binary files differ
diff --git a/docs/latest/_images/ds_profile_parameters.png b/docs/latest/_images/ds_profile_parameters.png
new file mode 100644
index 0000000..7c8f12b
--- /dev/null
+++ b/docs/latest/_images/ds_profile_parameters.png
Binary files differ
diff --git a/docs/latest/_images/graph.png b/docs/latest/_images/graph.png
index ea0b4c5..4502a2d 100644
--- a/docs/latest/_images/graph.png
+++ b/docs/latest/_images/graph.png
Binary files differ
diff --git a/docs/latest/_images/info.png b/docs/latest/_images/info.png
index 5680f06..3e1125c 100644
--- a/docs/latest/_images/info.png
+++ b/docs/latest/_images/info.png
Binary files differ
diff --git a/docs/latest/_images/mso-enable.png b/docs/latest/_images/mso-enable.png
index 9932de1..70207ba 100644
--- a/docs/latest/_images/mso-enable.png
+++ b/docs/latest/_images/mso-enable.png
Binary files differ
diff --git a/docs/latest/_images/tp_menu.png b/docs/latest/_images/tp_menu.png
new file mode 100644
index 0000000..d8052c7
--- /dev/null
+++ b/docs/latest/_images/tp_menu.png
Binary files differ
diff --git a/docs/latest/_images/tp_menu_configure.png b/docs/latest/_images/tp_menu_configure.png
new file mode 100644
index 0000000..4a5d211
--- /dev/null
+++ b/docs/latest/_images/tp_menu_configure.png
Binary files differ
diff --git a/docs/latest/_images/tp_menu_monitor.png b/docs/latest/_images/tp_menu_monitor.png
new file mode 100644
index 0000000..845364e
--- /dev/null
+++ b/docs/latest/_images/tp_menu_monitor.png
Binary files differ
diff --git a/docs/latest/_images/tp_menu_other.png b/docs/latest/_images/tp_menu_other.png
new file mode 100644
index 0000000..d0c29b2
--- /dev/null
+++ b/docs/latest/_images/tp_menu_other.png
Binary files differ
diff --git a/docs/latest/_images/tp_menu_services.png b/docs/latest/_images/tp_menu_services.png
new file mode 100644
index 0000000..d887b16
--- /dev/null
+++ b/docs/latest/_images/tp_menu_services.png
Binary files differ
diff --git a/docs/latest/_images/tp_menu_tools.png b/docs/latest/_images/tp_menu_tools.png
new file mode 100644
index 0000000..fd1db4d
--- /dev/null
+++ b/docs/latest/_images/tp_menu_tools.png
Binary files differ
diff --git a/docs/latest/_images/tp_menu_topology.png b/docs/latest/_images/tp_menu_topology.png
new file mode 100644
index 0000000..f69f959
--- /dev/null
+++ b/docs/latest/_images/tp_menu_topology.png
Binary files differ
diff --git a/docs/latest/_images/tp_menu_user_admin.png b/docs/latest/_images/tp_menu_user_admin.png
new file mode 100644
index 0000000..bf76e87
--- /dev/null
+++ b/docs/latest/_images/tp_menu_user_admin.png
Binary files differ
diff --git a/docs/latest/_images/tp_table_ds_requests.png b/docs/latest/_images/tp_table_ds_requests.png
new file mode 100644
index 0000000..ae4ed39
--- /dev/null
+++ b/docs/latest/_images/tp_table_ds_requests.png
Binary files differ
diff --git a/docs/latest/_images/tp_table_ds_requests1.png b/docs/latest/_images/tp_table_ds_requests1.png
new file mode 100644
index 0000000..ae4ed39
--- /dev/null
+++ b/docs/latest/_images/tp_table_ds_requests1.png
Binary files differ
diff --git a/docs/latest/_sources/admin/index.rst.txt b/docs/latest/_sources/admin/index.rst.txt
new file mode 100644
index 0000000..05075cf
--- /dev/null
+++ b/docs/latest/_sources/admin/index.rst.txt
@@ -0,0 +1,52 @@
+..
+..
+.. 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.
+..
+
+Administrator's Guide
+*********************
+
+Traffic Control is distributed in source form for the developer, but also as a binary package. This guide details how to install and configure a Traffic Control CDN using the binary packages, as well as how to perform common operations running a CDN.
+
+When installing a complete CDN from scratch, a sample recommended order is:
+
+#. Traffic Ops
+#. Traffic Vault (Riak)
+#. Traffic Monitor
+#. Apache Traffic Server Mid-Tier Caches
+#. Apache Traffic Server Edge Caches
+#. Traffic Router
+#. Traffic Stats
+#. Traffic Portal
+
+Once everything is installed, you will need to configure the servers to talk to each other. You will also need Origin server(s), which the Mid-Tier Cache(s) get content from. An Origin server is simply an HTTP(S) server which serves the content you wish to cache on the CDN.
+
+.. toctree::
+ :maxdepth: 3
+
+ traffic_ops/installation.rst
+ traffic_ops/default_profiles.rst
+ traffic_ops/migration_from_10_to_20.rst
+ traffic_ops/migration_from_20_to_22.rst
+ traffic_ops/configuration.rst
+ traffic_ops/using.rst
+ traffic_ops/extensions.rst
+ traffic_portal/installation.rst
+ traffic_portal/usingtrafficportal.rst
+ traffic_monitor.rst
+ traffic_monitor_golang.rst
+ traffic_router.rst
+ traffic_stats.rst
+ traffic_server.rst
+ traffic_vault.rst
+ quick_howto/index.rst
diff --git a/docs/latest/_sources/admin/quick_howto/anonymous_blocking.rst.txt b/docs/latest/_sources/admin/quick_howto/anonymous_blocking.rst.txt
new file mode 100644
index 0000000..4ee0ad5
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/anonymous_blocking.rst.txt
@@ -0,0 +1,87 @@
+..
+..
+.. 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.
+..
+
+.. _rl-anonymous_blocking-qht:
+
+**************************************
+Configure Anonymous Blocking
+**************************************
+
+.. Note:: Anonymous Blocking is only supported for HTTP delivery services.
+
+1) Prepare the Anonymous Blocking configuration file
+
+Anonymous Blocking uses a configuration file in JSON format to define blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows::
+
+ {
+
+ "customer": "YourCompany",
+ "version": "1",
+ "date" : "2017-05-23 03:28:25",
+ "name": "Anonymous IP Blocking Policy",
+
+ "anonymousIp": { "blockAnonymousVPN": true,
+ "blockHostingProvider": true,
+ "blockPublicProxy": true,
+ "blockTorExitNode": true},
+
+ "ip4Whitelist": ["192.168.30.0/24", "10.0.2.0/24", "10.1.1.1/32"],
+
+ "ip6Whitelist": ["2001:550:90a::/48", "::1/128"],
+
+ "redirectUrl": "http://youvebeenblocked.com"
+ }
+
+* “anonymousIp” contains the types of IPs which can be checked against the Anonymous IP Database. There are 4 types of IPs which can be checked: VPNs, Hosting Providers, Public Proxies, and Tor Exit Nodes. Each type of IP can be enabled or disabled. If the value is true, IPs which match this type will be blocked when the feature is enabled in the delivery service. If the value is false, IPs which match this type will not be blocked. If an IP matches more than 1 type and any type is enabled, the IP will be blocked.
+
+* “redirectUrl” is the URL that will be returned to the blocked clients. Without a redirectUrl, the clients will receive an HTTP response code 403. With a redirectUrl, the clients will be redirected with an HTTP response code 302.
+
+* “ipWhiteList” is an optional element. It includes a list of CIDR (Classless Inter-Domain Routing) blocks indicating the IPv4 and IPv6 subnets that are allowed by the rule. If this list exists and the value is not empty, client IP will be matched against the CIDR list, and if there is any match, the request will be allowed. If there is no match in the white list, further anonymous blocking logic will continue.
+
+
+2) Add Anonymous Blocking parameters on Traffic Ops
+
+The following three new parameters are required to be added into CRConfig.json:
+
+* "anonymousip.policy.configuration": the HTTP URL of the Anonymous Blocking configuration file. Traffic Router will fetch the file from this URL.
+* "anonymousip.polling.url": the HTTP URL of the Anonymous IP Database. Traffic Router will fetch the file from this URL.
+* "anonymousip.polling.interval": the interval that Traffic Router polls the Anonymous Blocking configuration file and Anonymous IP Database.
+
+.. image:: anonymous_blocking01.png
+ :scale: 100%
+ :align: center
+
+3) Enable Anonmyous Blocking for a delivery service
+
+.. image:: anonymous_blocking02.png
+ :scale: 100%
+ :align: center
+
+4) Make configuration effective
+
+Go to Tools->Snapshot CRConfig, perform “Diff CRConfig” and click "Write CRConfig".
+
+.. image:: regionalgeo03.png
+ :scale: 70%
+ :align: center
+
+5) Traffic Router access log with Anonymous Blocking
+
+Anonymous Blocking extends the field of "rtype" and adds a new field "ANON_BLOCK" in Traffic Router access.log to help to monitor the working of this feature.
+
+If rtype=ANON_BLOCK then the client's IP was found in the Anonymous IP Database and was blocked.
+
+
+
diff --git a/docs/latest/_sources/admin/quick_howto/dnssec.rst.txt b/docs/latest/_sources/admin/quick_howto/dnssec.rst.txt
new file mode 100644
index 0000000..d336057
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/dnssec.rst.txt
@@ -0,0 +1,72 @@
+..
+..
+.. 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.
+..
+
+.. _rl-dnssec-qht:
+
+****************
+Configure DNSSEC
+****************
+
+.. Note:: In order for Traffic Ops to successfully store keys in Traffic Vault, at least one Riak Server needs to be configured in Traffic Ops. See the `Traffic Vault admin page <../traffic_vault.html>`_ for more information.
+
+.. Note:: Currently DNSSEC is only supported for DNS delivery services.
+
+1) Go to Tools->Manage DNSSEC Keys choose a CDN and click Manage DNSSEC Keys
+
+.. image:: dnssec01.png
+ :scale: 100%
+ :align: center
+
+2) Generate keys for a CDN by clicking Generate Keys then entering the following information:
+
+ - Expiration in days for the Zone Signing Key (ZSK)
+ - Expiration in days for the Key Signing Key (KSK)
+ - Effective Date
+
+ Once the required information has been entered click on the 'Generate Keys' button.
+
+ Depending upon the number of Delivery Services in the CDN, generating DNSSEC keys may take serveral seconds.
+
+.. image:: dnssec02.png
+ :scale: 100%
+ :align: center
+
+3) In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN's domain (e.g. If the CDN's domain is 'cdn.kabletown.net' the parent zone is 'kabletown.net').
+
+ If you control your parent zone you can enter this information yourself, otherwise you will need to work with your DNS team to get the DS Record added to the parent zone.
+
+.. image:: dnssec03.png
+ :scale: 70%
+ :align: center
+
+4) Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.
+
+ Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.
+
+ This will add a 'dnssec.enabled = "true"' entry to CRConfig for the chosen CDN.
+
+.. image:: dnssec04.png
+ :scale: 70%
+ :align: center
+
+5) DNSSEC should now be active on your CDN and Traffic Router should be signing responses.
+
+ A dig command with +dnssec added should show you the signed responses.
+
+ ``dig edge.cdn.kabletown.net. +dnssec``
+
+6) When KSK expiration is approaching (default 365 days), it is necessary to manually generate a new KSK for the TLD (Top Level Domain) and add the DS Record to the parent zone. In order to avoid signing errors, it is suggested that an effective date is chosen which allows time for the DS Record to be added to the parent zone before the new KSK becomes active.
+
+ A new KSK can be generated by clicking the 'Regenerate KSK' button on the Manage DNSSEC Keys screen (see screenshot above).
diff --git a/docs/latest/_sources/admin/quick_howto/ds_requests.rst.txt b/docs/latest/_sources/admin/quick_howto/ds_requests.rst.txt
new file mode 100644
index 0000000..997935e
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/ds_requests.rst.txt
@@ -0,0 +1,81 @@
+..
+..
+.. 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.
+..
+
+.. _ds_requests:
+
+Delivery Service Requests
+=========================
+
+When enabled in traffic_portal_properties.json, delivery service requests are created when ALL users attempt to create, update or delete a delivery service.
+This allows users with higher level permissions (ops or admin) to review the changes for completeness and accuracy before deploying the changes.
+In addition, most delivery service changes require cache config updates (aka queue updates) and/or a cdn snapshot. Both of these actions are reserved for users with elevated permissions.
+
+A list of the delivery service requests associated with your tenant can be found here:
+
+``https://traffic-portal.domain.com/#!/delivery-service-requests``
+
+.. image:: ../traffic_portal/images/tp_table_ds_requests.png
+
+Who Can Create a Delivery Service Request and How?
+##################################################
+
+Users with the Portal role (or above) can create delivery service requests by doing one of three things:
+
+1. Creating a new delivery service
+2. Updating an existing delivery service
+3. Deleting an exiting delivery service
+
+By performing one of these actions, a delivery service request will be created for you with a status of draft or submitted. You determine the status of your request. Only change the status of your request to submitted once the request is ready for review and deployment.
+
+Who Can Fulfill a Delivery Service Request and How?
+###################################################
+
+Users with elevated permissions (Operations or above) can fulfill (apply the changes) or reject the delivery service request. In fact, they can do all of the following:
+
+Update the contents of the delivery service request
+***************************************************
+
+Optional. This will update the "Last Edited By" field to indicate who last updated the request.
+
+Assign or unassign the delivery service request
+***********************************************
+
+Optional. Assignment is currently limited to current user. This is optional as fulfillment will auto-assign the request to the user doing the fulfillment.
+
+Reject the delivery service request
+***********************************
+
+Rejecting a delivery service request will set status to ``rejected`` and the request can no longer be modified. This will auto-assign the request to the user doing the rejection.
+
+Fulfill the delivery service request
+************************************
+
+Fulfilling a delivery service request will show the requested changes and, once committed, will apply the desired changes and set status to ``pending``. The request is pending because many types of changes will require cache config updates (aka queue updates) and/or a cdn snapshot. Once queue updates and/or cdn snapshot is complete, the request should be marked ``complete``.
+
+Complete the delivery service request
+*************************************
+
+Only after the delivery service request has been fulfilled and the changes have been applied can a delivery service request be marked as complete. Marking a delivery service as complete is currently a manual step because some changes require cache config updates (aka queue updates) and/or a cdn snapshot.
+Once that is done and the changes have been deployed, the request status should be changed from ``pending`` to ``complete``.
+
+
+Delete the delivery service request
+***********************************
+
+Delivery service requests with a status of draft or submitted can always be deleted entirely if appropriate.
+
+
+
+
diff --git a/docs/latest/_sources/admin/quick_howto/federations.rst.txt b/docs/latest/_sources/admin/quick_howto/federations.rst.txt
new file mode 100644
index 0000000..a57473e
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/federations.rst.txt
@@ -0,0 +1,135 @@
+..
+..
+.. 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.
+..
+
+.. _rl-federations-qht:
+
+*********************
+Configure Federations
+*********************
+
+1) Create a user with a federations role (Misc -> Users -> Add User). This user will have the ability to perform the following actions:
+
+ - Edit the federation
+ - Delete the federation
+ - Add IPV4 resolvers
+ - Add IPV6 resolvers
+
+.. image:: federation01.png
+ :scale: 100%
+ :align: center
+
+2) As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking 'Add Federation Mapping'
+
+3) Choose the Delivery Service for the federation to be mapped to and assign it to the Federation User; click Add.
+
+.. image:: federation02.png
+ :scale: 100%
+ :align: center
+
+4) After the Federation is added, Traffic Ops will display the Federation.
+
+ Changes can be made at this time or the Federation can be deleted. Notice that no resolvers have been added to the fedeation yet. This can only be done by the federation user created in step 1.
+
+ If no further action is necessary, the Close button will close the window and display the list of all Federations.
+
+.. image:: federation03.png
+ :scale: 100%
+ :align: center
+
+
+**The Federation user can now add resolvers to the Federation Mapping in Traffic Ops.**
+
+5) The federation user logs to traffic ops and stores the mojolicious cookie. The mojolicious cookie can be obtained manually using the debug tools on a web browser or via curl.
+
+ Example::
+
+ $ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
+
+ HTTP/1.1 200 OK
+ Date: Wed, 02 Dec 2015 21:12:06 GMT
+ Content-Length: 65
+ Access-Control-Allow-Credentials: true
+ Content-Type: application/json
+ Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0; expires=Thu, 03 Dec 2015 01:12:06 GMT; path=/; HttpOnly
+ Server: Mojolicious (Perl)
+ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+ Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ Connection: keep-alive
+ Access-Control-Allow-Origin: http://localhost:8080
+
+ {"alerts":[{"level":"success","text":"Successfully logged in."}]}
+
+6) The federation user sends a request to Traffic Ops to add IPV4 and/or IPV6 resolvers
+
+
+ Example::
+
+ $ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
+ {"federations": [
+ { "deliveryService": "images-c1",
+ "mappings":
+ { "resolve4": [ "8.8.8.8/32", "8.8.4.4/32" ],
+ "resolve6": ["2001:4860:4860::8888/128", "2001:4860:4860::8844"]
+ }
+ }
+ ]
+ }'
+
+ HTTP/1.1 200 OK
+ Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1OTQyLCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---b42be0749415cefd1d14e1a91bb214845b4de556; expires=Thu, 03 Dec 2015 01:25:42 GMT; path=/; HttpOnly
+ Server: Mojolicious (Perl)
+ Date: Wed, 02 Dec 2015 21:25:42 GMT
+ Content-Length: 74
+ Access-Control-Allow-Credentials: true
+ Content-Type: application/json
+ Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ Access-Control-Allow-Origin: http://localhost:8080
+ Connection: keep-alive
+ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+
+ {"response":"federation_user1 successfully created federation resolvers."}
+
+7) The resolvers added by the federation user will now visible in Traffic Ops.
+
+.. image:: federation04.png
+ :scale: 100%
+ :align: center
+
+8) Any requests made from a client that resolves to one of the federation resolvers will now be given a CNAME from Traffic Router.
+
+ Example::
+
+ $ dig @tr.kabletown.net foo.images-c1.kabletown.net
+
+ ; <<>> DiG 9.7.3-RedHat-9.7.3-2.el6 <<>> @tr.kabletown.net foo.images-c1.kabletown.net
+ ; (1 server found)
+ ;; global options: +cmd
+ ;; Got answer:
+ ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 45110
+ ;; flags: qr rd; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0
+ ;; WARNING: recursion requested but not available
+
+ ;; QUESTION SECTION:
+ ;foo.images-c1.kabletown.net. IN A
+
+ ;; ANSWER SECTION:
+ foo.images-c1.kabletown.net. 30 IN CNAME img.mega-cdn.net.
+
+ ;; Query time: 9 msec
+ ;; SERVER: 10.10.10.10#53(10.10.10.10)
+ ;; WHEN: Wed Dec 2 22:05:26 2015
+ ;; MSG SIZE rcvd: 84
\ No newline at end of file
diff --git a/docs/latest/_sources/admin/quick_howto/index.rst.txt b/docs/latest/_sources/admin/quick_howto/index.rst.txt
new file mode 100644
index 0000000..4c6b6dc
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/index.rst.txt
@@ -0,0 +1,43 @@
+..
+..
+.. 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.
+..
+
+Quick How To Guides
+*******************
+
+Traffic Control is a complicated system, and documenting it is not trivial. Sometimes a picture says more than a thousand words, so here are some screen shot based tutorials on how to use some of the more involved features.
+
+Traffic Ops
+===========
+
+.. toctree::
+
+ multi_site.rst
+ dnssec.rst
+ federations.rst
+ regionalgeo.rst
+ anonymous_blocking.rst
+ steering.rst
+
+Traffic Portal
+==============
+
+.. toctree::
+
+ ds_requests.rst
+
+
+
+
+
diff --git a/docs/latest/_sources/admin/quick_howto/multi_site.rst.txt b/docs/latest/_sources/admin/quick_howto/multi_site.rst.txt
new file mode 100644
index 0000000..6e0f0dd
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/multi_site.rst.txt
@@ -0,0 +1,105 @@
+..
+..
+.. 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.
+..
+
+.. _rl-multi-site-origin-qht:
+
+***************************
+Configure Multi Site Origin
+***************************
+
+
+1) Create cachegroups for the origin locations, and assign the appropriate parent-child relationship between the mid and org cachegroups (click the image to see full size). Each mid cachegroup can be assigned a primary and secondary origin parent cachegroup. When the mid cache parent configuration is generated, origins in the primary cachegroups will be listed first, followed by origins in the secondary cachegroup. Origin servers assigned to the delivery service that are assigned to neither the primary nor secondary cachegroups will be listed last.
+
+.. image:: C5C4CD22-949A-48FD-8976-C673083E2177.png
+ :scale: 100%
+ :align: center
+
+2) Create a profile to assign to each of the origins:
+
+.. image:: 19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png
+ :scale: 100%
+ :align: center
+
+3) Create server entries for the origination vips:
+
+.. image:: D28614AA-9758-45ED-9EFD-3A284FC4218E.png
+ :scale: 100%
+ :align: center
+
+4) Check the multi-site check box in the delivery service screen:
+
+.. image:: mso-enable.png
+ :scale: 100%
+ :align: center
+
+5) Assign the org servers to the delivery service that will have the multi site feature. Org servers assigned to a delivery service with multi-site checked will be assigned to be the origin servers for this DS.
+
+.. image:: 066CEF4F-C1A3-4A89-8B52-4F72B0531367.png
+ :scale: 100%
+ :align: center
+
+.. Note:: “Origin Server Base URL” uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that “Origin Server Base URL” (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The exceptions are:
+
+ 1. If there are multiple CDNs created on the same Traffic Ops, delivery services across different CDNs may have the same OFQDN configured.
+ 2. If several delivery services in the same CDN have the same MSO algorithm configured, they may share the same OFQDN.
+ 3. If delivery services are assigned with different MID cache groups respectively, they can share the same OFQDN.
+ 4. This OFQDN must be valid - ATS will perform a DNS lookup on this FQDN even if IPs, not DNS, are used in the parent.config.
+ 5. The OFQDN entered as the "Origin Server Base URL" will be sent to the origins as a host header. All origins must be configured to respond to this host.
+
+
+6) For ATS 5.x, configure the mid hdr_rewrite on the delivery service, example: ::
+
+ cond %{REMAP_PSEUDO_HOOK} __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_response_codes "400,404,412" __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_response_codes "502,503" __RETURN__ set-config proxy.config.http.connect_attempts_timeout 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries_dead_server 1 __RETURN__ set-config proxy.config.http.transaction_active_timeout_in 5 [L] __RETURN__
+
+7) Create a delivery service profile. This must be done to set the MSO algorithm. Also, as of ATS 6.x, multi-site options must be set as parameters within the parent.config. Header rewrite parameters will be ignored. See `ATS parent.config <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/files/parent.config.en.html>`_ for more details. These parameters are now handled by the creation of a delivery service profile.
+
+ a) Create a profile of the type DS_PROFILE for the delivery service in question.
+
+ .. image:: ds-profile.png
+ :scale: 50%
+ :align: center
+
+ b) Click "Show profile parameters" to bring up the parameters screen for the profile. Create parameters for the following:
+
+ +----------------------------------------+------------------+--------------------------+-------------------------+
+ | Parameter Name | Config File Name | Value | ATS parent.config value |
+ +========================================+==================+==========================+=========================+
+ | mso.algorithm | parent.config | true, false, strict, | round_robin |
+ | | | consistent_hash | |
+ +----------------------------------------+------------------+--------------------------+-------------------------+
+ | mso.parent_retry | parent.config | simple_retry, both, | parent_retry |
+ | | | unavailable_server_retry | |
+ +----------------------------------------+------------------+--------------------------+-------------------------+
+ | mso.unavailable_server_retry_responses | parent.config | list of server response | defaults to the value |
+ | | | codes, eg "500,502,503" | in records.config |
+ | | | | when unused. |
+ +----------------------------------------+------------------+--------------------------+-------------------------+
+ | mso.max_simple_retries | parent.config | Nubmer of retries made | defaults to the value |
+ | | | after a 4xx error | in records.config |
+ | | | | when unused. |
+ +----------------------------------------+------------------+--------------------------+-------------------------+
+ | mso.max_unavailable_server_retries | parent.config | Nubmer of retries made | defaults to the value |
+ | | | after a 5xx error | in records.config |
+ | | | | when unused. |
+ +----------------------------------------+------------------+--------------------------+-------------------------+
+
+
+ .. image:: ds_profile_parameters.png
+ :scale: 100%
+ :align: center
+
+ c) In the delivery service page, select the newly created DS_PROFILE and save the delivery service.
+
+8) Turn on parent_proxy_routing in the MID profile.
diff --git a/docs/latest/_sources/admin/quick_howto/regionalgeo.rst.txt b/docs/latest/_sources/admin/quick_howto/regionalgeo.rst.txt
new file mode 100644
index 0000000..36fd508
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/regionalgeo.rst.txt
@@ -0,0 +1,109 @@
+..
+..
+.. 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.
+..
+
+.. _rl-regionalgeo-qht:
+
+**************************************
+Configure Regional Geo-blocking (RGB)
+**************************************
+
+.. Note:: RGB is only supported for HTTP delivery services.
+
+1) Prepare RGB configuration file
+
+RGB uses a configuration file in JSON format to define regional geo-blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows::
+
+ {
+ "deliveryServices":
+ [
+ {
+ "deliveryServiceId": "hls-live",
+ "urlRegex": ".*live4\\.m3u8",
+ "geoLocation": {"includePostalCode":["N0H", "L9V", "L9W"]},
+ "redirectUrl": "http://third-party.com/blacked_out.html"
+ },
+ {
+ "deliveryServiceId": "hls-live",
+ "urlRegex": ".*live5\\.m3u8",
+ "ipWhiteList": [185.68.71.9/22","142.232.0.79/24"],
+ "geoLocation": {"excludePostalCode":["N0H", "L9V"]},
+ "redirectUrl": "/live5_low_bitrate.m3u8"
+ }
+ ]
+ }
+
+* The value of "deliveryServiceId" shall be equal to the “XML ID” field of the intended delivery service defined on Traffic Ops.
+
+* “urlRegex” is to match request URLs. The URLs matching the regex are applicable to the rule.
+
+* “geoLocation” currently supports “includePostalCode” and “excludePostalCode” attribute. When “includePostalCode” attribute is used, only the clients whose FSAs are in the “includePostalCode” list are able to view the content represented by “urlRegex”. When “excludePostalCode” is used, any client whose FSA are not in the “excludePostalCode” list are allowed to view the content. “includePostalCode” and “excludePostalCode” are mutually exclusive in one rule. (FSA: Forward Sortation Area, first three postal characters of Canadian postal codes)
+
+* “redirectUrl” is the URL that will be responded to the blocked clients. Without a domain name in the URL, the URL will still be served in the same delivery service. Thus Traffic Router will redirect the client to a chosen cache server assigned to the delivery service. If the URL includes a domain name, Traffic Router simply redirects the client to the defined URL. In the later case, the redirect URL must not match the “urlRegex” part to avoid HTTP 302 loop on Traffic Router.
+
+* “ipWhiteList” is an optional element. It includes a list of CIDR (Classless Inter-Domain Routing) blocks indicating the IPv4 subnets that are allowed by the rule. If this list exists and the value is not empty, client IP will be matched against the CIDR list, and if there is any match, the request will be allowed and no postal code matching logic is needed. If there is no match in the white list, postal code matching logic will be processed further.
+
+
+2) Add RGB parameters on Traffic Ops
+
+The two new parameters in following table are required to be added into CRConfig.json:
+
+* "regional_geoblocking.polling.url": the HTTP URL of RGB configuration file. Traffic Router will fetch the file from this URL.
+* "regional_geoblocking.polling.interval": the interval that Traffic Router polls the RGB configuration file.
+
+.. image:: regionalgeo01.png
+ :scale: 100%
+ :align: center
+
+3) Enable RGB for a delivery service
+
+.. image:: regionalgeo02.png
+ :scale: 100%
+ :align: center
+
+4) Make configuration effective
+
+Go to Tools->Snapshot CRConfig, perform “Diff CRConfig” and click "Write CRConfig".
+
+.. image:: regionalgeo03.png
+ :scale: 70%
+ :align: center
+
+5) Traffic Router access log with RGB
+
+RGB extends the field of "rtype" and adds a new field "rgb" in Traffic Router access.log to help to monitor the working of this feature.
+
+For "rtype", RGALT indicates that a request is redirected to an alternate URL by RGB; RGDENY indicates that a request is denied by RGB because there is no matching rule in JSON for this request.
+
+For "rgb", when RGB is enabled, it will be non-empty with following format::
+
+ {FSA}:{allowed/disallowed}:{include/exclude postal}:{fallback config/current config}:{allowed by whitelist/otherwise}
+
+
+* {FSA}: It is the client’s FSA part of its postal code, which is retrieved from geo-location database. If FSA is empty, dash (“-“) is filled in.
+* {allowed/disallowed}: This flag shows if a request is allowed or disallowed by RGB (1 for yes, and 0 for no).
+* {include/exclude postal}: It shows that when a rule in JSON is matched for a request, it is an include or exclude list of postal codes (i.e. FSAs). “I” for include, and “X” for exclude. If no rule matches, dash (“-“) is filled in.
+* {fallback config/current config}: when TR fails to parse an RGB JSON, TR will handle requests with latest valid JSON configuration, but will set {fallback config} flag to 1. If the new JSON is valid, then the flag is set to 0.
+* {allowed by whitelist/otherwise}: If a request is allowed by whitelist, this flag is set to 1; for all other cases, it is 0.
+
+
+Example::
+
+ 1446442214.685 qtype=HTTP chi=129.100.254.79 url="http://foo.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="-" rdtl=- rerr="-" rgb="N6G:1:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/live5.m3u8 rh="-"
+
+ 1446442219.181 qtype=HTTP chi=184.68.71.9 url="http://foo.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGALT rloc="-" rdtl=- rerr="-" rgb="-:0:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/low_bitrate.m3u8 rh="-"
+
+ 1446445521.677 qtype=HTTP chi=24.114.29.79 url="http://foo.geo2.cdn.com/live51.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGDENY rloc="-" rdtl=- rerr="-" rgb="L4S:0:-:0:0" pssc=520 ttms=3 rurl="-" rh="-"
+
+
diff --git a/docs/latest/_sources/admin/quick_howto/steering.rst.txt b/docs/latest/_sources/admin/quick_howto/steering.rst.txt
new file mode 100644
index 0000000..96ae5bd
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/steering.rst.txt
@@ -0,0 +1,111 @@
+..
+..
+.. 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.
+..
+
+.. _rl-steering-qht:
+
+***********************************
+Configure Delivery Service Steering
+***********************************
+
+1) Create two target delivery services in Traffic Ops. They must both be HTTP delivery services that are part of the same CDN.
+
+.. image:: steering01.png
+ :scale: 100%
+ :align: center
+
+2) Create a delivery service with type STEERING in Traffic Ops.
+
+.. image:: steering02.png
+ :scale: 100%
+ :align: center
+
+3) Click the 'Manage Steering Assignments' button on the delivery service screen to assign targets.
+
+.. image:: steering03.png
+ :scale: 100%
+ :align: center
+
+4) Create a user with the role of Steering.
+
+.. image:: steering04.png
+ :scale: 100%
+ :align: center
+
+5) As the steering user, assign weights or orders to target delivery services. Assignments must either have a value for weight or order, but not both. The value of weight must be a positive integer, while the value of order can be any integer. This will require logging in to Traffic Ops first via ``http://to.kabletown.net/api/1.2/user/login`` and storing the mojolicious cookie.
+
+ Sample cURL: ``curl -H "Cookie: mojolicious=xxxyyy" -XPUT "https://to.kabletown.net/internal/api/1.2/steering/steering-ds" -d @/tmp/steering.json``
+
+ Sample JSON body:
+
+::
+
+ {
+ "targets": [
+ {
+ "weight": "1000",
+ "deliveryService": "target-deliveryservice-1"
+ },
+ {
+ "weight": "9000",
+ "deliveryService": "target-deliveryservice-2"
+ }
+ {
+ "order": -1,
+ "deliveryService": "target-deliveryservice-3"
+ }
+ {
+ "order": 3,
+ "deliveryService": "target-deliveryservice-4"
+ }
+ ]
+ }
+
+6) If desired, the steering user can create filters for the target delivery services.
+
+ Sample cURL: ``curl -H "Cookie: mojolicious=xxxyyy" -XPUT "https://to.kabletown.net/internal/api/1.2/steering/steering-ds" -d @/tmp/steering.json``
+
+ Sample JSON body:
+
+::
+
+ {
+ "filters": [
+ {
+ "pattern": ".*\\gototarget1\\..*",
+ "deliveryService": "target-deliveryservice-1"
+ }
+ ],
+ "targets": [
+ {
+ "weight": "1000",
+ "deliveryService": "target-deliveryservice-1"
+ },
+ {
+ "weight": "9000",
+ "deliveryService": "target-deliveryservice-2"
+ }
+ {
+ "order": -1,
+ "deliveryService": "target-deliveryservice-3"
+ }
+ {
+ "order": 3,
+ "deliveryService": "target-deliveryservice-4"
+ }
+ ]
+ }
+
+7) Any requests to Traffic Router for the steering delivery service should now be routed to target delivery services based on configured weight or order. Example: ``curl -Lvs http://foo.steering-ds.cdn.kabletown.net/bar``
+
diff --git a/docs/latest/_sources/admin/traffic_monitor.rst.txt b/docs/latest/_sources/admin/traffic_monitor.rst.txt
new file mode 100644
index 0000000..859000a
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_monitor.rst.txt
@@ -0,0 +1,177 @@
+..
+..
+.. 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.
+..
+
+***************************************
+Traffic Monitor Administration (Legacy)
+***************************************
+
+.. _rl-tm-java:
+
+* These instructions are for the legacy Java Traffic Monitor, for the new Golang version, see :ref:`here <rl-tm-golang>`.
+
+Installing Traffic Monitor
+==========================
+The following are requirements to ensure an accurate set up:
+
+* CentOS 6
+* 4 vCPUs
+* 8GB RAM
+* Successful install of Traffic Ops
+* Tomcat
+* Administrative access to the Traffic Ops
+* Physical address of the site
+* perl-JSON
+* perl-WWW-Curl
+
+#. Add the Traffic Monitor server into Traffic Ops using 'Servers' -> 'Add Server'. Set the 'Type' field to 'RASCAL'.
+
+#. Make sure the FQDN of the Traffic Monitor is resolvable in DNS.
+
+#. Get the Traffic Monitor RPM.
+
+ Sample command: ::
+
+ wget http://traffic-control-cdn.net/downloads/1.7.0/RELEASE-1.7.0/traffic_monitor-1.7.0-3908.5b77f60f.el6.x86_64.rpm
+
+#. Install Traffic Monitor and Perl modules: ::
+
+ sudo yum -y install traffic_monitor-*.rpm perl-JSON perl-WWW-Curl
+
+#. Take the config from Traffic Ops: ::
+
+ sudo /opt/traffic_monitor/bin/traffic_monitor_config.pl https://<traffic-ops-URL> <traffic-ops-user>:<traffic-ops-password> prompt
+
+ Sample session: ::
+
+ traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:kl0tevax prompt
+ DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net
+ DEBUG: traffic_ops login: admin:kl0tevax
+ DEBUG: Config write mode: prompt
+ DEBUG: Found profile from traffic_ops: RASCAL_CDN
+ DEBUG: Found CDN name from traffic_ops: kabletown_cdn
+ DEBUG: Found location for rascal-config.txt from traffic_ops: /opt/traffic_monitor/conf
+ WARN: Param not in traffic_ops: allow.config.edit description: Allow the running configuration to be edited through the UI Using default value of: false
+ WARN: Param not in traffic_ops: default.accessControlAllowOrigin description: The value for the header: Access-Control-Allow-Origin for published jsons... should be narrowed down to TMs Using default value of: *
+ WARN: Param not in traffic_ops: default.connection.timeout description: Default connection time for all queries (cache, peers, TM) Using default value of: 2000
+ WARN: Param not in traffic_ops: hack.forceSystemExit description: Call System.exit on shutdown Using default value of: false
+ WARN: Param not in traffic_ops: hack.peerOptimistic description: The assumption of a caches availability when unknown by peers Using default value of: true
+ WARN: Param not in traffic_ops: hack.publishDsStates description: If true, the delivery service states will be included in the CrStates.json Using default value of: true
+ WARN: Param not in traffic_ops: health.ds.interval description: The polling frequency for calculating the deliveryService states Using default value of: 1000
+ WARN: Param not in traffic_ops: health.ds.leniency description: The amount of time before the deliveryService disregards the last update from a non-responsive cache Using default value of: 30000
+ WARN: Param not in traffic_ops: health.event-count description: The number of historical events that will be kept Using default value of: 200
+ WARN: Param not in traffic_ops: health.polling.interval description: The polling frequency for getting the states from caches Using default value of: 5000
+ WARN: Param not in traffic_ops: health.startupMinCycles description: The number of query cycles that must be completed before this Traffic Monitor will start reporting Using default value of: 2
+ WARN: Param not in traffic_ops: health.timepad description: A delay between each separate cache query Using default value of: 10
+ WARN: Param not in traffic_ops: peers.polling.interval description: Polling frequency for getting states from peer monitors Using default value of: 5000
+ WARN: Param not in traffic_ops: peers.polling.url description: The url for current, unfiltered states from peer monitors Using default value of: http://${hostname}/publish/CrStates?raw
+ WARN: Param not in traffic_ops: peers.threadPool description: The number of threads given to the pool for querying peers Using default value of: 1
+ WARN: Param not in traffic_ops: tm.auth.url description: The url for the authentication form Using default value of: https://${tmHostname}/login
+ WARN: Param not in traffic_ops: tm.crConfig.json.polling.url description: Url for the cr-config (json) Using default value of: https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json
+ WARN: Param not in traffic_ops: tm.healthParams.polling.url description: The url for the heath params (json) Using default value of: https://${tmHostname}/health/${cdnName}
+ WARN: Param not in traffic_ops: tm.polling.interval description: The polling frequency for getting updates from TM Using default value of: 10000
+ DEBUG: allow.config.edit needed in config, but does not exist in config on disk.
+ DEBUG: cdnName value on disk () does not match value needed in config (kabletown_cdn).
+ DEBUG: default.accessControlAllowOrigin needed in config, but does not exist in config on disk.
+ DEBUG: default.connection.timeout needed in config, but does not exist in config on disk.
+ DEBUG: hack.forceSystemExit needed in config, but does not exist in config on disk.
+ DEBUG: hack.peerOptimistic needed in config, but does not exist in config on disk.
+ DEBUG: hack.publishDsStates needed in config, but does not exist in config on disk.
+ DEBUG: health.ds.interval needed in config, but does not exist in config on disk.
+ DEBUG: health.ds.leniency needed in config, but does not exist in config on disk.
+ DEBUG: health.startupMinCycles needed in config, but does not exist in config on disk.
+ DEBUG: health.timepad value on disk (20) does not match value needed in config (10).
+ DEBUG: peers.polling.interval needed in config, but does not exist in config on disk.
+ DEBUG: peers.threadPool needed in config, but does not exist in config on disk.
+ DEBUG: tm.auth.password value on disk () does not match value needed in config (kl0tevax).
+ DEBUG: tm.auth.username value on disk () does not match value needed in config (admin).
+ DEBUG: tm.hostname value on disk () does not match value needed in config (traffic-ops.cdn.kabletown.net).
+ DEBUG: Proposed traffic_monitor_config:
+ {
+ "traffic_monitor_config":{
+ "default.accessControlAllowOrigin":"*",
+ "health.startupMinCycles":"2",
+ "tm.auth.password":"kl0tevax",
+ "tm.auth.url":"https://${tmHostname}/login",
+ "tm.healthParams.polling.url":"https://${tmHostname}/health/${cdnName}",
+ "allow.config.edit":"false",
+ "tm.crConfig.json.polling.url":"https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json",
+ "tm.auth.username":"admin",
+ "peers.polling.url":"http://${hostname}/publish/CrStates?raw",
+ "health.timepad":"10",
+ "hack.publishDsStates":"true",
+ "default.connection.timeout":"2000",
+ "health.ds.interval":"1000",
+ "peers.polling.interval":"5000",
+ "hack.forceSystemExit":"false",
+ "health.ds.leniency":"30000",
+ "cdnName":"kabletown_cdn",
+ "peers.threadPool":"1",
+ "tm.polling.interval":"10000",
+ "health.polling.interval":"5000",
+ "health.event-count":"200",
+ "hack.peerOptimistic":"true",
+ "tm.hostname":"traffic-ops.cdn.kabletown.net"
+ }
+ }
+ ----------------------------------------------
+ ----OK to write this config to disk? (Y/n) [n]y
+ ----------------------------------------------
+ ----------------------------------------------
+ ----OK to write this config to disk? (Y/n) [n]Y
+ ----------------------------------------------
+ DEBUG: Writing /opt/traffic_monitor/conf/traffic_monitor_config.js
+ traffic_mon #
+
+#. Update the 'allow_ip' and 'allow_ip6' parameters in the profiles of all caches defined in traffic ops, both edge and mid,
+ with the address of the traffic monitor being installed, so that the traffic servers will allow this Traffic Monitor
+ to access the astats plugin.
+ For details see :ref:`rl-param-prof` in the *Configuring Traffic Ops* section.
+
+#. Start Tomcat: ``sudo service tomcat start`` ::
+
+ Using CATALINA_BASE: /opt/tomcat
+ Using CATALINA_HOME: /opt/tomcat
+ Using CATALINA_TMPDIR: /opt/tomcat/temp
+ Using JRE_HOME: /usr
+ Using CLASSPATH:/opt/tomcat/bin/bootstrap.jar
+ Using CATALINA_PID:/var/run/tomcat/tomcat.pid
+ Starting tomcat [ OK ]
+
+#. Configure tomcat to start automatically: ``sudo chkconfig tomcat on``
+
+#. Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host:
+
+ * The 'Cache States' tab should display all Mid and Edge caches configured in Traffic Ops.
+ * The 'DeliveryService States' tab should display all delivery services configured in Traffic Ops.
+
+#. In Traffic Ops servers table, click 'Edit' for this server, then click 'Online'.
+
+
+Configuring Traffic Monitor
+===========================
+
+Configuration Overview
+----------------------
+Traffic Monitor is configured using its JSON configuration file, ``/opt/traffic_monitor/conf/traffic_monitor_config.js``.
+This file is created by ``traffic_monitor_config.pl`` script, and among other things, it contains the Traffic Ops URL and the user:password
+specified during the invocation of that script.
+
+When started, Traffic Monitor uses this basic configuration to downloads its configuration from Traffic Ops, and begins polling caches.
+Once a configurable number of polling cycles completes, health protocol state is available via RESTful JSON endpoints.
+
+
+Troubleshooting and log files
+=============================
+Traffic Monitor log files are in ``/opt/traffic_monitor/var/log/``, and tomcat log files are in ``/opt/tomcat/logs/``.
diff --git a/docs/latest/_sources/admin/traffic_monitor_golang.rst.txt b/docs/latest/_sources/admin/traffic_monitor_golang.rst.txt
new file mode 100644
index 0000000..649cf78
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_monitor_golang.rst.txt
@@ -0,0 +1,65 @@
+..
+..
+.. 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.
+..
+
+******************************
+Traffic Monitor Administration
+******************************
+
+.. _rl-tm-golang:
+
+* These instructions are for the Golang Traffic Monitor, for the legacy Java version, see :ref:`here <rl-tm-java>`.
+
+Installing Traffic Monitor
+==========================
+
+The following are requirements to ensure an accurate set up:
+
+* CentOS 6+
+* 8 vCPUs
+* 16GB RAM
+* Successful install of Traffic Ops
+* Administrative access to the Traffic Ops
+* Physical address of the site
+
+1. Enter the Traffic Monitor server into Traffic Ops
+2. Make sure the FQDN of the Traffic Monitor is resolvable in DNS.
+3. Install Traffic Monitor: ``sudo yum -y install traffic_monitor``
+4. Configure Traffic Monitor. See :ref:`here <rl-tm-configure>`
+5. Start the service: ``sudo service traffic_monitor start`` ::
+
+ Starting traffic_monitor:
+
+6. Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host.
+
+Configuring Traffic Monitor
+===========================
+
+Configuration Overview
+----------------------
+
+.. _rl-tm-configure:
+
+Traffic Monitor is configured via two JSON configuration files, ``traffic_ops.cfg`` and ``traffic_monitor.cfg``, by default located in the ``conf`` directory in the install location.
+
+The ``traffic_ops.cfg`` config contains Traffic Ops connection information. Specify the URL, username, and password for the instance of Traffic Ops for which this Traffic Monitor is a member.
+
+The ``traffic_monitor.cfg`` config contains log file locations, as well as detailed application configuration variables, such as processing flush times and initial poll intervals.
+
+Once started with the correct configuration, Traffic Monitor downloads its configuration from Traffic Ops and begins polling caches. Once every cache has been polled, health protocol state is available via RESTful JSON endpoints.
+
+
+Troubleshooting and log files
+=============================
+Traffic Monitor log files are in ``/opt/traffic_monitor/var/log/``.
diff --git a/docs/latest/_sources/admin/traffic_ops/configuration.rst.txt b/docs/latest/_sources/admin/traffic_ops/configuration.rst.txt
new file mode 100644
index 0000000..c63a5ec
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops/configuration.rst.txt
@@ -0,0 +1,322 @@
+..
+..
+.. 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.
+..
+
+Traffic Ops - Configuring
+%%%%%%%%%%%%%%%%%%%%%%%%%
+
+Follow the steps below to configure the newly installed Traffic Ops Instance.
+
+Installing the SSL Cert
+=======================
+By default, Traffic Ops runs as an SSL web server, and a certificate needs to be installed.
+
+Self-signed Certificate (Development)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Example Procedure::
+
+ $ openssl genrsa -des3 -passout pass:x -out localhost.pass.key 2048
+ Generating RSA private key, 2048 bit long modulus
+ ...
+ $ openssl rsa -passin pass:x -in localhost.pass.key -out localhost.key
+ writing RSA key
+ $ rm localhost.pass.key
+
+ $ openssl req -new -key localhost.key -out localhost.csr
+ You are about to be asked to enter information that will be incorporated
+ into your certificate request.
+ What you are about to enter is what is called a Distinguished Name or a DN.
+ There are quite a few fields but you can leave some blank
+ For some fields there will be a default value,
+ If you enter '.', the field will be left blank.
+ -----
+ Country Name (2 letter code) [XX]:US<enter>
+ State or Province Name (full name) []:CO<enter>
+ Locality Name (eg, city) [Default City]:Denver<enter>
+ Organization Name (eg, company) [Default Company Ltd]: <enter>
+ Organizational Unit Name (eg, section) []: <enter>
+ Common Name (eg, your name or your server's hostname) []: <enter>
+ Email Address []: <enter>
+
+ Please enter the following 'extra' attributes
+ to be sent with your certificate request
+ A challenge password []: pass<enter>
+ An optional company name []: <enter>
+ $ openssl x509 -req -sha256 -days 365 -in localhost.csr -signkey localhost.key -out localhost.crt
+ Signature ok
+ subject=/C=US/ST=CO/L=Denver/O=Default Company Ltd
+ Getting Private key
+ $ sudo cp localhost.crt /etc/pki/tls/certs
+ $ sudo cp localhost.key /etc/pki/tls/private
+ $ sudo chown trafops:trafops /etc/pki/tls/certs/localhost.crt
+ $ sudo chown trafops:trafops /etc/pki/tls/private/localhost.key
+
+Certificate from Certificate Authority (Production)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. Note:: You will need to know the appropriate answers when generating the certificate request file `trafficopss.csr` below.
+
+Example Procedure::
+
+ $ openssl genrsa -des3 -passout pass:x -out trafficops.pass.key 2048
+ Generating RSA private key, 2048 bit long modulus
+ ...
+ $ openssl rsa -passin pass:x -in trafficops.pass.key -out trafficops.key
+ writing RSA key
+ $ rm localhost.pass.key
+
+ Generate the Certificate Signing Request (CSR) file needed for Certificate Authority (CA) request.
+
+ $ openssl req -new -key trafficops.key -out trafficops.csr
+ You are about to be asked to enter information that will be incorporated
+ into your certificate request.
+ What you are about to enter is what is called a Distinguished Name or a DN.
+ There are quite a few fields but you can leave some blank
+ For some fields there will be a default value,
+ If you enter '.', the field will be left blank.
+ -----
+ Country Name (2 letter code) [XX]: <enter country code>
+ State or Province Name (full name) []: <enter state or province>
+ Locality Name (eg, city) [Default City]: <enter locality name>
+ Organization Name (eg, company) [Default Company Ltd]: <enter organization name>
+ Organizational Unit Name (eg, section) []: <enter organizational unit name>
+ Common Name (eg, your name or your server's hostname) []: <enter server's hostname name>
+ Email Address []: <enter e-mail address>
+
+ Please enter the following 'extra' attributes
+ to be sent with your certificate request
+ A challenge password []: <enter challenge password>
+ An optional company name []: <enter>
+ $ sudo cp trafficops.key /etc/pki/tls/private
+ $ sudo chown trafops:trafops /etc/pki/tls/private/trafficops.key
+
+ You must then take the output file trafficops.csr and submit a request to your Certificate Authority (CA).
+ Once you get approved and receive your trafficops.crt file:
+
+ $ sudo cp trafficops.crt /etc/pki/tls/certs
+ $ sudo chown trafops:trafops /etc/pki/tls/certs/trafficops.crt
+
+ If necessary, install the CA certificates .pem and .crt in /etc/pki/tls/certs.
+
+ You will need to update the file /opt/traffic_ops/app/conf/cdn.conf with the following changes:
+ ...
+ e.g. given trafficops.crt and trafficops.key
+ 'hypnotoad' => ...
+ 'listen' => 'https://[::]:443?cert=/etc/pki/tls/certs/trafficops.crt&key=/etc/pki/tls/private/trafficops.key&ca=/etc/pki/tls/certs/localhost.ca&verify=0x00&ciphers=AES128-GCM-SHA256:HIGH:!RC4:!MD5:!aNULL:!EDH:!ED'
+ ...
+
+
+Content Delivery Networks
+=========================
+
+.. _rl-param-prof:
+
+Profile Parameters
+======================
+Many of the settings for the different servers in a Traffic Control CDN are controlled by parameters in the parameter view of Traffic Ops. Parameters are grouped in profiles and profiles are assigned to a server or a deliveryservice. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings. To make life easier, Traffic Ops allows for duplication, comparison, import and export of Profiles. Traffic Ops also has a "Global profile" - the parameters in this profile are going to be applied to all servers in the Traffic Ops instance, or apply to Traffic Ops themselves. These parameters are:
+
+
+.. index::
+ Global Profile
+
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Config file | Value |
++==========================+===============+=======================================================================================================================================+
+| tm.url | global | The URL where this Traffic Ops instance is being served from. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.rev_proxy.url | global | Not required. The URL where the Traffic Ops Config file cache instance is being served from. Requires Traffic Ops ORT 2.1 and above. |
+| | | When configured, ORT will request configuration files via this fqdn, which should be setup as a reverse proxy to the Traffic Ops host |
+| | | or hosts. Suggested cache lifetime for these files is ~3 minutes or less. This setting allows for greater scaleability of a CDN |
+| | | maintained by Traffic Ops by caching configuration files of profile and cdn scope. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.toolname | global | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.infourl | global | This is the "for more information go here" URL, which is visible in the About page. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.logourl | global | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.instance_name | global | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.traffic_mon_fwd_proxy | global | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. |
+| | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
+| | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to |
+| | | set this parameter on a production system. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| geolocation.polling.url | CRConfig.json | The location to get the GeoLiteCity database from. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| geolocation6.polling.url | CRConfig.json | The location to get the IPv6 GeoLiteCity database from. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| maxmind.default.override | CRConfig.json | The destination geo coordinates to use for client location when maxmind returns a default location that matches the country code. |
+| | | This parameter can be specified multiple times with different values to support default overrides for multiple countries. |
+| | | Format: <CountryCode>;<Lat>,<Long> Ex: US;37.751,-97.822 |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+
+These parameters should be set to reflect the local environment.
+
+
+After running the postinstall script, Traffic Ops has the following profiles pre-loaded:
+
++----------+-------------------------------------------------------------------------------------------------+
+| Name | Description |
++==========+=================================================================================================+
+| EDGE1 | The profile to be applied to the latest supported version of ATS, when running as an EDGE cache |
++----------+-------------------------------------------------------------------------------------------------+
+| TR1 | The profile to be applied to the latest version of Traffic Router |
++----------+-------------------------------------------------------------------------------------------------+
+| TM1 | The profile to be applied to the latest version of Traffic Monitor |
++----------+-------------------------------------------------------------------------------------------------+
+| MID1 | The profile to be applied to the latest supported version of ATS, when running as an MID cache |
++----------+-------------------------------------------------------------------------------------------------+
+| RIAK_ALL | Riak profile for all CDNs to be applied to the Traffic Vault servers |
++----------+-------------------------------------------------------------------------------------------------+
+
+.. Note:: The Traffic Server profiles contain some information that is specific to the hardware being used (most notably the disk configuration), so some parameters will have to be changed to reflect your configuration. Future releases of Traffic Control will separate the hardware and software profiles so it is easier to "mix-and-match" different hardware configurations.
+
+Below is a list of cache parameters that are likely to need changes from the default profiles shipped with Traffic Ops:
+
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| Name | Config file | Description |
++==========================+===================+=========================================================================================================================+
+| allow_ip | astats.config | This is a comma separated list of IPv4 CIDR blocks that will have access to the astats statistics on the caches. |
+| | | The Traffic Monitor IP addresses have to be included in this, if they are using IPv4 to monitor the caches. |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| allow_ip6 | astats.config | This is a comma separated list of IPv6 CIDR blocks that will have access to the astats statistics on the caches. |
+| | | The Traffic Monitor IP addresses have to be included in this, if they are using IPv6 to monitor the caches. |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| Drive_Prefix | storage.config | The device path start of the disks. For example, if you have ``/dev/sda`` through ``/dev/sdf`` set this to ``/dev/sd`` |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| Drive_Letters | storage.config | The letter part of the disks, in the same example as above set this to ``a,b,c,d,e,f`` |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| purge_allow_ip | ip_allow.config | The IP address range that is allowed to execute the PURGE method on the caches (not related to :ref:`rl-purge`) |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| coalesce_masklen_v4 | ip_allow.config | The masklen to use when coalescing v4 networks into one line using http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| coalesce_number_v4 | ip_allow.config | The number to use when coalescing v4 networks into one line using http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| coalesce_masklen_v6 | ip_allow.config | The masklen to use when coalescing v6 networks into one line using http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| coalesce_masklen_v6 | ip_allow.config | The masklen to use when coalescing v6 networks into one line using http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| health.threshold.loadavg | rascal.properties | The Unix load average at which Traffic Router will stop sending traffic to this cache |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| health.threshold.\\ | rascal.properties | The amount of bandwidth that Traffic Router will try to keep available on the cache. |
+| availableBandwidthInKbps | | For example: "">1500000" means stop sending new traffic to this cache when traffic is at 8.5Gbps on a 10Gbps interface. |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+
+Below is a list of Traffic Server plugins that need to be configured in the parameter table:
+
++------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+| Name | Config file | Description | Details |
++==================+===============+======================================================+============================================================================================================+
+| astats_over_http | package | The package version for the astats_over_http plugin. | `astats_over_http <http://trafficcontrol.apache.org/downloads/index.html>`_ |
++------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+| trafficserver | package | The package version for the trafficserver plugin. | `trafficserver <http://trafficcontrol.apache.org/downloads/index.html>`_ |
++------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+| regex_revalidate | plugin.config | The config to be used for regex_revalidate. | `regex_revalidate <https://docs.trafficserver.apache.org/en/5.3.x/reference/plugins/regex_remap.en.html>`_ |
+| | | For example: --config regex_revalidate.config | |
++------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+| remap_stats | plugin.config | The config to be used for remap_stats. | `remap_stats <https://github.com/apache/trafficserver/tree/master/plugins/experimental/remap_stats>`_ |
+| | | Value is left blank. | |
++------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+
+Below is a list of cache parameters for special configuration, which are unlikely to need changes, but may be useful in particular circumstances:
+
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| Name | Config file | Description |
++==========================+===================+=========================================================================================================================+
+| not_a_parent | parent.config | This is a boolean flag and is considered true if it exists and has any value except 'false'. |
+| | | This prevents servers with this parameter in their profile from being inserted into the parent.config generated for |
+| | | servers with this server's cachegroup as a parent of their cachegroup. This is primarily useful for when edge caches |
+| | | are configured to have a cachegroup of other edge caches as parents (a highly unusual configuration), and it is |
+| | | necessary to exclude some, but not all, edges in the parent cachegroup from the parent.config (for example, because they|
+| | | lack necessary capabilities), but still have all edges in the same cachegroup in order to take traffic from ordinary |
+| | | delivery services at that cachegroup's geo location. Once again, this is a highly unusual scenario, and under ordinary |
+| | | circumstances this parameter should not exist. |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+
+
+Regions, Locations and Cache Groups
+===================================
+All servers have to have a `location`, which is their physical location. Each location is part of a `region`, and each region is part of a `division`. For Example, ``Denver`` could be a location in the ``Mile High`` region and that region could be part of the ``West`` division. Enter your divisions first in `Misc->Divisions`, then enter the regions in `Misc->Regions`, referencing the divisions entered, and finally, enter the physical locations in `Misc->Locations`, referencing the regions entered.
+
+All servers also have to be part of a `cache group`. A cache group is a logical grouping of caches, that don't have to be in the same physical location (in fact, usually a cache group is spread across minimally 2 physical Locations for redundancy purposes), but share geo coordinates for content routing purposes. JvD to add more.
+
+
+
+Configuring Content Purge
+=========================
+Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the `Regex Revalidate Plugin <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html>`_ to purge content from the system. We don't actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it's config file, and will pick up changes to it without a `traffic_line -x` signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the lower tiers with the content that should be purged from the higher tiers without hitting the origin. This is why the ort script (see :ref:`reference-traffic-ops-ort`) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the `regex_revalidate.config` file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the `regex_revalidate.config` file.
+
+Content Purge is controlled by the following parameters in the profile of the cache:
+
++----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Config file | Description | Details |
++======================+=========================+==================================================+=========================================================================================================================================================+
+| location | regex_revalidate.config | What location the file should be in on the cache | The presence of this parameter tells ort to distribute this file; delete this parameter from the profile if this file is distributed using other means. |
++----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+| maxRevalDurationDays | regex_revalidate.config | The maximum time a purge can be active | To prevent a build up of many checks before each request, this is longest time the system will allow |
++----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+| regex_revalidate | plugin.config | The config to be used for regex_revalidate. | `regex_revalidate <https://docs.trafficserver.apache.org/en/5.3.x/reference/plugins/regex_remap.en.html>`_ |
+| | | For example: --config regex_revalidate.config | |
++----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+| use_reval_pending | global | Configures Traffic Ops to use separate | When this flag is in use ORT will check for a new regex_revalidate.config every 60 seconds in syncds mode during the dispersal timer. This will |
+| | | reval_pending flag for each cache. | also allow ORT to be run in revalidate mode, which will check for and clear the reval_pending flag. This can be set to run via cron task. |
+| | | | Enable with a value of 1. Use of this feature requires Traffic Ops 2.1 and above. Parameter should be assigned to the GLOBAL profile. |
++----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+
+Note that the TTL the adminstrator enters in the purge request should be longer than the TTL of the content to ensure the bad content will not be used. If the CDN is serving content of unknown, or unlimited TTL, the administrator should consider using `proxy-config-http-cache-guaranteed-min-lifetime <https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html#proxy-config-http-cache-guaranteed-min-lifetime>`_ to limit the maximum time an object can be in the cache before it is considered stale, and set that to the same value as `maxRevalDurationDays` (Note that the former is in seconds and the latter is in days, so convert appropriately).
+
+
+
+.. _Creating-CentOS-Kickstart:
+
+Creating the CentOS Kickstart File
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The kickstart file is a text file, containing a list of items, each identified by a keyword. You can create it by using the Kickstart Configurator application, or writing it from scratch. The Red Hat Enterprise Linux installation program also creates a sample kickstart file based on the options that you selected during installation. It is written to the file ``/root/anaconda-ks.cfg``. This file is editable using most text editors that can save files as ASCII text.
+
+To generate ISO, the CentOS Kickstart is necessary:
+
+1. Create a kickstart file.
+2. Create a boot media with the kickstart file or make the kickstart file available on the network.
+3. Make the installation tree available.
+4. Start the kickstart installation.
+
+Create a ks.src file in the root of the selection location. See the example below:
+
+::
+
+
+ mkdir newdir
+ cd newdir/
+ cp -r ../centos65/* .
+ vim ks.src
+ vim isolinux/isolinux.cfg
+ cd vim osversions.cfg
+ vim osversions.cfg
+
+
+This is a standard kickstart formatted file that the generate ISO process uses to create the kickstart (ks.cfg) file for the install. The generate ISO process uses the ks.src, overwriting any information set in the Generate ISO tab in Traffic Ops, creating ks.cfg.
+
+.. Note:: Streamline your install folder for under 1GB, which assists in creating a CD.
+
+.. seealso:: For in-depth instructions, please see `Kickstart Installation <https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Installation_Guide/s1-kickstart2-howuse.html>`_
+
+
+Configuring the Go Application
+==============================
+Traffic Ops is in the process of migrating from Perl to Go, and currently runs as two applications. The Go application serves all endpoints which have been rewritten in the Go language, and transparently proxies all other requests to the old Perl application. Both applications are installed by the RPM, and both run as a single service. When the project has fully migrated to Go, the Perl application will be removed, and the RPM and service will consist solely of the Go application.
+
+By default, the postinstall script configures the Go application to behave and transparently serve as the old Perl Traffic Ops did in previous versions. This includes reading the old ``cdn.conf`` and ``database.conf`` config files, and logging to the old ``access.log`` location. However, if you wish to customize the Go Traffic Ops application, you can do so by running it with the ``-oldcfg=false`` argument. By default, it will then look for a config file in ``/opt/traffic_ops/conf/traffic_ops_golang.config``. The new config file location may also be customized via the ``-cfg`` flag. A sample config file is installed by the RPM at ``/opt/traffic_ops/conf/traffic_ops_golang.config``. If you wish to run the new Go Traffic Ops application as a service with a new config file, the ``-oldcfg=false`` and ``-cfg`` flags may be added to the ``start`` function in the service file, located by default at ``etc/init.d/traffic_ops``.
diff --git a/docs/latest/_sources/admin/traffic_ops/default_profiles.rst.txt b/docs/latest/_sources/admin/traffic_ops/default_profiles.rst.txt
new file mode 100644
index 0000000..9b629be
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops/default_profiles.rst.txt
@@ -0,0 +1,53 @@
+..
+..
+.. 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.
+..
+
+.. index::
+ Traffic Ops - Default Profiles
+
+.. _rl-to-default-profiles:
+
+Traffic Ops - Default Profiles
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+Traffic Ops has the concept of :ref:`rl-working-with-profiles`, which are an integral function within Traffic Ops. To get started, a set of default Traffic Ops profiles need to be imported into Traffic Ops
+to get started to support Traffic Control components Traffic Router, Traffic Monitor, and Apache Traffic Server.
+
+`Download Default Profiles from here <http://trafficcontrol.incubator.apache.org/downloads/profiles/>`_
+
+.. _rl-to-profiles-min-needed:
+
+Minimum Traffic Ops Profiles needed
+-----------------------------------
+ * EDGE_ATS_<version>_<platform>_PROFILE.traffic_ops
+ * MID_ATS_<version>_<platform>_PROFILE.traffic_ops
+ * TRAFFIC_MONITOR_PROFILE.traffic_ops
+ * TRAFFIC_ROUTER_PROFILE.traffic_ops
+ * TRAFFIC_STATS_PROFILE.traffic_ops
+
+
+
+Steps to Import a Profile
+-------------------------
+1. Sign into Traffic Ops
+
+2. Navigate to 'Parameters->Select Profile'
+
+3. Click the "Import Profile" button at the bottom
+
+4. Choose the specific profile you want to import from your download directory
+
+5. Click 'Submit'
+
+6. Continue these steps for each :ref:`rl-to-profiles-min-needed` above
diff --git a/docs/latest/_sources/admin/traffic_ops/extensions.rst.txt b/docs/latest/_sources/admin/traffic_ops/extensions.rst.txt
new file mode 100644
index 0000000..4aceebb
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops/extensions.rst.txt
@@ -0,0 +1,88 @@
+..
+..
+.. 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.
+..
+
+.. _admin-to-ext-script:
+
+Managing Traffic Ops Extensions
+*******************************
+
+Each script is a separate bash script located in ``$TO_HOME/bin/checks/``.
+
+The extensions must be registered with Traffic Ops in order to display a column on the Server Check page. The list of currently registered extensions can be listed by running ``/opt/traffic_ops/app/bin/extensions -a``.
+
+The below extensions are automatically registered with the Traffic Ops database (``to_extension`` table) at install time (see ``traffic_ops/app/db/seeds.sql``). However, cron must still be configured to run these checks periodically.
+
+The scripts are called as follows: ::
+
+
+ $TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
+ where:
+
+ <name> is the type of check script
+ <traffic_ops_ip> is the IP address of the Traffic Ops Server
+ <check_name> is the name of the check. For example: CDU, CHR, DSCP, MTU, etc...
+ <log_level> is between 1 and 4, with 4 being the most verbose. This field is optional
+
+
+Example Cron File
+=================
+Edit with ``crontab -e``. You may need to adjust the path to your $TO_HOME to match your system.
+
+::
+
+
+ PERL5LIB=/opt/traffic_ops/app/local/lib/perl5:/opt/traffic_ops/app/lib
+
+ # IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": [\"hostName\",\"domainName\"]}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"name\": \"IPv4 Ping\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+ # IPv6 ping examples
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"name\": \"IPv6 Ping\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+
+ # iLO ping
+ 18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"select\": \"iloIpAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"name\": \"ILO ping\", \"select\": \"iloIpAddress\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
+
+ # MTU ping
+ 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+ 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+ # FQDN
+ 27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\"" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\", \"name\": \"DNS Lookup\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+ # DSCP
+ 36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"cms_interface\": \"eth0\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"name\": \"Delivery Service\", \"cms_interface\": \"eth0\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+ # RTR
+ 10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\", \"name\": \"Content Router Check\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+ # CHR
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToCHRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CHR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+
+ # CDU
+ 20 * * * * root /opt/traffic_ops/app/bin/checks/ToCDUCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CDU\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+
+ # ORT
+ 40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\", \"name\": \"Operational Readiness Test\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
diff --git a/docs/latest/_sources/admin/traffic_ops/installation.rst.txt b/docs/latest/_sources/admin/traffic_ops/installation.rst.txt
new file mode 100644
index 0000000..d2eaec1
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops/installation.rst.txt
@@ -0,0 +1,243 @@
+..
+..
+.. 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.
+..
+
+.. index::
+ Traffic Ops - Installing
+
+.. _rl-to-install:
+
+Traffic Ops - Installing
+%%%%%%%%%%%%%%%%%%%%%%%%
+
+System Requirements
+-------------------
+The user must have the following for a successful minimal install:
+
+* CentOS 7
+* 2 VMs with at least 2 vCPUs, 4GB RAM, 20 GB disk space each
+* Access to Centos Base and epel repositories
+* Access to `The Comprehensive Perl Archive Network (CPAN) <http://www.cpan.org/>`_
+
+As of version 2.0 only Postgres is supported as the database. This documentation assumes CentOS 7.2 and Postgresql 9.6.3 for a production install.
+
+.. highlight:: none
+
+Navigating the Install
+-----------------------
+To begin the install:
+
+1. Install Postgres
+
+ For a production install it is best to install postgres on it's own server/VM. To install postgres, on the postgres host (pg) ::
+
+ pg-$ sudo su -
+ pg-# yum -y update
+ pg-# yum -y install https://download.postgresql.org/pub/repos/yum/9.6/redhat/rhel-7-x86_64/pgdg-centos96-9.6-3.noarch.rpm
+ pg-# yum -y install postgresql96-server
+ pg-$ su - postgres
+ pg-$ /usr/pgsql-9.6/bin/initdb -A md5 -W #-W forces the user to provide a superuser (postgres) password
+
+
+ Edit ``/var/lib/pgsql/9.6/data/pg_hba.conf`` to allow your traffic ops app server access. For example if you are going to install traffic ops on ``99.33.99.1`` add::
+
+ host all all 99.33.99.1/32 md5
+
+ to the appropriate section of this file. Edit the ``/var/lib/pgsql/9.6/data/postgresql.conf`` file to add the approriate listen_addresses or ``listen_addresses = '*'``, set ``timezone = 'UTC'``, and start the database: ::
+
+ pg-$ exit
+ pg-# systemctl enable postgresql-9.6
+ pg-# systemctl start postgresql-9.6
+ pg-# systemctl status postgresql-9.6
+
+
+2. Build Traffic Ops
+
+ Build a Traffic Ops rpm using the instructions under the :ref:`dev-building` page.
+
+
+3. Install Postgresql
+
+ Install the postgresql 9.6 yum repository access. ::
+
+ to-$ sudo su -
+ to-# yum -y install https://download.postgresql.org/pub/repos/yum/9.6/redhat/rhel-7-x86_64/pgdg-centos96-9.6-3.noarch.rpm
+
+4. Install the rpm built in step 2. ::
+
+ to-# yum -y install ./dist/traffic_ops-2.0.0-xxxx.yyyyyyy.el7.x86_64.rpm
+
+
+ Install some additional packages that it depends on that were not installed as dependecies in the previous step (these are for the 2.0.0 install, this may change, but the pre-installs won't hurt): ::
+
+ to-# yum -y install git
+ to-# wget -q https://storage.googleapis.com/golang/go1.8.3.linux-amd64.tar.gz
+ to-# tar -C /usr/local -xzf go1.8.3.linux-amd64.tar.gz
+ to-# PATH=$PATH:/usr/local/go/bin # go bins are needed in the path for postinstall
+ to-# go get bitbucket.org/liamstask/goose/cmd/goose
+
+ At this point you should be able to login to the database from the ``to`` host to the ``pg`` host like: ::
+
+ to-# psql -h 99.33.99.1 -U postgres
+ Password for user postgres:
+ psql (9.6.3)
+ Type "help" for help.
+
+ postgres=#
+
+ Use this connectivity to create the user and database. In this example, we use user: ``traffic_ops``, password: ``tcr0cks``, database: ``traffic_ops``: ::
+
+ to-# psql -U postgres -h 99.33.99.1 -c "CREATE USER traffic_ops WITH ENCRYPTED PASSWORD 'tcr0cks';"
+ Password for user postgres:
+ CREATE ROLE
+ to-# createdb traffic_ops --owner traffic_ops -U postgres -h 99.33.99.1
+ Password:
+ to-#
+
+
+ Now, run the following command as root: ``/opt/traffic_ops/install/bin/postinstall``
+
+ The postinstall will first get all packages needed from CPAN. This may take a while, expect up to 30 minutes on the first install.
+ If there are any prompts in this phase, please just answer with the defaults (some CPAN installs can prompt for install questions).
+
+ When this phase is complete, you will see::
+
+ Complete! Modules were installed into /opt/traffic_ops/app/local
+
+ Some additional files will be installed, and then it will proceed with the next phase of the install, where it will ask you about the local environment for your CDN. Please make sure you remember all your answers and the database answers match the database information previously used to create the database.
+
+
+ Example output::
+
+ ===========/opt/traffic_ops/app/conf/production/database.conf===========
+ Database type [Pg]:
+ Database type: Pg
+ Database name [traffic_ops]:
+ Database name: traffic_ops
+ Database server hostname IP or FQDN [localhost]: 99.33.99.1
+ Database server hostname IP or FQDN: 99.33.99.1
+ Database port number [5432]:
+ Database port number: 5432
+ Traffic Ops database user [traffic_ops]:
+ Traffic Ops database user: traffic_ops
+ Password for Traffic Ops database user:
+ Re-Enter Password for Traffic Ops database user:
+ Writing json to /opt/traffic_ops/app/conf/production/database.conf
+ Database configuration has been saved
+ ===========/opt/traffic_ops/app/db/dbconf.yml===========
+ Database server root (admin) user [postgres]:
+ Database server root (admin) user: postgres
+ Password for database server admin:
+ Re-Enter Password for database server admin:
+ Download Maxmind Database? [yes]:
+ Download Maxmind Database?: yes
+ ===========/opt/traffic_ops/app/conf/cdn.conf===========
+ Generate a new secret? [yes]:
+ Generate a new secret?: yes
+ Number of secrets to keep? [10]:
+ Number of secrets to keep?: 10
+ Not setting up ldap
+ ===========/opt/traffic_ops/install/data/json/users.json===========
+ Administration username for Traffic Ops [admin]:
+ Administration username for Traffic Ops: admin
+ Password for the admin user:
+ Re-Enter Password for the admin user:
+ Writing json to /opt/traffic_ops/install/data/json/users.json
+ ===========/opt/traffic_ops/install/data/json/openssl_configuration.json===========
+ Do you want to generate a certificate? [yes]:
+ Country Name (2 letter code): US
+ State or Province Name (full name): CO
+ Locality Name (eg, city): Denver
+ Organization Name (eg, company): Super CDN, Inc
+ Organizational Unit Name (eg, section):
+ Common Name (eg, your name or your server's hostname):
+ RSA Passphrase:
+ Re-Enter RSA Passphrase:
+ ===========/opt/traffic_ops/install/data/json/profiles.json===========
+ Traffic Ops url [https://localhost]:
+ Traffic Ops url: https://localhost
+ Human-readable CDN Name. (No whitespace, please) [kabletown_cdn]: blue_cdn
+ Human-readable CDN Name. (No whitespace, please): blue_cdn
+ DNS sub-domain for which your CDN is authoritative [cdn1.kabletown.net]: blue-cdn.supercdn.net
+ DNS sub-domain for which your CDN is authoritative: blue-cdn.supercdn.net
+ Writing json to /opt/traffic_ops/install/data/json/profiles.json
+ Downloading Maxmind data
+ --2017-06-11 15:32:41-- http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
+ Resolving geolite.maxmind.com (geolite.maxmind.com)... 2400:cb00:2048:1::6810:262f, 2400:cb00:2048:1::6810:252f, 104.16.38.47, ...
+ Connecting to geolite.maxmind.com (geolite.maxmind.com)|2400:cb00:2048:1::6810:262f|:80... connected.
+
+ ... much SQL output skipped
+
+ Starting Traffic Ops
+ Restarting traffic_ops (via systemctl): [ OK ]
+ Waiting for Traffic Ops to restart
+ Success! Postinstall complete.
+
+ to-# ifconfig
+
+
+ Explanation of the information that needs to be provided:
+
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Field | Description |
+ +====================================================+==============================================================================================+
+ | Database type | Pg |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Database name | The name of the database Traffic Ops uses to store the configuration information |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Database server hostname IP or FQDN | The hostname of the database server |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Database port number | The database port number |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Traffic Ops database user | The username Traffic Ops will use to read/write from the database |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Password for traffic ops | The password for the above database user |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Database server root (admin) user name | Privileged database user that has permission to create the database and user for Traffic Ops |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Database server root (admin) user password | The password for the above privileged database user |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Traffic Ops url | The URL to connect to this instance of Traffic Ops, usually https://<traffic ops host FQDN>/ |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Human-readable CDN Name | The name of the first CDN traffic Ops will be managing |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | DNS sub-domain for which your CDN is authoritative | The DNS domain that will be delegated to this Traffic Control CDN |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Administration username for Traffic Ops | The Administration (highest privilege) Traffic Ops user to create; |
+ | | use this user to login for the first time and create other users |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+ | Password for the admin user | The password for the above user |
+ +----------------------------------------------------+----------------------------------------------------------------------------------------------+
+
+
+Traffic Ops is now installed!
+
+
+**To complete the Traffic Ops Setup See:** :ref:`rl-to-default-profiles`
+
+
+Upgrading Traffic Ops
+=====================
+To upgrade:
+
+#. Enter the following command:``service traffic_ops stop``
+#. Enter the following command:``yum upgrade traffic_ops``
+#. Enter the following command from the /opt/traffic_ops/app directory:
+ ``PERL5LIB=/opt/traffic_ops/app/lib:/opt/traffic_ops/app/local/lib/perl5 ./db/admin.pl --env production upgrade``
+#. See :ref:`rl-to-install` to run postinstall.
+#. Enter the following command:``service traffic_ops start``
+
+
+
+
diff --git a/docs/latest/_sources/admin/traffic_ops/migration_from_10_to_20.rst.txt b/docs/latest/_sources/admin/traffic_ops/migration_from_10_to_20.rst.txt
new file mode 100644
index 0000000..4133fee
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops/migration_from_10_to_20.rst.txt
@@ -0,0 +1,88 @@
+..
+..
+.. 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.
+..
+
+.. index::
+ Traffic Ops - Migrating from Traffic Ops 1.x to Traffic Ops 2.x
+
+.. _rl-ps:
+
+Traffic Ops - Migrating from 1.x to 2.x
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+In Traffic Ops 2.x MySQL was removed and Postgres was replaced as the database of choice for the unforeseen future. A Docker-based migration tool was developed to
+help with that conversion using an open source Postgres tool called `pgloader <http://pgloader.io/>`_. The following instructions will help configuring the Migration tool
+
+System Requirements
+-------------------
+The user must have the following for a successful minimal install:
+
+* CentOS 7.2+
+* Docker installed (this migration was tested against version **docker-engine-selinux-17.05.0.ce-1.el7.centos.noarch.rpm**)
+* Postgres has been installed according to :ref:`rl-to-install`
+
+Setup the traffic_ops_db directory
+----------------------------------
+
+ Modify /opt dir permission to make it writable and owned by postgres:postgres
+
+ ::
+
+ $ sudo chmod 755 /opt
+
+ Download the Traffic Control tarball for 2.0.0
+
+ ::
+
+ $ cd /opt
+ $ wget https://dist.apache.org/repos/dist/release/incubator/trafficcontrol/<tarball_version>
+
+ Extract the **traffic_ops_db** dir to **/opt/traffic_ops_db**
+
+ ::
+
+ $ tar -zxvf trafficcontrol-incubating-<version>.tar.gz --strip=1 trafficcontrol-incubating-<version>/traffic_ops_db
+ $ sudo chown -R postgres:postgres /opt/traffic_ops_db
+
+.. highlight:: none
+
+Migration Preparation
+---------------------
+Be sure there is connectivity between your MySQL server's IP address/port and your Postgres server's IP address/port.
+
+Navigating the Database Migration
+---------------------------------
+Begin the database migration after settings up the **/opt/traffic_ops_db** directory
+
+ Switch to the postgres user so permissions stay intact.
+ ::
+
+ $ su - postgres
+ $ cd /opt/traffic_ops_db/
+
+1. Configure the **/opt/traffic_ops_db/pg-migration/mysql-to-postgres.env** migration for your source MySQL and target Postgres settings
+
+
+2. Run the migration, watch the console output for any errors (it may take some time)
+ ::
+
+ $ ./migrate.sh
+
+
+ Your MySQL data should now be ported into your new instance of Postgres!
+
+
+
+
+
diff --git a/docs/latest/_sources/admin/traffic_ops/migration_from_20_to_22.rst.txt b/docs/latest/_sources/admin/traffic_ops/migration_from_20_to_22.rst.txt
new file mode 100644
index 0000000..d27fed4
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops/migration_from_20_to_22.rst.txt
@@ -0,0 +1,122 @@
+..
+..
+.. 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.
+..
+
+Traffic Ops - Migrating from 2.0 to 2.2
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+Per-DeliveryService Routing Names
+---------------------------------
+Before this release, DNS Delivery Services were hardcoded to use the name "edge", i.e. "edge.myds.mycdn.com", and HTTP Delivery Services use the name "tr" (or previously "ccr"), i.e. "tr.myds.mycdn.com". As of 2.2, Routing Names will default to "cdn" if left unspecified and can be set to any arbitrary non-dotted hostname.
+
+Pre-2.2 the HTTP Routing Name is configurable via the http.routing.name option in in the Traffic Router http.properties config file. If your CDN uses that option to change the name from "tr" to something else, then you will need to perform the following steps for each CDN affected:
+
+1. In Traffic Ops, create the following profile parameter (double-check for typos, trailing spaces, etc):
+
+ * **name**: upgrade_http_routing_name
+ * **config file**: temp
+ * **value**: whatever value is used for the affected CDN's http.routing.name
+
+2. Add this parameter to a single profile in the affected CDN
+
+With those profile parameters in place Traffic Ops can be safely upgraded to 2.2. Before taking a post-upgrade snapshot, make sure to check your Delivery Service example URLs for unexpected Routing Name changes. Once Traffic Ops has been upgraded to 2.2 and a post-upgrade snapshot has been taken, your Traffic Routers can be upgraded to 2.2 (Traffic Routers must be upgraded after Traffic Ops so that they can work with custom per-DeliveryService Routing Names).
+
+Apache Traffic Server 7.x (Cachekey Plugin)
+-------------------------------------------
+In Traffic Ops 2.2 we have added support for Apache Traffic Server 7.x. With 7.x comes support for the new cachekey plugin which replaces the cacheurl plugin which is now deprecated.
+While not needed immediately it is recommended to start replacing cacheurl usages with cachekey as soon as possible because ATS 6.x already supports the new cachekey plugin.
+
+It is also recommended to thoroughly vet your cachekey replacement by comparing with an existing key value. There are inconsistencies in the 6.x version of cachekey which have been
+fixed in 7.x (or require this patch(`cachekeypatch`_) on 6.x to match 7.x). So to ensure you have a matching key value you should use the xdebug plugin before fully implementing your cachekey replacement.
+
+.. _cachekeypatch: https://github.com/apache/trafficserver/commit/244288fab01bdad823f9de19dcece62a7e2a0c11
+
+First if you are currently using a regex for your delivery service you will have to remove that existing value. Then you will need to make a new DS profile and assign parameters in
+it to the cachekey.config file.
+
+Some common parameters are
+
+.. highlight:: none
+
+::
+
+ static-prefix - This is used for a simple domain replacement
+ separator - Used by cachekey and in general is always a single space
+ remove-path - Removes path information from the URL
+ remove-all-params - Removes parameters from the URL
+ capture-prefix-uri - This is usually used in combination with remove-path and remove-all-params.
+ Capture-prefix-uri will let you use your own full regex value for non simple cases
+
+Examples of Cacheurl to Cachekey Replacements
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**Original regex value:**
+
+``http://test.net/(.*) http://test-cdn.net/$1``
+
+**Cachekey parameters:**
+
++---------------+-----------------+---------------------------------+
+| Parameter | File | Value |
++===============+=================+=================================+
+| static-prefix | cachekey.config | ``http://test-cdn.net/`` |
++---------------+-----------------+---------------------------------+
+| separator | cachekey.config | (empty space) |
++---------------+-----------------+---------------------------------+
+
+**Original regex value:**
+
+``http://([^?]+)(?:?|$) http://test-cdn.net/$1``
+
+**Cachekey parameters:**
+
++-----------------------+-----------------+-----------------------------------------------------+
+| Parameter | File | Value |
++=======================+=================+=====================================================+
+| remove-path | cachekey.config | true |
++-----------------------+-----------------+-----------------------------------------------------+
+| remove-all-params | cachekey.config | true |
++-----------------------+-----------------+-----------------------------------------------------+
+| separator | cachekey.config | (empty space) |
++-----------------------+-----------------+-----------------------------------------------------+
+| capture-prefix-uri | cachekey.config | ``/https?:\/\/([^?]*)/http:\/\/test-cdn.net\/$1/`` |
++-----------------------+-----------------+-----------------------------------------------------+
+
+Also note the ``s?`` used here so that both http and https requests will end up with the same key value
+
+**Original regex value:**
+
+``http://test.net/([^?]+)(?:\?|$) http://test-cdn.net/$1``
+
+**Cachekey parameters:**
+
++-------------------+-----------------+---------------------------------+
+| Parameter | File | Value |
++===================+=================+=================================+
+| static-prefix | cachekey.config | ``http://test-cdn.net/`` |
++-------------------+-----------------+---------------------------------+
+| separator | cachekey.config | (empty space) |
++-------------------+-----------------+---------------------------------+
+| remove-all-params | cachekey.config | true |
++-------------------+-----------------+---------------------------------+
+
+.. _ApacheTrafficServerDocs: https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cachekey.en.html
+
+Further documentation on the cachekey plugin can be found at `ApacheTrafficServerDocs`_
+
+Apache Traffic Server 7.x (Logging)
+-------------------------------------------
+Trafficserver v7 has changed the logging format. Previously this was an xml file and now it is a lua file. Traffic Control compensates for this
+automatically depending upon the filename used for the logging parameters. Previously the file used was ``logs_xml.config``, for ATS 7 it is now
+``logging.config``. The same parameters will work this new file, ``LogFormat.Format``, ``LogFormat.Name``, ``LogObject.Format`` etc.
diff --git a/docs/latest/_sources/admin/traffic_ops/using.rst.txt b/docs/latest/_sources/admin/traffic_ops/using.rst.txt
new file mode 100644
index 0000000..c7273e5
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops/using.rst.txt
@@ -0,0 +1,1224 @@
+..
+..
+.. 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.
+..
+
+.. |graph| image:: ../../../../traffic_ops/app/public/images/graph.png
+.. |info| image:: ../../../../traffic_ops/app/public/images/info.png
+.. |checkmark| image:: ../../../../traffic_ops/app/public/images/good.png
+.. |X| image:: ../../../../traffic_ops/app/public/images/bad.png
+.. |clock| image:: ../../../../traffic_ops/app/public/images/clock-black.png
+
+Traffic Ops - Using
+%%%%%%%%%%%%%%%%%%%
+
+
+The Traffic Ops Menu
+====================
+
+.. image:: ../12m.png
+
+The following tabs are available in the menu at the top of the Traffic Ops user interface.
+
+.. index::
+ Health Tab
+
+* **Health**
+
+ Information on the health of the system. Hover over this tab to get to the following options:
+
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +===============+====================================================================================================================================+
+ | Table View | A real time view into the main performance indicators of the CDNs managed by Traffic Control. |
+ | | This view is sourced directly by the Traffic Monitor data and is updated every 10 seconds. |
+ | | This is the default screen of Traffic Ops. |
+ | | See :ref:`rl-health-table` for details. |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Graph View | A real graphical time view into the main performance indicators of the CDNs managed by Traffic Control. |
+ | | This view is sourced by the Traffic Monitor data and is updated every 10 seconds. |
+ | | On loading, this screen will show a history of 24 hours of data from Traffic Stats |
+ | | See :ref:`rl-health-graph` for details. |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Server Checks | A table showing the results of the periodic check extension scripts that are run. See :ref:`rl-server-checks` |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Daily Summary | A graph displaying the daily peaks of bandwidth, overall bytes served per day, and overall bytes served since initial installation |
+ | | per CDN. |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+
+* **Delivery Services**
+
+ The main Delivery Service table. This is where you Create/Read/Update/Delete Delivery Services of all types. Hover over to get the following sub option:
+
+ +-------------+--------------------------------------+
+ | Option | Description |
+ +=============+======================================+
+ | Federations | Add/Edit/Delete Federation Mappings. |
+ +-------------+--------------------------------------+
+
+* **Servers**
+
+ The main Servers table. This is where you Create/Read/Update/Delete servers of all types. Click the main tab to get to the main table, and hover over to get these sub options:
+
+ +-------------------+------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +===================+==========================================================================================+
+ | Upload Server CSV | Bulk add of servers from a csv file. See :ref:`rl-bulkserver` |
+ +-------------------+------------------------------------------------------------------------------------------+
+
+* **Parameters**
+
+ Parameters and Profiles can be edited here. Hover over the tab to get the following options:
+
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +=====================+=====================================================================================================================================================================+
+ | Global Profile | The table of global parameters. See :ref:`rl-param-prof`. This is where you Create/Read/Update/Delete parameters in the Global profile |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | All Cache Groups | The table of all parameters *that are assigned to a cachegroup* - this may be slow to pull up, as there can be thousands of parameters. |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | All Profiles | The table of all parameters *that are assigned to a profile* - this may be slow to pull up, as there can be thousands of parameters. |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Select Profile | Select the parameter list by profile first, then get a table of just the parameters for that profile. |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Export Profile | Profiles can be exported from one Traffic Ops instance to another using 'Select Profile' and under the "Profile Details" dialog for the desired profile |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Import Profile | Profiles can be imported from one Traffic Ops instance to another using the button "Import Profile" after using the "Export Profile" feature |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Orphaned Parameters | A table of parameters that are not associated to any profile of cache group. These parameters either should be deleted or associated with a profile of cache group. |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+* **Tools**
+
+ Tools for working with Traffic Ops and it's servers. Hover over this tab to get the following options:
+
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +====================+===================================================================================================================================+
+ | Generate ISO | Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See :ref:`rl-generate-iso` |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Queue Updates | Send Updates to the caches. See :ref:`rl-queue-updates` |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | DB Dump | Backup the Database to a .sql file. |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Snapshot CRConfig | Send updates to the Traffic Monitor / Traffic Router servers. See :ref:`rl-queue-updates` |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Invalidate Content | Invalidate or purge content from all caches in the CDN. See :ref:`rl-purge` |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Manage DNSSEC keys | Manage DNSSEC Keys for a chosen CDN. |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+
+
+* **Misc**
+
+ Miscellaneous editing options. Hover over this tab to get the following options:
+
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +====================+===========================================================================================+
+ | CDNs | Create/Read/Update/Delete CDNs |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Cache Groups | Create/Read/Update/Delete cache groups |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Users | Create/Read/Update/Delete users |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Profiles | Create/Read/Update/Delete profiles. See :ref:`rl-working-with-profiles` |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Networks(ASNs) | Create/Read/Update/Delete Autonomous System Numbers See :ref:`rl-asn-czf` |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Hardware | Get detailed hardware information (note: this should be moved to a Traffic Ops Extension) |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Data Types | Create/Read/Update/Delete data types |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Divisions | Create/Read/Update/Delete divisions |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Regions | Create/Read/Update/Delete regions |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Physical Locations | Create/Read/Update/Delete locations |
+ +--------------------+-------------------------------------------------------------------------------------------+
+
+.. index::
+ Change Log
+
+* **ChangeLog**
+
+ The Changelog table displays the changes that are being made to the Traffic Ops database through the Traffic Ops user interface. This tab will show the number of changes since you last visited this tab in (brackets) since the last time you visited this tab. There are currently no sub menus for this tab.
+
+
+* **Help**
+
+ Help for Traffic Ops and Traffic Control. Hover over this tab to get the following options:
+
+ +---------------+---------------------------------------------------------------------+
+ | Option | Description |
+ +===============+=====================================================================+
+ | About | Traffic Ops information, such as version, database information, etc |
+ +---------------+---------------------------------------------------------------------+
+ | Release Notes | Release notes for the most recent releases of Traffic Ops |
+ +---------------+---------------------------------------------------------------------+
+ | Logout | Logout from Traffic Ops |
+ +---------------+---------------------------------------------------------------------+
+
+
+.. index::
+ Edge Health
+ Health
+
+Health
+======
+
+.. _rl-health-table:
+
+The Health Table
+++++++++++++++++
+The Health table is the default landing screen for Traffic Ops, it displays the status of the EDGE caches in a table form directly from Traffic Monitor (bypassing Traffic Stats), sorted by Mbps Out. The columns in this table are:
+
+
+* **Profile**: the Profile of this server or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.
+* **Host Name**: the host name of the server or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.
+* **Edge Cache Group**: the edge cache group short name or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.
+* **Healthy**: indicates if this cache is healthy according to the Health Protocol. A row with ALL in any of the columns will always show a |checkmark|, this column is valid only for individual EDGE caches.
+* **Admin**: shows the administrative status of the server.
+* **Connections**: the number of connections this cache (or group of caches) has open (``ats.proxy.process.http.current_client_connections`` from ATS).
+* **Mbps Out**: the bandwidth being served out if this cache (or group of caches)
+
+Since the top line has ALL, ALL, ALL, it shows the total connections and bandwidth for all caches managed by this instance of Traffic Ops.
+
+.. _rl-health-graph:
+
+Graph View
+++++++++++
+The Graph View shows a live view of the last 24 hours of bits per seconds served and open connections at the edge in a graph. This data is sourced from Traffic Stats. If there are 2 CDNs configured, this view will show the statistis for both, and the graphs are stacked. On the left-hand side, the totals and immediate values as well as the percentage of total possible capacity are displayed. This view is update every 10 seconds.
+
+
+.. _rl-server-checks:
+
+Server Checks
++++++++++++++
+The server checks page is intended to give an overview of the Servers managed by Traffic Control as well as their status. This data comes from `Traffic Ops extensions <traffic_ops_extensions.html>`_.
+
++------+-----------------------------------------------------------------------+
+| Name | Description |
++======+=======================================================================+
+| ILO | Ping the iLO interface for EDGE or MID servers |
++------+-----------------------------------------------------------------------+
+| 10G | Ping the IPv4 address of the EDGE or MID servers |
++------+-----------------------------------------------------------------------+
+| 10G6 | Ping the IPv6 address of the EDGE or MID servers |
++------+-----------------------------------------------------------------------+
+| MTU | Ping the EDGE or MID using the configured MTU from Traffic Ops |
++------+-----------------------------------------------------------------------+
+| FQDN | DNS check that matches what the DNS servers responds with compared to |
+| | what Traffic Ops has. |
++------+-----------------------------------------------------------------------+
+| DSCP | Checks the DSCP value of packets from the edge server to the Traffic |
+| | Ops server. |
++------+-----------------------------------------------------------------------+
+| RTR | Content Router checks. Checks the health of the Content Routers. |
+| | Checks the health of the caches using the Content Routers. |
++------+-----------------------------------------------------------------------+
+| CHR | Cache Hit Ratio in percent. |
++------+-----------------------------------------------------------------------+
+| CDU | Total Cache Disk Usage in percent. |
++------+-----------------------------------------------------------------------+
+| ORT | Operational Readiness Test. Uses the ORT script on the edge and mid |
+| | servers to determine if the configuration in Traffic Ops matches the |
+| | configuration on the edge or mid. The user that this script runs as |
+| | must have an ssh key on the edge servers. |
++------+-----------------------------------------------------------------------+
+
+Daily Summary
++++++++++++++
+Displays daily max gbps and bytes served for all CDNs. In order for the graphs to appear, the 'daily_bw_url' and 'daily_served_url' parameters need to be be created, assigned to the global profile, and have a value of a grafana graph. For more information on configuring grafana, see the `Traffic Stats <../traffic_stats.html>`_ section.
+
+.. _rl-server:
+
+Server
+======
+This view shows a table of all the servers in Traffic Ops. The table columns show the most important details of the server. The **IPAddrr** column is clickable to launch an ``ssh://`` link to this server. The |graph| icon will link to a Traffic Stats graph of this server for caches, and the |info| will link to the server status pages for other server types.
+
+
+Server Types
+++++++++++++
+These are the types of servers that can be managed in Traffic Ops:
+
++---------------+---------------------------------------------+
+| Name | Description |
++===============+=============================================+
+| EDGE | Edge Cache |
++---------------+---------------------------------------------+
+| MID | Mid Tier Cache |
++---------------+---------------------------------------------+
+| ORG | Origin |
++---------------+---------------------------------------------+
+| CCR | Traffic Router |
++---------------+---------------------------------------------+
+| RASCAL | Rascal health polling & reporting |
++---------------+---------------------------------------------+
+| TOOLS_SERVER | Ops hosts for managment |
++---------------+---------------------------------------------+
+| RIAK | Riak keystore |
++---------------+---------------------------------------------+
+| SPLUNK | SPLUNK indexer search head etc |
++---------------+---------------------------------------------+
+| TRAFFIC_STATS | traffic_stats server |
++---------------+---------------------------------------------+
+| INFLUXDB | influxDb server |
++---------------+---------------------------------------------+
+
+
+.. index::
+ Bulk Upload Server
+
+.. _rl-bulkserver:
+
+Bulk Upload Server
+++++++++++++++++++
+TBD
+
+
+Delivery Service
+================
+The fields in the Delivery Service view are:
+
+
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Active | Whether or not this delivery service is active on the CDN and is capable of traffic. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Content Routing Type | DNS is the standard routing type for most CDN services. HTTP Redirect is a specialty routing service that is primarily used for video and large file downloads where localization and latency are significant concerns. |
+| | A "Live" routing type should be used for all live services. See :ref:`rl-ds-types`. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Key (XML ID) | This id becomes a part of the CDN service domain in the form ``http://cdn.service-key.company.com/``. Must be all lowercase, no spaces or special characters. May contain dashes. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Display Name | Name of the service that appears in the Traffic portal. No character restrictions. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Tenant | Name of company or division of company who owns account. Allows you to group your services and control access. Tenants are setup as a simple hierarchy where you may create parent / child accounts. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| CDN | The CDN in which the delivery service belongs to. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Routing Name | The routing name to use for the delivery FQDN, i.e. ``<routing-name>.<deliveryservice>.<cdn-domain>``. It must be a valid hostname without periods. [2]_ |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Protocol | The protocol to serve this delivery service to the clients with: |
+| | |
+| | - HTTP: Delivery only HTTP traffic |
+| | - HTTPS: Delivery only HTTPS traffic |
+| | - HTTP AND HTTPS: Deliver both types of traffic. |
+| | - HTTP TO HTTPS: Delivery HTTP traffic as HTTPS traffic |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DSCP Tag | The Differentiated Services Code Point (DSCP) value to mark IP packets to the client with. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Signing Algorithm | Type of URL signing method to sign the URLs: |
+| | |
+| | - null: token based auth is not enabled for this delivery service. |
+| | - “url_sig”: URL Sign token based auth is enabled for this delivery service. |
+| | - “uri_signing”: URI Signing token based auth is enabled for this delivery service. |
+| | |
+| | See :ref:`rl-signed-urls`. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Deep Caching | Enables clients to be routed to the closest possible "deep" edge caches on a per Delivery Service basis. |
+| | See `Deep Caching <http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_router.html#deep-caching-deep-coverage-zone-topology>`_ |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Query String Handling | How to treat query strings: |
+| | |
+| | - 0 use in cache key and hand up to origin: Each unique query string is treated as a unique URL. |
+| | - 1 Do not use in cache key, but pass up to origin: 2 URLs that are the same except for the query string will match and cache HIT, while the origin still sees original query string in the request. |
+| | - 2 Drop at edge: 2 URLs that are the same except for the query string will match and cache HIT, while the origin will not see original query string in the request. |
+| | |
+| | **Note:** Choosing to drop query strings at the edge will preclude the use of a Regex Remap Expression. See :ref:`rl-regex-remap`. |
+| | |
+| | To set the qstring without the use of regex remap, or for further options, see :ref:`rl-qstring-handling`. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geolocation Provider | Choose which Geolocation database provider, company that collects data on the location of IP addresses, to use. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Anonymous Blocking | Set to true to enable blocking of anonymous IPs for this delivery service. **Note:** Requires Geolocation provider's Anonymous IP database. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Limit | Some services are intended to be limited by geography. The possible settings are: |
+| | |
+| | - None: Do not limit by geography. |
+| | - CZF only: If the requesting IP is not in the Coverage Zone File, do not serve the request. |
+| | - CZF + US: If the requesting IP is not in the Coverage Zone File or not in the United States, do not serve the request. |
+| | |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Limit Countries | How (if at all) is this service to be limited by geography. Example Country Codes: CA, IN, PR. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Limit Redirect URL | Traffic Router will redirect to this URL when Geo Limit check fails. See :ref:`rl-tr-ngb` |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Regional Geoblocking | Define regional geo-blocking rules for delivery services in a JSON format and set it to True/False. |
+| | See `regional geo-blocking <http://traffic-control-cdn.readthedocs.io/en/latest/admin/quick_howto/regionalgeo.html#configure-regional-geo-blocking-rgb>`_ |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| IPv6 Routing Enabled | Default is "True", entering "False" allows you to turn off CDN response to IPv6 requests |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Range Request Handling | How to treat range requests: |
+| | |
+| | - 0: Do not cache (ranges requested from files that are already cached due to a non range request will be a HIT) |
+| | - 1: Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/background_fetch.en.html>`_ plugin. |
+| | - 2: Use the cache_range_requests plugin. |
+| | |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass IP | IPv4 address to overflow requests when the Max Bps or Max Tps for this delivery service exceeds. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass IPv6 | IPv6 address to overflow requests when the Max Bps or Max Tps for this delivery service exceeds. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass CNAME | Domain name to overflow requests when the Max Bps or Max Tps for this delivery service exceeds. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass TTL | TTL for the DNS bypass domain or IP when threshold exceeds |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP Bypass FQDN | Traffic Router will redirect to this FQDN (with the same path) when the Max Bps or Max Tps for this delivery service exceeds. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Delivery Service DNS TTL | The Time To Live on the DNS record for the Traffic Router A and AAAA records. Setting too high or too low will result in poor caching performance. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Fair Queuing Pacing Rate Bps | The maximum bytes per second a cache will delivery on any single TCP connection. This uses the Linux kernel’s Fair Queuing setsockopt (SO_MAX_PACING_RATE) to limit the rate of delivery. Traffic exceeding this speed will only be rate-limited and not diverted. This option requires net.core.default_qdisc = fq in /etc/sysctl.conf. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Global Max Mbps | The maximum bits per second this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used (depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Global Max TPS | The maximum transactions per se this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used (depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Max DNS Answers | It is used to restrict the number of cache IP addresses that the CCR will hand back. A numeric value from 1 to 15 which determines how many caches your content will be spread across in a particular site. When a customer requests your content they will get 1 to 15 IP addresses back they can use. These are rotated in each response. Ideally the number will reflect the amount of traffic. 1 = trial account with very little traffic, 2 = small production service. Add 1 more server for every 20 Gbps of traffic you expect at peak. So 20 Gbps = 3, 40 Gbps = 4, 60 Gbps = 5 |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Initial Dispersion | Determines number of machines content will be placed on within a cache group. Setting too high will result in poor caching performance. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Origin Server Base URL | The Origin Server’s base URL which includes the protocol (http or https). Example: ``http://movies.origin.com`` |
+| | Must be a domain only, no directories or IP addresses |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Use Multi Site Origin Feature | Set True/False to enable/disable the Multi Site Origin feature for this delivery service. See :ref:`rl-multi-site-origin` |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Delivery Service Profile | Only used if a delivery service uses configurations that specifically require a profile. Example: MSO configurations or cachekey plugin would require a ds profile to be used. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Miss Default Latitude | Default Latitude for this delivery service. When client localization fails for both Coverage Zone and Geo Lookup, this the client will be routed as if it was at this lat. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Miss Default Longitude | Default Longitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this long. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Edge Header Rewrite Rules | Headers can be added or altered at each layer of the CDN. You must tell us four things: the action, the header name, the header value, and the direction to apply. The action will tell us whether we are adding, removing, or replacing headers. The header name and header value will determine the full header text. The direction will determine whether we add it before we respond to a request or before we make a request further up the chain in the server hierarchy. Examples include: |
+| | |
+| | - Action: Set |
+| | - Header Name: X-CDN |
+| | - Header Value: Foo |
+| | - Direction: Edge Response to Client |
+| | |
+| | See :ref:`rl-header-rewrite`. [1]_ |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Mid Header Rewrite Rules | Headers can be added or altered at each layer of the CDN. You must tell us four things: the action, the header name, the header value, and the direction to apply. The action will tell us whether we are adding, removing, or replacing headers. The header name and header value will determine the full header text. The direction will determine whether we add it before we respond to a request or before we make a request further up the chain in the server hierarchy. Examples include: |
+| | |
+| | - Action: Set |
+| | - Header Name: Host |
+| | - Header Value: code_abc123 |
+| | - Direction: Mid Request to Origin |
+| | |
+| | See :ref:`rl-header-rewrite`. [1]_ |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Traffic Router Additional Response Headers | List of header name:value pairs separated by __RETURN__. Listed pairs will be included in all TR HTTP responses. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Traffic Router Log Request Headers | List of header keys separated by __RETURN__. Listed headers will be included in TR access log entries under the “rh=” token. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Regex remap expression | Allows remapping of incoming requests URL using regex pattern matching to search/replace text. |
+| | See `ATS documentation on regex_remap <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html>`_. [1]_ |
+| | |
+| | **Note:** you will not be able to save a Regex Remap Expression if you have Query String Handling set to drop query strings at the edge. See :ref:`rl-regex-remap`. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Cache URL expression | Allows you to manipulate the cache key of the incoming requests. Normally, the cache key is the origin domain. This can be changed so that multiple services can share a cache key, can also be used to preserve cached content if service origin is changed. |
+| | |
+| | **Note:** Only valid in ATS 6.X and earlier. Must be empty if using ATS 7.X and/or the `cachekey plugin <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cachekey.en.html>`_. [1]_ |
+| | |
+| | See `ATS documentation on cacheurl <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/plugins/cacheurl.en.html>`_. [1]_ |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Raw remap text | For HTTP and DNS delivery services, this will get added to the end of the remap line on the cache verbatim. For ANY_MAP delivery services this is the remap line. [1]_ |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Long Description | Free text field that describes the purpose of the delivery service and will be displayed in the portal as a description field. For example, you can use this field to describe your service. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Long Description 2 | Free text field not currently used in configuration. For example, you can use this field to describe your customer type. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Long Description 3 | Free text field not currently used in configuration. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Info URL | Free text field allowing you to enter a URL which provides information about the service. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Check Path | A path (ex: /crossdomain.xml) to verify the connection to the origin server with. This can be used by Check Extension scripts to do periodic health checks against the delivery service. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Origin Shield (Pipe Delimited String) | Add another forward proxy upstream of the mid caches. Example: go_direct=true will allow the Mid to hit the origin directly instead of failing if the origin shield is down. Experimental Feature. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Logs Enabled | Allows you to turn on/off logging for the service |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. [1] These fields are not validated by Traffic Ops to be correct syntactically, and can cause Traffic Server to not start if invalid. Please use with caution.
+.. [2] It is not recommended to change the Routing Name of a Delivery Service after deployment because this changes its Delivery FQDN (i.e. ``<routing-name>.<deliveryservice>.<cdn-domain>``), which means that SSL certificates may need to be updated and clients using the Delivery Service will need to be transitioned to the new Delivery URL.
+
+
+.. index::
+ Delivery Service Type
+
+.. _rl-ds-types:
+
+Delivery Service Types
+++++++++++++++++++++++
+One of the most important settings when creating the delivery service is the selection of the delivery service *type*. This type determines the routing method and the primary storage for the delivery service.
+
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++=================+========================================================================================================================================================================================================================================================================================================================================+
+| HTTP | HTTP Content Routing - The Traffic Router DNS auth server returns its own IP address on DNS queries, and the client gets redirected to a specific cache |
+| | in the nearest cache group using HTTP 302. Use this for long sessions like HLS/HDS/Smooth live streaming, where a longer setup time is not a. |
+| | problem. |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS | DNS Content Routing - The Traffic Router DNS auth server returns an edge cache IP address to the client right away. The client will find the cache quickly |
+| | but the Traffic Router can not route to a cache that already has this content in the cache group. Use this for smaller objects like web page images / objects. |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP_NO_CACHE | HTTP Content Routing, but the caches will not actually cache the content, they act as just proxies. The MID tier is bypassed. |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP_LIVE | HTTP Content routing, but where for "standard" HTTP content routing the objects are stored on disk, for this delivery service type the objects are stored |
+| | on the RAM disks. Use this for linear TV. The MID tier is bypassed for this type. |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP_LIVE_NATNL | HTTP Content routing, same as HTTP_LIVE, but the MID tier is NOT bypassed. |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS_LIVE_NATNL | DNS Content routing, but where for "standard" DNS content routing the objects are stored on disk, for this delivery service type the objects are stored |
+| | on the RAM disks. Use this for linear TV. The MID tier is NOT bypassed for this type. |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS_LIVE | DNS Content routing, same as DNS_LIVE_NATNL, but the MID tier is bypassed. |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ANY_MAP | ANY_MAP is not known to Traffic Router. For this deliveryservice, the "Raw remap text" field in the input form will be used as the remap line on the cache. |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| STEERING | The Delivery Service will be used to route to other delivery services. The target delivery services and the routing weights for those delivery services will be defined by an admin or steering user. For more information see the `steering feature <../traffic_router.html#steering-feature>`_ documentation |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| CLIENT_STEERING | Similar to STEERING except that a client can send a request to Traffic Router with a query param of `trred=false`, and Traffic Router will return an HTTP 200 response with a body that contains a list of Delivery Service URLs that the client can connect to. Therefore, the client is doing the steering, not the Traffic Router. |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. _rl-federations:
+
+Federations
++++++++++++
+ Federations allow for other (federated) CDNs (at a different ISP, MSO, etc) to add a list of resolvers and a CNAME to a delivery service Traffic Ops. When a request is made from one of federated CDN's clients, Traffic Router will return the CNAME configured in the federation mapping. This allows the federated CDN to serve the content without the content provider changing the URL, or having to manage multiple URLs.
+
+ Before adding a federation in the Traffic Ops UI, a user with the federations role needs to be created. This user will be assigned to the federation and will be able to add resolvers to the federation via the Traffic Ops `Federation API <../../development/traffic_ops_api/v12/federation.html>`_.
+
+.. index::
+ Header Rewrite
+
+.. _rl-header-rewrite:
+
+Header Rewrite Options and DSCP
++++++++++++++++++++++++++++++++
+Most header manipulation and per-delivery service configuration overrides are done using the `ATS Header Rewrite Plugin <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/header_rewrite.en.html>`_. Traffic Control allows you to enter header rewrite rules to be applied at the edge and at the mid level. The syntax used in Traffic Ops is the same as the one described in the ATS documentation, except for some special strings that will get replaced:
+
++-------------------+--------------------------+
+| Traffic Ops Entry | Gets Replaced with |
++===================+==========================+
+| __RETURN__ | A newline |
++-------------------+--------------------------+
+| __CACHE_IPV4__ | The cache's IPv4 address |
++-------------------+--------------------------+
+
+The deliveryservice screen also allows you to set the DSCP value of traffic sent to the client. This setting also results in a header_rewrite rule to be generated and applied to at the edge.
+
+.. Note:: The DSCP setting in the UI is *only* for setting traffic towards the client, and gets applied *after* the initial TCP handshake is complete, and the HTTP request is received (before that the cache can't determine what deliveryservice this request is for, and what DSCP to apply), so the DSCP feature can not be used for security settings - the TCP SYN-ACK is not going to be DSCP marked.
+
+
+.. index::
+ Token Based Authentication
+ Signed URLs
+
+.. _rl-signed-urls:
+
+Token Based Authentication
+++++++++++++++++++++++++++
+Token based authentication or *signed URLs* is implemented using the Traffic Server ``url_sig`` plugin. To sign a URL at the signing portal take the full URL, without any query string, and add on a query string with the following parameters:
+
+Client IP address
+ The client IP address that this signature is valid for.
+
+ ``C=<client IP address>``
+
+Expiration
+ The Expiration time (seconds since epoch) of this signature.
+
+ ``E=<expiration time in secs since unix epoch>``
+
+Algorithm
+ The Algorithm used to create the signature. Only 1 (HMAC_SHA1)
+ and 2 (HMAC_MD5) are supported at this time
+
+ ``A=<algorithm number>``
+
+Key index
+ Index of the key used. This is the index of the key in the
+ configuration file on the cache. The set of keys is a shared
+ secret between the signing portal and the edge caches. There
+ is one set of keys per reverse proxy domain (fqdn).
+
+ ``K=<key index used>``
+Parts
+ Parts to use for the signature, always excluding the scheme
+ (http://). parts0 = fqdn, parts1..x is the directory parts
+ of the path, if there are more parts to the path than letters
+ in the parts param, the last one is repeated for those.
+ Examples:
+
+ 1: use fqdn and all of URl path
+ 0110: use part1 and part 2 of path only
+ 01: use everything except the fqdn
+
+ ``P=<parts string (0's and 1's)>``
+
+Signature
+ The signature over the parts + the query string up to and
+ including "S=".
+
+ ``S=<signature>``
+
+.. seealso:: The url_sig `README <https://github.com/apache/trafficserver/blob/master/plugins/experimental/url_sig/README>`_.
+
+Generate URL Sig Keys
+^^^^^^^^^^^^^^^^^^^^^
+To generate a set of random signed url keys for this delivery service and store them in Traffic Vault, click the **Generate URL Sig Keys** button at the bottom of the delivery service details screen.
+
+
+.. rl-parent-selection:
+
+Parent Selection
+++++++++++++++++
+
+Parameters in the Edge (child) profile that influence this feature:
+
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| Name | Filename | Default | Description |
++===============================================+================+===============+=======================================================+
+| CONFIG proxy.config. | records.config | INT 1 | enable parent selection. This is a required setting. |
+| http.parent_proxy_routing_enable | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 1 | required for parent selection. |
+| url_remap.remap_required | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 0 | See |
+| http.no_dns_just_forward_to_parent | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 1 | |
+| http.uncacheable_requests_bypass_parent | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 1 | |
+| http.parent_proxy_routing_enable | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 300 | |
+| http.parent_proxy.retry_time | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 10 | |
+| http.parent_proxy.fail_threshold | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 4 | |
+| http.parent_proxy.total_connect_attempts | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 2 | |
+| http.parent_proxy.per_parent_connect_attempts | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 30 | |
+| http.parent_proxy.connect_attempts_timeout | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 0 | |
+| http.forward.proxy_auth_to_parent | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 0 | |
+| http.parent_proxy_routing_enable | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | STRING | |
+| http.parent_proxy.file | | parent.config | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 3 | |
+| http.parent_proxy.connect_attempts_timeout | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| algorithm | parent.config | urlhash | The algorithm to use. |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+
+
+Parameters in the Mid (parent) profile that influence this feature:
+
++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Filename | Default | Description |
++================+===============+=========+===================================================================================================================================================================================+
+| domain_name | CRConfig.json | - | Only parents with the same value as the edge are going to be used as parents (to keep separation between CDNs) |
++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| weight | parent.config | 1.0 | The weight of this parent, translates to the number of replicas in the consistent hash ring. This parameter only has effect with algorithm at the client set to "consistent_hash" |
++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| port | parent.config | 80 | The port this parent is listening on as a forward proxy. |
++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| use_ip_address | parent.config | 0 | 1 means use IP(v4) address of this parent in the parent.config, 0 means use the host_name.domain_name concatenation. |
++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. _rl-qstring-handling:
+
+Qstring Handling
+++++++++++++++++
+
+Delivery services have a Query String Handling option that, when set to ignore, will automatically add a regex remap to that delivery service's config. There may be times this is not preferred, or there may be requirements for one delivery service or server(s) to behave differently. When this is required, the psel.qstring_handling parameter can be set in either the delivery service profile or the server profile, but it is important to note that the server profile will override ALL delivery services assigned to servers with this profile parameter. If the parameter is not set for the server profile but is present for the Delivery Service profile, this will override the setting in the delivery service. A value of "ignore" will not result in the addition of regex remap configuration.
+
++-----------------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Filename | Default | Description |
++=======================+===============+=========+===================================================================================================================================================================================+
+| psel.qstring_handling | parent.config | - | Sets qstring handling without the use of regex remap for a delivery service when assigned to a delivery service profile, and overrides qstring handling for all delivery services |
+| | | | for associated servers when assigned to a server profile. Value must be "consider" or "ignore". |
++-----------------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. _rl-multi-site-origin:
+
+Multi Site Origin
++++++++++++++++++
+
+.. Note:: The configuration of this feature changed significantly between ATS version 5 and >= 6. Some configuration in Traffic Control is different as well. This documentation assumes ATS 6 or higher. See :ref:`rl-multi-site-origin-qht` for more details.
+
+Normally, the mid servers are not aware of any redundancy at the origin layer. With Multi Site Origin enabled this changes - Traffic Server (and Traffic Ops) are now made aware of the fact there are multiple origins, and can be configured to do more advanced failover and loadbalancing actions. A prerequisite for MSO to work is that the multiple origin sites serve identical content with identical paths, and both are configured to serve the same origin hostname as is configured in the deliveryservice `Origin Server Base URL` field. See the `Apache Traffic Server docs <https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html>`_ for more information on that cache's implementation.
+
+With This feature enabled, origin servers (or origin server VIP names for a site) are going to be entered as servers in to the Traiffic Ops UI. Server type is "ORG".
+
+Parameters in the mid profile that influence this feature:
+
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| Name | Filename | Default | Description |
++==========================================================================+================+============+====================================================================================================+
+| CONFIG proxy.config. http.parent_proxy_routing_enable | records.config | INT 1 | enable parent selection. This is a required setting. |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| CONFIG proxy.config. url_remap.remap_required | records.config | INT 1 | required for parent selection. |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+
+
+Parameters in the deliveryservice profile that influence this feature:
+
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| Name | Filename | Default | Description |
++=============================================+================+=================+=================================================================================================================================+
+| mso.parent_retry | parent.config | \- | Either ``simple_retry``, ``dead_server_retry`` or ``both``. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| mso.algorithm | parent.config | consistent_hash | The algorithm to use. ``consisten_hash``, ``strict``, ``true``, ``false``, or ``latched``. |
+| | | | |
+| | | | - ``consisten_hash`` - spreads requests across multiple parents simultaneously based on hash of content URL. |
+| | | | - ``strict`` - strict Round Robin spreads requests across multiple parents simultaneously based on order of requests. |
+| | | | - ``true`` - same as strict, but ensures that requests from the same IP always go to the same parent if available. |
+| | | | - ``false`` - uses only a single parent at any given time and switches to a new parent only if the current parent fails. |
+| | | | - ``latched`` - same as false, but now, a failed parent will not be retried. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| mso.unavailable_server_retry_response_codes | parent.config | "503" | Quoted, comma separated list of HTTP status codes that count as a unavailable_server_retry_response_code. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| mso.max_unavailable_server_retries | parent.config | 1 | How many times an unavailable server will be retried. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| mso.simple_retry_response_codes | parent.config | "404" | Quoted, comma separated list of HTTP status codes that count as a simple retry response code. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| mso.max_simple_retries | parent.config | 1 | How many times a simple retry will be done. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+
+
+
+see :ref:`rl-multi-site-origin-qht` for a *quick how to* on this feature.
+
+.. _rl-ccr-profile:
+
+Traffic Router Profile
+++++++++++++++++++++++
+
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Config_file | Description |
++=========================================+========================+===========================================================================================================================================================================================================+
+| location | dns.zone | Location to store the DNS zone files in the local file system of Traffic Router. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| location | http-log4j.properties | Location to find the log4j.properties file for Traffic Router. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| location | dns-log4j.properties | Location to find the dns-log4j.properties file for Traffic Router. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| location | geolocation.properties | Location to find the log4j.properties file for Traffic Router. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| CDN_name | rascal-config.txt | The human readable name of the CDN for this profile. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| CoverageZoneJsonURL | CRConfig.xml | The location (URL) to retrieve the coverage zone map file in JSON format from. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| geolocation.polling.url | CRConfig.json | The location (URL) to retrieve the geo database file from. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| geolocation.polling.interval | CRConfig.json | How often to refresh the coverage geo location database in ms |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| coveragezone.polling.interval | CRConfig.json | How often to refresh the coverage zone map in ms |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| coveragezone.polling.url | CRConfig.json | The location (URL) to retrieve the coverage zone map file in JSON format from. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| deepcoveragezone.polling.interval | CRConfig.json | How often to refresh the deep coverage zone map in ms |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| deepcoveragezone.polling.url | CRConfig.json | The location (URL) to retrieve the deep coverage zone map file in JSON format from. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.soa.expire | CRConfig.json | The value for the expire field the Traffic Router DNS Server will respond with on Start of Authority (SOA) records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.soa.minimum | CRConfig.json | The value for the minimum field the Traffic Router DNS Server will respond with on SOA records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.soa.admin | CRConfig.json | The DNS Start of Authority admin. Should be a valid support email address for support if DNS is not working correctly. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.soa.retry | CRConfig.json | The value for the retry field the Traffic Router DNS Server will respond with on SOA records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.soa.refresh | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on A records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.ttls.NS | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on NS records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.ttls.SOA | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on SOA records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.ttls.AAAA | CRConfig.json | The Time To Live (TTL) the Traffic Router DNS Server will respond with on AAAA records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.ttls.A | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on A records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.ttls.DNSKEY | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on DNSKEY records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.ttls.DS | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on DS records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| api.port | server.xml | The TCP port Traffic Router listens on for API (REST) access. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| api.cache-control.max-age | CRConfig.json | The value of the ``Cache-Control: max-age=`` header in the API responses of Traffic Router. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| api.auth.url | CRConfig.json | The API authentication URL (https://${tmHostname}/api/1.1/user/login); ${tmHostname} is a search and replace token used by Traffic Router to construct the correct URL) |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| consistent.dns.routing | CRConfig.json | Control whether DNS Delivery Services use consistent hashing on the edge FQDN to select caches for answers. May improve performance if set to true; defaults to false |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| dnssec.enabled | CRConfig.json | Whether DNSSEC is enabled; this parameter is updated via the DNSSEC administration user interface. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| dnssec.allow.expired.keys | CRConfig.json | Allow Traffic Router to use expired DNSSEC keys to sign zones; default is true. This helps prevent DNSSEC related outages due to failed Traffic Control components or connectivity issues. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| dynamic.cache.primer.enabled | CRConfig.json | Allow Traffic Router to attempt to prime the dynamic zone cache; defaults to true |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| dynamic.cache.primer.limit | CRConfig.json | Limit the number of permutations to prime when dynamic zone cache priming is enabled; defaults to 500 |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| keystore.maintenance.interval | CRConfig.json | The interval in seconds which Traffic Router will check the keystore API for new DNSSEC keys |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| keystore.api.url | CRConfig.json | The keystore API URL (https://${tmHostname}/api/1.1/cdns/name/${cdnName}/dnsseckeys.json; ${tmHostname} and ${cdnName} are search and replace tokens used by Traffic Router to construct the correct URL) |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| keystore.fetch.timeout | CRConfig.json | The timeout in milliseconds for requests to the keystore API |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| keystore.fetch.retries | CRConfig.json | The number of times Traffic Router will attempt to load keys before giving up; defaults to 5 |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| keystore.fetch.wait | CRConfig.json | The number of milliseconds Traffic Router will wait before a retry |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| signaturemanager.expiration.multiplier | CRConfig.json | Multiplier used in conjunction with a zone's maximum TTL to calculate DNSSEC signature durations; defaults to 5 |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| zonemanager.threadpool.scale | CRConfig.json | Multiplier used to determine the number of cores to use for zone signing operations; defaults to 0.75 |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| zonemanager.cache.maintenance.interval | CRConfig.json | The interval in seconds which Traffic Router will check for zones that need to be resigned or if dynamic zones need to be expired from cache |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| zonemanager.dynamic.response.expiration | CRConfig.json | A string (e.g.: 300s) that defines how long a dynamic zone |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNSKEY.generation.multiplier | CRConfig.json | Used to deteremine when new keys need to be regenerated. Keys are regenerated if expiration is less than the generation multiplier * the TTL. If the parameter does not exist, the default is 10. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNSKEY.effective.multiplier | CRConfig.json | Used when creating an effective date for a new key set. New keys are generated with an effective date of old key expiration - (effective multiplier * TTL). Default is 2. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+
+.. index::
+ Regex Remap Expression
+
+.. _rl-regex-remap:
+
+Regex Remap Expression
+++++++++++++++++++++++
+The regex remap expression allows to to use a regex and resulting match group(s) in order to modify the request URIs that are sent to origin. For example: ::
+
+ ^/original/(.*) http://origin.example.com/remapped/$1
+
+.. Note:: If **Query String Handling** is set to ``2 Drop at edge``, then you will not be allowed to save a regex remap expression, as dropping query strings actually relies on a regex remap of its own. However, if there is a need to both drop query strings **and** remap request URIs, this can be accomplished by setting **Query String Handling** to ``1 Do not use in cache key, but pass up to origin``, and then using a custom regex remap expression to do the necessary remapping, while simultaneously dropping query strings. The following example will capture the original request URI up to, but not including, the query string and then forward to a remapped URI: ::
+
+ ^/([^?]*).* http://origin.example.com/remapped/$1
+
+.. index::
+ HOST_REGEXP
+ PATH_REGEXP
+ HEADER_REGEXP
+ Delivery Service regexp
+
+.. _rl-ds-regexp:
+
+Delivery Service Regexp
++++++++++++++++++++++++
+This table defines how requests are matched to the delivery service. There are 3 type of entries possible here:
+
++---------------+----------------------------------------------------------------------+--------------+-----------+
+| Name | Description | DS Type | Status |
++===============+======================================================================+==============+===========+
+| HOST_REGEXP | This is the regular expresion to match the host part of the URL. | DNS and HTTP | Supported |
++---------------+----------------------------------------------------------------------+--------------+-----------+
+| PATH_REGEXP | This is the regular expresion to match the path part of the URL. | HTTP | Beta |
++---------------+----------------------------------------------------------------------+--------------+-----------+
+| HEADER_REGEXP | This is the regular expresion to match on any header in the request. | HTTP | Beta |
++---------------+----------------------------------------------------------------------+--------------+-----------+
+
+The **Order** entry defines the order in which the regular expressions get evaluated. To support ``CNAMES`` from domains outside of the Traffic Control top level DNS domain, enter multiple ``HOST_REGEXP`` lines.
+
+Example:
+ Example foo.
+
+.. Note:: In most cases is is sufficient to have just one entry in this table that has a ``HOST_REGEXP`` Type, and Order ``0``. For the *movies* delivery service in the Kabletown CDN, the entry is simply single ``HOST_REGEXP`` set to ``.*\.movies\..*``. This will match every url that has a hostname that ends with ``movies.cdn1.kabletown.net``, since ``cdn1.kabletown.net`` is the Kabletown CDN's DNS domain.
+
+.. index::
+ Static DNS Entries
+
+.. _rl-static-dns:
+
+Static DNS Entries
+++++++++++++++++++
+Static DNS entries allow you to create other names *under* the delivery service domain. You can enter any valid hostname, and create a CNAME, A or AAAA record for it by clicking the **Static DNS** button at the bottom of the delivery service details screen.
+
+.. index::
+ Server Assignments
+
+.. _rl-assign-edges:
+
+Server Assignments
+++++++++++++++++++
+Click the **Server Assignments** button at the bottom of the screen to assign servers to this delivery service. Servers can be selected by drilling down in a tree, starting at the profile, then the cache group, and then the individual servers. Traffic Router will only route traffic for this delivery service to servers that are assigned to it.
+
+
+.. _rl-asn-czf:
+
+The Coverage Zone File and ASN Table
+++++++++++++++++++++++++++++++++++++
+The Coverage Zone File (CZF) should contain a cachegroup name to network prefix mapping in the form: ::
+
+ {
+ "coverageZones": {
+ "cache-group-01": {
+ "coordinates": {
+ "latitude": 1.1,
+ "longitude": 2.2
+ },
+ "network6": [
+ "1234:5678::/64",
+ "1234:5679::/64"
+ ],
+ "network": [
+ "192.168.8.0/24",
+ "192.168.9.0/24"
+ ]
+ },
+ "cache-group-02": {
+ "coordinates": {
+ "latitude": 3.3,
+ "longitude": 4.4
+ },
+ "network6": [
+ "1234:567a::/64",
+ "1234:567b::/64"
+ ],
+ "network": [
+ "192.168.4.0/24",
+ "192.168.5.0/24"
+ ]
+ }
+ }
+ }
+
+The CZF is an input to the Traffic Control CDN, and as such does not get generated by Traffic Ops, but rather, it gets consumed by Traffic Router. Some popular IP management systems output a very similar file to the CZF but in stead of a cachegroup an ASN will be listed. Traffic Ops has the "Networks (ASNs)" view to aid with the conversion of files like that to a Traffic Control CZF file; this table is not used anywhere in Traffic Ops, but can be used to script the conversion using the API.
+
+The script that generates the CZF file is not part of Traffic Control, since it is different for each situation.
+
+.. note:: The ``"coordinates"`` section is optional and may be used by Traffic Router for localization in the case of a CZF "hit" where the zone name does not map to a Cache Group name in Traffic Ops (i.e. Traffic Router will route to the closest Cache Group(s) geographically).
+
+.. _rl-deep-czf:
+
+The Deep Coverage Zone File
++++++++++++++++++++++++++++
+The Deep Coverage Zone File (DCZF) format is similar to the CZF format but adds a ``caches`` list under each ``deepCoverageZone``: ::
+
+ {
+ "deepCoverageZones": {
+ "location-01": {
+ "coordinates": {
+ "latitude": 5.5,
+ "longitude": 6.6
+ },
+ "network6": [
+ "1234:5678::/64",
+ "1234:5679::/64"
+ ],
+ "network": [
+ "192.168.8.0/24",
+ "192.168.9.0/24"
+ ],
+ "caches": [
+ "edge-01",
+ "edge-02"
+ ]
+ },
+ "location-02": {
+ "coordinates": {
+ "latitude": 7.7,
+ "longitude": 8.8
+ },
+ "network6": [
+ "1234:567a::/64",
+ "1234:567b::/64"
+ ],
+ "network": [
+ "192.168.4.0/24",
+ "192.168.5.0/24"
+ ],
+ "caches": [
+ "edge-02",
+ "edge-03"
+ ]
+ }
+ }
+ }
+
+Each entry in the ``caches`` list is the hostname of an edge cache registered in Traffic Ops which will be used for "deep" caching in that Deep Coverage Zone. Unlike a regular CZF, coverage zones in the DCZF do not map to a Cache Group in Traffic Ops, so currently the deep coverage zone name only needs to be unique.
+
+If the Traffic Router gets a DCZF "hit" for a requested Delivery Service that has Deep Caching enabled, the client will be routed to an available "deep" cache from that zone's ``caches`` list.
+
+.. note:: The ``"coordinates"`` section is optional.
+
+
+.. _rl-working-with-profiles:
+
+Parameters and Profiles
+=======================
+Parameters are shared between profiles if the set of ``{ name, config_file, value }`` is the same. To change a value in one profile but not in others, the parameter has to be removed from the profile you want to change it in, and a new parameter entry has to be created (**Add Parameter** button at the bottom of the Parameters view), and assigned to that profile. It is easy to create new profiles from the **Misc > Profiles** view - just use the **Add/Copy Profile** button at the bottom of the profile view to copy an existing profile to a new one. Profiles can be exported from one system and imported to another using the profile view as well. It makes no sense for a parameter to not be assigned to a single profile - in that case it really has no function. To find parameters like that use the **Parameters > Orphaned Parameters** view. It is easy to create orphaned parameters by removing all profiles, or not assigning a profile directly after creating the parameter.
+
+.. seealso:: :ref:`rl-param-prof` in the *Configuring Traffic Ops* section.
+
+
+
+Tools
+=====
+
+.. index::
+ ISO
+ Generate ISO
+
+.. _rl-generate-iso:
+
+Generate ISO
+++++++++++++
+
+Generate ISO is a tool for building custom ISOs for building caches on remote hosts. Currently it only supports Centos 6, but if you're brave and pure of heart you MIGHT be able to get it to work with other unix-like OS's.
+
+The interface is *mostly* self explainatory as it's got hints.
+
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| Field | Explaination |
++===============================+=================================================================================================================================+
+|Choose a server from list: | This option gets all the server names currently in the Traffic Ops database and will autofill known values. |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| OS Version: | There needs to be an _osversions.cfg_ file in the ISO directory that maps the name of a directory to a name that shows up here. |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| Hostname: | This is the FQDN of the server to be installed. It is required. |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| Root password: | If you don't put anything here it will default to the salted MD5 of "Fred". Whatever put is MD5 hashed and writte to disk. |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| DHCP: | if yes, other IP settings will be ignored |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| IP Address: | Required if DHCP=no |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| Netmask: | Required if DHCP=no |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| Gateway: | Required if DHCP=no |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| IPV6 Address: | Optional. /64 is assumed if prefix is omitted |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| IPV6 Gateway: | Ignored if an IPV4 gateway is specified |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| Network Device: | Optional. Typical values are bond0, eth4, etc. Note: if you enter bond0, a LACP bonding config will be written |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| MTU: | If unsure, set to 1500 |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+| Specify disk for OS install: | Optional. Typical values are "sda". |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
+
+
+When you click the **Download ISO** button the folling occurs (all paths relative to the top level of the directory specified in _osversions.cfg_):
+
+#. Reads /etc/resolv.conf to get a list of nameservers. This is a rather ugly hack that is in place until we get a way of configuring it in the interface.
+#. Writes a file in the ks_scripts/state.out that contains directory from _osversions.cfg_ and the mkisofs string that we'll call later.
+#. Writes a file in the ks_scripts/network.cfg that is a bunch of key=value pairs that set up networking.
+#. Creates an MD5 hash of the password you specify and writes it to ks_scripts/password.cfg. Note that if you do not specify a password "Fred" is used. Also note that we have experienced some issues with webbrowsers autofilling that field.
+#. Writes out a disk configuration file to ks_scripts/disk.cfg.
+#. mkisofs is called against the directory configured in _osversions.cfg_ and an ISO is generated in memory and delivered to your webbrowser.
+
+You now have a customized ISO that can be used to install Red Hat and derivative Linux installations with some modifications to your ks.cfg file.
+
+Kickstart/Anaconda will mount the ISO at /mnt/stage2 during the install process (at least with 6).
+
+You can directly include the password file anywhere in your ks.cfg file (usually in the top) by doing %include /mnt/stage2/ks_scripts/password.cfg
+
+What we currently do is have 2 scripts, one to do hard drive configuration and one to do network configuration. Both are relatively specific to the environment they were created in, and both are *probably* wrong for other organizations, however they are currently living in the "misc" directory as examples of how to do things.
+
+We trigger those in a %pre section in ks.cfg and they will write config files to /tmp. We will then include those files in the appropriate places using %pre.
+
+For example this is a section of our ks.cfg file: ::
+
+ %include /mnt/stage2/ks_scripts/packages.txt
+
+ %pre
+ python /mnt/stage2/ks_scripts/create_network_line.py
+ bash /mnt/stage2/ks_scripts/drive_config.sh
+ %end
+
+These two scripts will then run _before_ anaconda sets up it's internal structures, then a bit further up in the ks.cfg file (outside of the %pre %end block) we do an ::
+
+ %include /mnt/stage2/ks_scripts/password.cfg
+ ...
+ %include /tmp/network_line
+
+ %include /tmp/drive_config
+ ...
+
+This snarfs up the contents and inlines them.
+
+If you only have one kind of hardware on your CDN it is probably best to just put the drive config right in the ks.cfg.
+
+If you have simple networking needs (we use bonded interfaces in most, but not all locations and we have several types of hardware meaning different ethernet interface names at the OS level etc.) then something like this: ::
+
+ #!/bin/bash
+ source /mnt/stage2/ks_scripts/network.cfg
+ echo "network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY --nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME" >> /tmp/network.cfg
+ # Note that this is an example and may not work at all.
+
+
+You could also put this in the %pre section. Lots of ways to solve it.
+
+We have included the two scripts we use in the "misc" directory of the git repo:
+
+* kickstart_create_network_line.py
+* kickstart_drive_config.sh
+
+These scripts were written to support a very narrow set of expectations and environment and are almost certainly not suitable to just drop in, but they might provide a good starting point.
+
+.. _rl-queue-updates:
+
+Queue Updates and Snapshot CRConfig
++++++++++++++++++++++++++++++++++++
+When changing delivery services special care has to be taken so that Traffic Router will not send traffic to caches for delivery services that the cache doesn't know about yet. In general, when adding delivery services, or adding servers to a delivery service, it is best to update the caches before updating Traffic Router and Traffic Monitor. When deleting delivery services, or deleting server assignments to delivery services, it is best to update Traffic Router and Traffic Monitor first and then the caches. Updating the cache configuration is done through the *Queue Updates* menu, and updating Traffic Monitor and Traffic Router config is done through the *Snapshot CRConfig* menu.
+
+.. index::
+ Cache Updates
+ Queue Updates
+
+Queue Updates
+^^^^^^^^^^^^^
+Every 15 minutes the caches should run a *syncds* to get all changes needed from Traffic Ops. The files that will be updated by the syncds job are:
+
+- records.config
+- remap.config
+- parent.config
+- cache.config
+- hosting.config
+- url\_sig\_(.*)\.config
+- hdr\_rw\_(.*)\.config
+- regex_revalidate.config
+- ip_allow.config
+
+A cache will only get updated when the update flag is set for it. To set the update flag, use the *Queue Updates* menu - here you can schedule updates for a whole CDN or a cache group:
+
+ #. Click **Tools > Queue Updates**.
+ #. Select the CDN to queueu uodates for, or All.
+ #. Select the cache group to queue updates for, or All
+ #. Click the **Queue Updates** button.
+ #. When the Queue Updates for this Server? (all) window opens, click **OK**.
+
+To schedule updates for just one cache, use the "Server Checks" page, and click the |checkmark| in the *UPD* column. The UPD column of Server Checks page will change show a |clock| when updates are pending for that cache.
+
+
+.. index::
+ Snapshot CRConfig
+
+.. _rl-snapshot-crconfig:
+
+Snapshot CRConfig
+^^^^^^^^^^^^^^^^^
+
+Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See :ref:`rl-ccr-profile` for more information on the CRConfig file.
+
+To create a new snapshot, use the *Tools > Snapshot CRConfig* menu:
+
+ #. Click **Tools > Snapshot CRConfig**.
+ #. Verify the selection of the correct CDN from the Choose CDN drop down and click **Diff CRConfig**.
+ On initial selection of this, the CRConfig Diff window says the following:
+
+ There is no existing CRConfig for [cdn] to diff against... Is this the first snapshot???
+ If you are not sure why you are getting this message, please do not proceed!
+ To proceed writing the snapshot anyway click the 'Write CRConfig' button below.
+
+ If there is an older version of the CRConfig, a window will pop up showing the differences
+ between the active CRConfig and the CRConfig about to be written.
+
+ #. Click **Write CRConfig**.
+ #. When the This will push out a new CRConfig.json. Are you sure? window opens, click **OK**.
+ #. The Successfully wrote CRConfig.json! window opens, click **OK**.
+
+
+.. index::
+ Invalidate Content
+ Purge
+
+.. _rl-purge:
+
+Invalidate Content
+==================
+Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
+
+.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
+
+To invalidate content:
+
+ 1. Click **Tools > Invalidate Content**
+ 2. Fill out the form fields:
+
+ - Select the **Delivery Service**
+ - Enter the **Path Regex** - this should be a `PCRE <http://www.pcre.org/>`_ compatible regular expression for the path to match for forcing the revalidation. Be careful to only match on the content you need to remove - revalidation is an expensive operation for many origins, and a simple ``/.*`` can cause an overload condition of the origin.
+ - Enter the **Time To Live** - this is how long the revalidation rule will be active for. It usually makes sense to make this the same as the ``Cache-Control`` header from the origin which sets the object time to live in cache (by ``max-age`` or ``Expires``). Entering a longer TTL here will make the caches do unnecessary work.
+ - Enter the **Start Time** - this is the start time when the revalidation rule will be made active. It is pre-populated with the current time, leave as is to schedule ASAP.
+
+ 3. Click the **Submit** button.
+
+
+Manage DNSSEC Keys
+====================
+
+In order to support `DNSSEC <https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions>`_ in Traffic Router, Traffic Ops provides some actions for managing DNSSEC keys for a CDN and associated Delivery Services. DNSSEC Keys consist of a Key Signing Keys (KSK) which are used to sign other DNSKEY records as well as Zone Signing Keys (ZSK) which are used to sign other records. DNSSEC Keys are stored in `Traffic Vault <../../overview/traffic_vault.html>`_ and should only be accessible to Traffic Ops. Other applications needing access to this data, such as Traffic Router, must use the Traffic Ops `DNSSEC APIs <../../development/traffic_ops_api/v12/cdn.html#dnssec-keys>`_ to retrieve this information.
+
+To Manage DNSSEC Keys:
+ 1. Click **Tools -> Manage DNSSEC Keys**
+ 2. Choose a CDN and click **Manage DNSSEC Keys**
+
+ - If keys have not yet been generated for a CDN, this screen will be mostly blank with just the **CDN** and **DNSSEC Active?** fields being populated.
+ - If keys have been generated for the CDN, the Manage DNSSEC Keys screen will show the TTL and Top Level Domain (TLD) KSK Expiration for the CDN as well as DS Record information which will need to be added to the parent zone of the TLD in order for DNSSEC to work.
+
+The Manage DNSSEC Keys screen also allows a user to perform the following actions:
+
+**Activate/Deactivate DNSSEC for a CDN**
+
+Fairly straight forward, this button set the **dnssec.enabled** param to either **true** or **false** on the Traffic Router profile for the CDN. The Activate/Deactivate option is only available if DNSSEC keys exist for CDN. In order to active DNSSEC for a CDN a user must first generate keys and then click the **Active DNSSEC** button.
+
+**Generate Keys**
+
+Generate Keys will generate DNSSEC keys for the CDN TLD as well as for each Delivery Service in the CDN. It is important to note that this button will create a new KSK for the TLD and, therefore, a new DS Record. Any time a new DS Record is created, it will need to be added to the parent zone of the TLD in order for DNSSEC to work properly. When a user clicks the **Generate Keys** button, they will be presented with a screen with the following fields:
+
+ - **CDN:** This is not editable and displays the CDN for which keys will be generated
+ - **ZSK Expiration (Days):** Sets how long (in days) the Zone Signing Key will be valid for the CDN and associated Delivery Services. The default is 30 days.
+ - **KSK Expiration (Days):** Sets how long (in days) the Key Signing Key will be valid for the CDN and associated Delivery Services. The default is 365 days.
+ - **Effective Date (GMT):** The time from which the new keys will be active. Traffic Router will use this value to determine when to start signing with the new keys and stop signing with the old keys.
+
+Once these fields have been correctly entered, a user can click Generate Keys. The user will be presented with a confirmation screen to help them understand the impact of generating the keys. If a user confirms, the keys will be generated and stored in Traffic Vault.
+
+**Regenerate KSK**
+
+Regenerate KSK will create a new Key Signing Key for the CDN TLD. A new DS Record will also be generated and need to be put into the parent zone in order for DNSSEC to work correctly. The **Regenerate KSK** button is only available if keys have already been generated for a CDN. The intent of the button is to provide a mechanism for generating a new KSK when a previous one expires or if necessary for other reasons such as a security breach. When a user goes to generate a new KSK they are presented with a screen with the following options:
+
+ - **CDN:** This is not editable and displays the CDN for which keys will be generated
+ - **KSK Expiration (Days):** Sets how long (in days) the Key Signing Key will be valid for the CDN and associated Delivery Services. The default is 365 days.
+ - **Effective Date (GMT):** The time from which the new KSK and DS Record will be active. Since generating a new KSK will generate a new DS Record that needs to be added to the parent zone, it is very important to make sure that an effective date is chosen that allows for time to get the DS Record into the parent zone. Failure to get the new DS Record into the parent zone in time could result in DNSSEC errors when Traffic Router tries to sign responses.
+
+Once these fields have been correctly entered, a user can click Generate KSK. The user will be presented with a confirmation screen to help them understand the impact of generating the KSK. If a user confirms, the KSK will be generated and stored in Traffic Vault.
+
+Additionally, Traffic Ops also performs some systematic management of DNSSEC keys. This management is necessary to help keep keys in sync for Delivery Services in a CDN as well as to make sure keys do not expire without human intervention.
+
+**Generation of keys for new Delivery Services**
+
+If a new Delivery Service is created and added to a CDN that has DNSSEC enabled, Traffic Ops will create DNSSEC keys for the Delivery Service and store them in Traffic Vault.
+
+**Regeneration of expiring keys for a Delivery Service**
+
+Traffic Ops has a process, controlled by cron, to check for expired or expiring keys and re-generate them. The process runs at 5 minute intervals to check and see if keys are expired or close to expiring (withing 10 minutes by default). If keys are expired for a Delivery Service, traffic ops will regenerate new keys and store them in Traffic Vault. This process is the same for the CDN TLD ZSK, however Traffic Ops will not re-generate the CDN TLD KSK systematically. The reason is that when a KSK is regenerated for the CDN TLD then a new DS Record will also be created. The new DS Record needs to be added to the parent zone before Traffic Router attempts to sign with the new KSK in order for DNSSEC to work correctly. Therefore, management of the KSK needs to be a manual process.
diff --git a/docs/latest/_sources/admin/traffic_portal/installation.rst.txt b/docs/latest/_sources/admin/traffic_portal/installation.rst.txt
new file mode 100644
index 0000000..55b064b
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_portal/installation.rst.txt
@@ -0,0 +1,51 @@
+..
+..
+.. 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.
+..
+
+*****************************
+Traffic Portal Administration
+*****************************
+The following are requirements to ensure an accurate set up:
+
+* CentOS 6.7 or 7
+* Node.js 6.0.x or above
+
+**Installing Traffic Portal**
+
+ - Download the Traffic Portal RPM from `Apache Jenkins <https://builds.apache.org/view/S-Z/view/TrafficControl/job/incubator-trafficcontrol-master-build/>`_ or build the Traffic Portal RPM from source (./pkg -v traffic_portal_build).
+ - Copy the Traffic Portal RPM to your server
+ - curl --silent --location https://rpm.nodesource.com/setup_6.x | sudo bash -
+ - sudo yum install -y nodejs
+ - sudo yum install -y <traffic_portal rpm>
+
+**Configuring Traffic Portal**
+
+ - update /etc/traffic_portal/conf/config.js (if upgrade, reconcile config.js with config.js.rpmnew and then delete config.js.rpmnew)
+ - update /opt/traffic_portal/public/traffic_portal_properties.json (if upgrade, reconcile traffic_portal_properties.json with traffic_portal_properties.json.rpmnew and then delete traffic_portal_properties.json.rpmnew)
+ - [OPTIONAL] update /opt/traffic_portal/public/resources/assets/css/custom.css (to customize traffic portal skin)
+
+**Starting Traffic Portal**
+
+ - sudo service traffic_portal start
+
+**Stopping Traffic Portal**
+
+ - sudo service traffic_portal stop
+
+
+
+
+
+
+
diff --git a/docs/latest/_sources/admin/traffic_portal/usingtrafficportal.rst.txt b/docs/latest/_sources/admin/traffic_portal/usingtrafficportal.rst.txt
new file mode 100644
index 0000000..c7247e3
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_portal/usingtrafficportal.rst.txt
@@ -0,0 +1,800 @@
+..
+..
+.. 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.
+..
+
+.. _usingtrafficportal:
+
+Traffic Portal - Using
+%%%%%%%%%%%%%%%%%%%%%%
+
+Traffic Portal is the official replacement for the legacy Traffic Ops UI. Traffic Portal consumes the Traffic Ops API. The following high-level items are available in the Traffic Portal menu.
+
+.. image:: ./images/tp_menu.png
+
+Dashboard
+=========
+
+The Dashboard is the default landing page for Traffic Portal. It provides a real-time view into the main performance indicators of the CDNs managed by Traffic Control. It also displays various statistics about the overall health of your CDN.
+
+* **Current Bandwidth**: The current bandwidth of all of your CDNs.
+* **Current Connections**: The current number of connections to all of your CDNs.
+* **Healthy Caches**: Number of healthy caches across all CDNs. Click the link to view the healthy caches on the cache stats page.
+* **Unhealthy Caches**: Number of unhealthy caches across all CDNs. Click the link to view the unhealthy caches on the cache stats page.
+* **Online Caches**: Number of online caches. Traffic Monitor will not monitor the state of ONLINE servers. True health is unknown.
+* **Reported Caches**: Number of caches with REPORTED status.
+* **Offline Caches**: Number of caches with OFFLINE status.
+* **Admin Down Caches**: Number of caches with ADMIN_DOWN status.
+
+Each component of this view is updated at the intervals defined in tp.domain.com/traffic_portal_properties.json.
+
+CDNs
+====
+
+A table of CDNs with the following columns:
+
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+======================================================================================================================+
+| Name | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Domain | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| DNSSEC Enabled | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+
+CDN management includes the ability to (where applicable):
+
+- create a new CDN
+- update an existing CDN
+- delete an existing CDN
+- queue/clear updates on all servers in a CDN
+- diff CDN snapshot
+- create CDN snapshot
+- manage CDN DNSSEC keys
+- manage CDN federations
+- view CDN delivery services
+- view CDN profiles
+- view CDN servers
+
+Monitor
+=======
+
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +===============+====================================================================================================================================+
+ | Cache Checks | A real time view into the status of each cache. |
+ | | This view is sourced by the Traffic Monitor data thru the Traffic Ops API and is updated on demand. |
+ | | See :ref:`tp-cache-checks` for details. |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Cache Stats | A table showing the results of the periodic check extension scripts that are run. See :ref:`tp-cache-stats` for details. |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+
+Services
+========
+
+ +----------------------------------+-----------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +==================================+=================================================================================================================+
+ | Delivery Services | Settings for your delivery services. Only the delivery services defined by a user's tenancy are visible. |
+ | | See :ref:`tp-delivery-services` for details. |
+ +----------------------------------+-----------------------------------------------------------------------------------------------------------------+
+ | Delivery Service Requests | If enabled in tp.domain.com/traffic_portal_properties.json, all delivery service changes (create, update and |
+ | | delete) are captured as a delivery service request and must be reviewed before fulfillment/deployment. |
+ | | See :ref:`tp-delivery-service-requests` for details. |
+ +----------------------------------+-----------------------------------------------------------------------------------------------------------------+
+
+Configure
+=========
+
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +===============+====================================================================================================================================+
+ | Servers | Manage servers. See :ref:`tp-servers` |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Profiles | Manage profiles. See :ref:`tp-profiles` |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameters | Manage parameters. See :ref:`tp-parameters` |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Types | Manage types. See :ref:`tp-types` |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Statuses | Manage server statuses. See :ref:`tp-statuses` |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+
+Topology
+========
+
+ +----------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +================+===================================================================================================================================+
+ | Cache Groups | Manage cache groups. See :ref:`tp-cache-groups` |
+ +----------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Phys Locations | Manage profiles. See :ref:`tp-phys-locations` |
+ +----------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Divisions | Manage divisions. See :ref:`tp-divisions` |
+ +----------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Regions | Manage regions. See :ref:`tp-regions` |
+ +----------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | ASNs | Manage autonomous system numbers (ASN). See :ref:`tp-asns` |
+ +----------------+-----------------------------------------------------------------------------------------------------------------------------------+
+
+Tools
+=====
+
+ +--------------------+-------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +====================+===============================================================================================================================+
+ | Invalidate Content | Manage invalidate content jobs. See :ref:`tp-jobs` |
+ +--------------------+-------------------------------------------------------------------------------------------------------------------------------+
+ | Generate ISO | Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See :ref:`tp-gen-iso` |
+ +--------------------+-------------------------------------------------------------------------------------------------------------------------------+
+
+User Admin
+==========
+
+ +--------------------+-------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +====================+===============================================================================================================================+
+ | Users | Manage users. See :ref:`tp-users` |
+ +--------------------+-------------------------------------------------------------------------------------------------------------------------------+
+ | Tenants | Manage tenants. See :ref:`tp-tenants` |
+ +--------------------+-------------------------------------------------------------------------------------------------------------------------------+
+ | Roles | Manage roles. See :ref:`tp-roles` |
+ +--------------------+-------------------------------------------------------------------------------------------------------------------------------+
+
+
+Other
+=====
+
+ Custom menu items. By default, you get a link to Traffic Control docs. See :ref:`tp-menu-other`
+
+ +--------------------+--------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +====================+================================================================================================================================+
+ | Docs | Link to trafficcontrol.apache.org |
+ +--------------------+--------------------------------------------------------------------------------------------------------------------------------+
+
+------------
+
+Monitor
+=======
+
+.. image:: ./images/tp_menu_monitor.png
+
+.. _tp-cache-checks:
+
+Cache Checks
+++++++++++++
+The cache checks page is intended to give an overview of the caches managed by Traffic Control as well as their status.
+
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++==========+============================================================================================================================================+
+| Hostname | Cache host name |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| Profile | The name of the profile applied to the cache |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| Status | The status of the cache (ONLINE, REPORTED, ADMIN_DOWN, OFFLINE) |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| UPD | Config updates pending for an edge or mid |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| RVL | Content invalidation requests are pending for and edge or mid |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| ILO | Ping the iLO interface for EDGE or MID servers |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| 10G | Ping the IPv4 address of the EDGE or MID servers |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| FQDN | DNS check that matches what the DNS servers responds with compared to |
+| | what Traffic Ops has. |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| DSCP | Checks the DSCP value of packets from the edge server to the Traffic |
+| | Ops server. |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| 10G6 | Ping the IPv6 address of the EDGE or MID servers |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| MTU | Ping the EDGE or MID using the configured MTU from Traffic Ops |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| RTR | Content Router checks. Checks the health of the Content Routers. Checks the health of the caches using the Content Routers. |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| CHR | Cache Hit Ratio in percent. |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| CDU | Total Cache Disk Usage in percent. |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| ORT | Operational Readiness Test. Uses the ORT script on the edge and mid servers to determine if the configuration in Traffic Ops matches the |
+| | configuration on the edge or mid. The user that this script runs as must have an ssh key on the edge servers. |
++----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. _tp-cache-stats:
+
+Cache Stats
++++++++++++
+Displays health by cache group/profile.
+
++--------------+----------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++==============+========================================================================================================================================+
+| Profile | Name of the profile applied to the edge or mid cache |
++--------------+----------------------------------------------------------------------------------------------------------------------------------------+
+| Host | ALL or grouped by profile |
++--------------+----------------------------------------------------------------------------------------------------------------------------------------+
+| Cache Group | Cache Group Name |
++--------------+----------------------------------------------------------------------------------------------------------------------------------------+
+| Healthy | True/False as determined by Traffic Monitor |
++--------------+----------------------------------------------------------------------------------------------------------------------------------------+
+| Status | Status of the cache or cache group |
++--------------+----------------------------------------------------------------------------------------------------------------------------------------+
+| Connections | Number of connections |
++--------------+----------------------------------------------------------------------------------------------------------------------------------------+
+| MbpsOut | MbpsOut |
++--------------+----------------------------------------------------------------------------------------------------------------------------------------+
+
+Services
+========
+
+.. image:: ./images/tp_menu_services.png
+
+.. _tp-delivery-services:
+
+Delivery Services
++++++++++++++++++
+
+A table of your delivery services with the following columns:
+
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+=======================================================================================================================+
+| Key (XML ID) | A unique string that identifies this delivery service. |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| Tenant | The tenant that the delivery service is assigned to. |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| Origin | The Origin Server's base URL. This includes the protocol (http or https). Example: ``http://movies.origin.com`` |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| Active | When this is set to false, Traffic Router will not serve DNS or HTTP responses for this delivery service. |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| Type | The type of content routing this delivery service will use. See :ref:`rl-ds-types`. |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| Protocol | The protocol to serve this delivery service to the clients with: |
+| | |
+| | - HTTP |
+| | - HTTPS |
+| | - HTTP and HTTPS |
+| | - HTTP to HTTPS |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| CDN | The CDN that the delivery service belongs to. |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| IPv6 Enabled | When set to true, the Traffic Router will respond to AAAA DNS requests for the routed name of this delivery service. |
+| | Otherwise, only A records will be served. |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| DSCP | The DSCP value to mark IP packets to the client with. |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| Signing Algorithm | See :ref:`rl-signed-urls`. |
+| | - None |
+| | - URL Signature Keys |
+| | - URI Signing Keys |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| Query String Handling | How to treat query strings: |
+| | |
+| | - use in cache key and hand up to origin (each unique query string is treated as a unique URL.) |
+| | - do not use in cache key, but pass up to origin (2 URLs that are the same except for the query string will match, |
+| | and cache HIT, while the origin still sees original query string in the request.) |
+| | - drop at edge (2 URLs that are the same except for the query string will match, and cache HIT, while the origin |
+| | will not see original query string in the request.) |
+| | |
+| | Dropping query strings at the edge will preclude the use of a Regex Remap Expression. See :ref:`rl-regex-remap`. |
+| | |
+| | To set the qstring without the use of regex remap, or for further options, see :ref:`rl-qstring-handling`. |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+| Last Updated | Timestamp when the delivery service was last updated. |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
+
+Delivery service management includes the ability to (where applicable):
+
+- create a new delivery service
+- clone an existing delivery service
+- update an existing delivery service
+- delete an existing delivery service
+- compare delivery services
+- manage delivery service SSL keys
+- manage delivery service URL signature keys
+- manage delivery service URI signing keys
+- view and assign delivery service servers
+- create, update and delete delivery service regexes
+- view and create delivery service invalidate content jobs
+- manage steering targets
+
+
+.. _tp-delivery-service-requests:
+
+Delivery Service Requests
++++++++++++++++++++++++++
+
+A table of your delivery service requests with the following columns:
+
+.. image:: ./images/tp_table_ds_requests.png
+
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+======================================================================================================================+
+| Delivery Service | A unique string that identifies the delivery service that the request is associated with. |
+| | This unique string is also known as delivery service key or XML ID. |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Type | The type of delivery service request: |
+| | |
+| | - create (a request to create a new delivery service) |
+| | - update (a request to update an existing delivery service) |
+| | - delete (a request to delete an existing delivery service) |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Status | The status of the delivery service request: |
+| | |
+| | - draft (the delivery service request is NOT ready for review and fulfillment) |
+| | - submitted (the delivery service request is ready for review and fulfillment) |
+| | - rejected (the delivery service request has been rejected and cannot be modified) |
+| | - pending (the delivery service request has been fulfilled but the changes have yet to be deployed) |
+| | - complete (the delivery service request has been fulfilled and the changes have been deployed) |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Author | The user responsible for creating the delivery service request. |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Assignee | The user responsible for fulfilling the delivery service request. Currently, the operations role or above is |
+| | required to assign delivery service requests. |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Last Edited By | The last user to edit the delivery service request. |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Created | Relative time indicating when the delivery service was created. |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Actions | Actions that can be performed on a delivery service request: |
+| | |
+| | - fulfill (Implement the changes captured in the delivery service request.) |
+| | - reject (Reject the changes captured in the delivery service request.) |
+| | - delete (Delete the delivery service request.) |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+
+Delivery service request management includes the ability to (where applicable):
+
+- create a new delivery service request
+- update an existing delivery service request
+- delete an existing delivery service request
+- update the status of a delivery service request
+- assign a delivery service request
+- reject a delivery service request
+- fulfill a delivery service request
+- complete a delivery service request
+
+See :ref:`ds_requests` for details.
+
+Configure
+=========
+
+.. image:: ./images/tp_menu_configure.png
+
+.. _tp-servers:
+
+Servers
++++++++
+
+A table of servers with the following columns:
+
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+======================================================================================================================+
+| UPD | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Host | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Domain | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| IP | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| IPv6 | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Status | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Type | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Profile | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| CDN | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Cache Group | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| ISO | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+
+Server management includes the ability to (where applicable):
+
+- create a new server
+- update an existing server
+- delete an existing server
+- queue/clear updates on a server
+- update server status
+- view server delivery services
+- view server config files
+- clone delivery service assignments
+- assign delivery services to server
+
+.. _tp-profiles:
+
+Profiles
+++++++++
+
+A table of profiles with the following columns:
+
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+======================================================================================================================+
+| Name | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Type | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Routing Disabled | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Description | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| CDN | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+
+Profile management includes the ability to (where applicable):
+
+- create a new profile
+- update an existing profile
+- delete an existing profile
+- clone a profile
+- export a profile
+- view profile parameters
+- view profile delivery services
+- view profile servers
+
+See :ref:`rl-working-with-profiles` for details.
+
+.. _tp-parameters:
+
+Parameters
+++++++++++
+
+A table of parameters with the following columns:
+
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+======================================================================================================================+
+| Name | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Config File | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Value | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+
+Parameter management includes the ability to (where applicable):
+
+- create a new parameter
+- update an existing parameter
+- delete an existing parameter
+- view parameter profiles
+
+.. _tp-types:
+
+Types
++++++
+
+A table of types with the following columns:
+
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+======================================================================================================================+
+| Name | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Use In Table | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+| Description | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------------+
+
+Type management includes the ability to (where applicable):
+
+- create a new type
+- update an existing type
+- delete an existing type
+- view delivery services assigned to a type
+- view servers assigned to a type
+- view cache groups assigned to a type
+
+.. _tp-statuses:
+
+Statuses
+++++++++
+
+A table of statuses with the following columns:
+
++-------------------------------+---------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+=====================================================================================================================+
+| Name | |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------+
+| Description | |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------+
+
+Status management includes the ability to (where applicable):
+
+- create a new status
+- update an existing status
+- delete an existing status
+- view status servers
+
+Topology
+========
+
+.. image:: ./images/tp_menu_topology.png
+
+.. _tp-cache-groups:
+
+Cache Groups
+++++++++++++
+
+A table of cache groups with the following columns:
+
++-------------------------------+---------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+=====================================================================================================================+
+| Name | |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------+
+| Short Name | |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------+
+| Type | |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------+
+| Latitude | |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------+
+| Longitude | |
++-------------------------------+---------------------------------------------------------------------------------------------------------------------+
+
+Cache group management includes the ability to (where applicable):
+
+- create a new cache group
+- update an existing cache group
+- delete an existing cache group
+- queue/clear updates for all servers in a cache group
+- view cache group ASNs
+- view and assign cache group parameters
+- view cache group servers
+
+.. _tp-phys-locations:
+
+Phys Locations
+++++++++++++++
+
+A table of physical locations with the following columns:
+
++-------------------------------+-------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+===================================================================================================================+
+| Name | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------------+
+| Short Name | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------------+
+| Address | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------------+
+| City | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------------+
+| State | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------------+
+| Region | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------------+
+
+Physical location management includes the ability to (where applicable):
+
+- create a new physical location
+- update an existing physical location
+- delete an existing physical location
+- view physical location servers
+
+.. _tp-divisions:
+
+Divisions
++++++++++
+
+A table of divisions with the following columns:
+
++-------------------------------+-------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+===================================================================================================================+
+| Name | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------------+
+
+Division management includes the ability to (where applicable):
+
+- create a new division
+- update an existing division
+- delete an existing division
+- view division regions
+
+.. _tp-regions:
+
+Regions
++++++++
+
+A table of regions with the following columns:
+
++-------------------------------+------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+==================================================================================================================+
+| Name | |
++-------------------------------+------------------------------------------------------------------------------------------------------------------+
+| Division | |
++-------------------------------+------------------------------------------------------------------------------------------------------------------+
+
+Region management includes the ability to (where applicable):
+
+- create a new region
+- update an existing region
+- delete an existing region
+- view region physical locations
+
+.. _tp-asns:
+
+ASNs
+++++
+
+A table of ASNs with the following columns:
+
++-------------------------------+-----------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+=================================================================================================================+
+| ASN | |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------+
+| Cache Group | |
++-------------------------------+-----------------------------------------------------------------------------------------------------------------+
+
+ASN management includes the ability to (where applicable):
+
+- create a new ASN
+- update an existing ASN
+- delete an existing ASN
+
+Tools
+=====
+
+.. image:: ./images/tp_menu_tools.png
+
+.. _tp-jobs:
+
+Invalidate Content
+++++++++++++++++++
+
+A table of invalidate content jobs with the following columns:
+
++-------------------------------+----------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+================================================================================================================+
+| Delivery Service | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------+
+| Asset URL | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------+
+| Parameters | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------+
+| Start | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------+
+| Created By | |
++-------------------------------+----------------------------------------------------------------------------------------------------------------+
+
+Invalidate content includes the ability to (where applicable):
+
+- create a new invalidate content job
+
+.. _tp-gen-iso:
+
+Generate ISO
+++++++++++++
+
+See :ref:`rl-generate-iso`
+
+User Admin
+==========
+
+.. image:: ./images/tp_menu_user_admin.png
+
+.. _tp-users:
+
+Users
++++++
+
+A table of users with the following columns:
+
++-------------------------------+--------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+==============================================================================================================+
+| Full Name | |
++-------------------------------+--------------------------------------------------------------------------------------------------------------+
+| Username | |
++-------------------------------+--------------------------------------------------------------------------------------------------------------+
+| Email | |
++-------------------------------+--------------------------------------------------------------------------------------------------------------+
+| Tenant | |
++-------------------------------+--------------------------------------------------------------------------------------------------------------+
+| Role | |
++-------------------------------+--------------------------------------------------------------------------------------------------------------+
+
+User management includes the ability to (where applicable):
+
+- register a new user
+- create a new user
+- update an existing user
+- view delivery services visible to a user
+
+.. _tp-tenants:
+
+Tenants
++++++++
+
+A table of tenants with the following columns:
+
++-------------------------------+-------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+=============================================================================================================+
+| Name | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------+
+| Active | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------+
+| Parent | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------+
+
+Tenant management includes the ability to (where applicable):
+
+- create a new tenant
+- update an existing tenant
+- delete an existing tenant
+- view users assigned to a tenant
+- view delivery services assigned to a tenant
+
+.. _tp-roles:
+
+Roles
++++++
+
+A table of roles with the following columns:
+
++-------------------------------+-------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++===============================+=============================================================================================================+
+| Name | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------+
+| Privilege Level | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------+
+| Description | |
++-------------------------------+-------------------------------------------------------------------------------------------------------------+
+
+Role management includes the ability to (where applicable):
+
+- view all roles
+
+Other
+=====
+
+.. image:: ./images/tp_menu_other.png
+
+.. _tp-menu-other:
+
+Custom Menu Items
++++++++++++++++++
+
+This section is configurable in tp.domain.com/traffic_portal_properties.json in the customMenu section.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/latest/_sources/admin/traffic_router.rst.txt b/docs/latest/_sources/admin/traffic_router.rst.txt
new file mode 100644
index 0000000..b8ed3ba
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_router.rst.txt
@@ -0,0 +1,588 @@
+..
+..
+.. 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.
+..
+
+*****************************
+Traffic Router Administration
+*****************************
+.. contents::
+ :depth: 2
+ :backlinks: top
+
+Installing Traffic Router
+==========================
+The following are requirements to ensure an accurate set up:
+
+* CentOS 6
+* 4 vCPUs
+* 8GB RAM
+* Successful install of Traffic Ops
+* Successful install of Traffic Monitor
+* Administrative access to Traffic Ops
+
+.. Note:: Hardware requirements are generally doubled if DNSSEC is enabled
+
+1. If no suitable profile exists, create a new profile for Traffic Router.
+
+2. Enter the Traffic Router server into Traffic Ops, assign it to a Traffic Router profile, and ensure that its status is set to ``ONLINE``.
+3. Ensure the FQDN of the Traffic Router is resolvable in DNS. This FQDN must be resolvable by the clients expected to use this CDN.
+4. Install a traffic router: ``sudo yum install traffic_router``.
+5. Edit ``/opt/traffic_router/conf/traffic_monitor.properties`` and specify the correct online Traffic Monitor(s) for your CDN. See :ref:`rl-tr-config-files`
+ # traffic_monitor.properties: url that should normally point to this file
+ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.properties
+
+ # Frequency for reloading this file
+ # traffic_monitor.properties.reload.period=60000
+
+
+6. Start Tomcat: ``sudo service tomcat start``, and test lookups with dig and curl against that server.
+ To restart, ``sudo service tomcat stop``, kill the traffic router process, and ``sudo service tomcat start``
+ Also, crconfig previously recieved will be cached, and needs to be removed manually to actually be reloaded /opt/traffic_router/db/cr-config.json
+7. Snapshot CRConfig; See :ref:`rl-snapshot-crconfig`
+
+.. Note:: Once the CRConfig is snapshotted, live traffic will be sent to the new Traffic Routers provided that their status is set to ``ONLINE``.
+
+8. Ensure that the parent domain (e.g.: kabletown.net) for the CDN's top level domain (e.g.: cdn.kabletown.net) contains a delegation (NS records) for the new Traffic Router, and that the value specified matches the FQDN used in step 3.
+
+Configuring Traffic Router
+==========================
+
+.. Note:: Starting with Traffic Router 1.5, many of the configuration files under ``/opt/traffic_router/conf`` are only needed to override the default configuration values for Traffic Router. Most of the given default values will work well for any CDN. Critical values that must be changed are hostnames and credentials for communicating with other Traffic Control components such as Traffic Ops and Traffic Monitor.
+
+.. Note:: Pre-existing installations having configuration files in ``/opt/traffic_router/conf`` will still be used and honored for Traffic Router 1.5 and onward.
+
+For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See :ref:`rl-snapshot-crconfig` for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under :ref:`rl-ccr-profile` for parameters that influence the behavior of Traffic Router via the CRConfig.
+
+.. _rl-tr-config-files:
+
+Configuration files
+-------------------
+
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| File name | Parameter | Description | Default Value |
++============================+===========================================+=====================================================================================================+===================================================+
+| traffic_monitor.properties | traffic_monitor.bootstrap.hosts | Traffic Monitor FQDNs and port if necessary, separated by a semicolon (;) | N/A |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | traffic_monitor.bootstrap.local | Use only the Traffic Monitors specified in config file | false |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | traffic_monitor.properties | Path to the traffic_monitor.properties file; used internally to monitor the file for changes | /opt/traffic_router/traffic_monitor.properties |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | traffic_monitor.properties.reload.period | The interval in milliseconds which Traffic Router will reload this configuration file | 60000 |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| dns.properties | dns.tcp.port | TCP port that Traffic Router will use for incoming DNS requests | 53 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | dns.tcp.backlog | Maximum length of the queue for incoming TCP connection requests | 0 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | dns.udp.port | UDP port that Traffic Router will use for incoming DNS requests | 53 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | dns.max-threads | Maximum number of threads used to process incoming DNS requests | 1000 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | dns.zones.dir | Path to auto generated zone files for reference | /opt/traffic_router/var/auto-zones |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| traffic_ops.properties | traffic_ops.username | Username to access the APIs in Traffic Ops (must be in the admin role) | admin |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | traffic_ops.password | Password for the user specified in traffic_ops.username | N/A |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| cache.properties | cache.geolocation.database | Full path to the local copy of the MaxMind geolocation binary database file | /opt/traffic_router/db/GeoIP2-City.mmdb |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.geolocation.database.refresh.period | The interval in milliseconds which Traffic Router will poll for a new geolocation database | 604800000 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.czmap.database | Full path to the local copy of the coverage zone file | /opt/traffic_router/db/czmap.json |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.czmap.database.refresh.period | The interval in milliseconds which Traffic Router will poll for a new coverage zone file | 10800000 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.dczmap.database | Full path to the local copy of the deep coverage zone file | /opt/traffic_router/db/dczmap.json |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.dczmap.database.refresh.period | The interval in milliseconds which Traffic Router will poll for a new deep coverage zone file | 10800000 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.health.json | Full path to the local copy of the health state | /opt/traffic_router/db/health.json |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.health.json.refresh.period | The interval in milliseconds which Traffic Router will poll for a new health state file | 1000 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.config.json | Full path to the local copy of the CRConfig | /opt/traffic_router/db/cr-config.json |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.config.json.refresh.period | The interval in milliseconds which Traffic Router will poll for a new CRConfig | 60000 |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| log4j.properties | various parameters | Configuration of log4j is documented on their site; adjust as necessary based on needs | N/A |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+
+.. _rl-tr-dnssec:
+
+DNSSEC
+======
+
+Overview
+--------
+Domain Name System Security Extensions (DNSSEC) is a set of extensions to DNS that provides a cryptographic mechanism for resolvers to verify the authenticity of responses served by an authoritative DNS server.
+
+Several RFCs (4033, 4044, 4045) describe the low level details and define the extensions, RFC 7129 provides clarification around authenticated denial of existence of records, and finally RFC 6781 describes operational best practices for administering an authoritative DNSSEC enabled DNS server. The authenticated denial of existence RFC describes how an authoritative DNS server responds in NXDOMAIN and NODATA scenarios when DNSSEC is enabled.
+
+Traffic Router currently supports DNSSEC with NSEC, however, NSEC3 and more configurable options will be provided in the future.
+
+Operation
+---------
+Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN's top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the :ref:`rl-ccr-profile` documentation for more information.
+
+Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service's zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD's zone. A DS record is generated from each zone's KSK and is placed in the CDN TLD's zone (e.g.: cdn.kabletown.net); the DS record for the CDN TLD must be placed in its parent zone, which is not managed by Traffic Control.
+
+The DNSKEY to DS record relationship allows resolvers to validate signatures across zone delegation points; with Traffic Control, we control all delegation points below the CDN's TLD, **however, the DS record for the CDN TLD must be placed in the parent zone (e.g.: kabletown.net), which is not managed by Traffic Control**. As such, the DS record (available in the Traffic Ops DNSSEC administration UI) must be placed in the parent zone prior to enabling DNSSEC, and prior to generating a new CDN KSK. Based on your deployment's DNS configuration, this might be a manual process or it might be automated; either way, extreme care and diligence must be taken and knowledge of the management of the upstream zone is imperative for a successful DNSSEC deployment.
+
+Rolling Zone Signing Keys
+-------------------------
+Traffic Router currently follows the zone signing key pre-publishing operational best practice described in `section 4.1.1.1 of RFC 6781`_. Once DNSSEC is enabled for a CDN in Traffic Ops, key rolls are triggered via Traffic Ops via the automated key generation process, and Traffic Router selects the active zone signing keys based on the expiration information returned from the keystore API in Traffic Ops.
+
+.. _section 4.1.1.1 of RFC 6781: https://tools.ietf.org/html/rfc6781#section-4.1.1.1
+
+Troubleshooting and log files
+=============================
+Traffic Router log files are in ``/opt/traffic_router/var/log``, and Tomcat log files are in ``/opt/tomcat/logs``. Application related logging is in ``/opt/traffic_router/var/log/traffic_router.log``, while access logs are written to ``/opt/traffic_router/var/log/access.log``.
+
+Event Log File Format
+=====================
+
+Summary
+-------
+
+All access events to Traffic Router are logged to the file ``/opt/traffic_router/var/log/access.log``
+This file grows up to 200Mb and gets rolled into older log files, 10 log files total are kept (total of up to 2Gb of logged events per traffic router)
+
+Traffic Router logs access events in a format that largely following `ATS event logging format
+<https://docs.trafficserver.apache.org/en/6.0.x/admin/event-logging-formats.en.html>`_
+
+--------------
+
+Sample Message
+--------------
+
+Items within brackets below are detailed under the HTTP and DNS sections
+::
+
+ 144140678.000 qtype=DNS chi=192.168.10.11 ttms=789 [Fields Specific to the DNS request] rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the DNS result]
+ 144140678.000 qtype=HTTP chi=192.168.10.11 ttms=789 [Fields Specific to the HTTP request] rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the HTTP result]
+
+.. Note:: The above message samples contain fields that are always present for every single access event to Traffic Router
+
+**Message Format**
+- Each event that is logged is a series of space separated key value pairs except for the first item.
+- The first item is always the epoch in seconds with a decimal field precision of up to milliseconds
+- Each key value pair is in the form of unquoted string, equals character, optionally quoted string
+- Values that are quoted strings may contain space characters
+- Values that are not quoted should not contains any space characters
+
+.. Note:: Any value that is a single dash character or a dash character enclosed in quotes represents an empty value
+
+--------
+
+Fields Always Present
+---------------------
+
++------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
+|Name |Description |Data |
++======+=================================================================================+====================================================================================+
+|qtype |Whether the request was for DNS or HTTP |Always DNS or HTTP |
++------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
+|chi |The IP address of the requester |Depends on whether this was a DNS or HTTP request, see below sections |
++------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
+|ttms |The amount of time in milliseconds it took Traffic Router to process the request |A number greater than or equal to zero |
++------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
+|rtype |Routing Result Type |One of ERROR, CZ, DEEP_CZ, GEO, MISS, STATIC_ROUTE, DS_REDIRECT, DS_MISS, INIT, FED |
++------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
+|rloc |GeoLocation of result |Latitude and Longitude in Decimal Degrees |
++------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
+|rdtl |Result Details Associated with unusual conditions |One of DS_NOT_FOUND, DS_NO_BYPASS, DS_BYPASS, DS_CZ_ONLY, DS_CZ_BACKUP_CG |
++------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
+|rerr |Message about internal Traffic Router Error |String |
++------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
+
+
+**rtype meanings**
+
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|Name |Meaning |
++=============+========================================================================================================================================================================+
+|ERROR |An internal error occurred within Traffic Router, more details may be found in the rerr field |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|CZ |The result was derived from Coverage Zone data based on the address in the chi field |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|DEEP_CZ |The result was derived from Deep Coverage Zone data based on the address in the chi field |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|GEO |The result was derived from geolocation service based on the address in the chi field |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|MISS |Traffic Router was unable to resolve a DNS request or find a cache for the requested resource |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|STATIC_ROUTE |_*DNS Only*_ No DNS Delivery Service supports the hostname portion of the requested url |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_MISS |_*HTTP Only*_ No HTTP Delivery Service supports either this request's URL path or headers |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_REDIRECT |The result is using the Bypass Destination configured for the matched Delivery Service when that Delivery Service is unavailable or does not have the requested resource|
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|FED |_*DNS Only*_ The result was obtained through federated coverage zone data outside of any delivery service |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|GEO_REDIRECT |The request was redirected (302) based on the National Geo blocking (Geo Limit Redirect URL) configured on the Delivery Service. |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|RGALT |The request was redirected (302) to the Regional Geo blocking URL. Regional Geo blocking is enabled on the Delivery Service and is configured through the |
+| |regional_geoblock.polling.url setting for the Traffic Router profile. |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|RGDENY |_*DNS Only*_ The result was obtained through federated coverage zone data outside of any delivery service The request was regionally blocked because there was no rule |
+| |for the request made. |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| "-" |The request was not redirected. This is usually a result of a DNS request to the Traffic Router or an explicit denial for that request. |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+
+**rdtl meanings**
+
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|Name |Meaning |
++=======================================+============================================================================================================================================+
+|DS_NOT_FOUND |Always goes with rtypes STATIC_ROUTE and DS_MISS |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_BYPASS |Used Bypass Destination for Redirect of Delivery Service |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_NO_BYPASS |No valid Bypass Destination is configured for the matched Delivery Service and the delivery service does not have the requested resource |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_CZ_ONLY |The selected Delivery Service only supports resource lookup based on Coverage Zone data |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_CLIENT_GEO_UNSUPPORTED |Traffic Router did not find a resource supported by coverage zone data and was unable to determine the geolocation of the requesting client |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|GEO_NO_CACHE_FOUND |Traffic Router could not find a resource via geolocation data based on the requesting client's geolocation |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|NO_DETAILS |This entry is for a standard request. |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|REGIONAL_GEO_ALTERNATE_WITHOUT_CACHE |This goes with the rtype RGDENY. The URL is being regionally Geo blocked. |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|REGIONAL_GEO_NO_RULE |The request was blocked because there was no rule in the Delivery Service for the request. |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| "-" |The request was not redirected. This is usually a result of a DNS request to the Traffic Router or an explicit denial for that request. |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_CZ_BACKUP_CG |Traffic Router found a backup cache via fallback (cr-config's edgeLocation) / coordinates (CZF) configuration |
++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+
+
+---------------
+
+HTTP Specifics
+--------------
+
+Sample Message
+::
+
+ 1452197640.936 qtype=HTTP chi=69.241.53.218 url="http://foo.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" pssc=302 ttms=0 rurl="http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8" rh="Accept: */*" rh="myheader: asdasdasdasfasg"
+
+**Request Fields**
+
++-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
+|Name |Description |Data |
++=====+=========================================================================================================================================+===========================================+
+|url |Requested URL with query string |String |
++-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
+|cqhm |Http Method |e.g GET, POST |
++-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
+|cqhv |Http Protocol Version |e.g. HTTP/1.1 |
++-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
+|rh |One or more of these key value pairs may exist in a logged event and are controlled by the configuration of the matched Delivery Service |Key value pair of the format "name: value" |
++-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
+
+**Response Fields**
+
++-----+----------------------------------------------------------+------------+
+|Name |Description |Data |
++=====+==========================================================+============+
+|rurl |The resulting url of the resource requested by the client |A URL String|
++-----+----------------------------------------------------------+------------+
+
+------------
+
+DNS Specifics
+-------------
+
+Sample Message
+::
+
+ 144140678.000 qtype=DNS chi=192.168.10.11 ttms=123 xn=65535 fqdn=www.example.com. type=A class=IN ttl=12345 rcode=NOERROR rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" ans="192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"
+
+**Request Fields**
+
+.. _qname: http://www.zytrax.com/books/dns/ch15/#qname
+
+.. _qtype: http://www.zytrax.com/books/dns/ch15/#qtype
+
++------+------------------------------------------------------------------+--------------------------------------------------------+
+|Name |Description |Data |
++======+==================================================================+========================================================+
+|xn |The ID from the client DNS request header |a number from 0 to 65535 |
++------+------------------------------------------------------------------+--------------------------------------------------------+
+|fqdn |The qname field from the client DNS request message (i.e. The |A series of DNS labels/domains separated by '.' |
+| |fully qualified domain name the client is requesting be resolved) |characters and ending with a '.' character (see qname_) |
++------+------------------------------------------------------------------+--------------------------------------------------------+
+|type |The qtype field from the client DNS request message (i.e. |Examples are A (IpV4), AAAA (IpV6), NS (Name Service), |
+| |the type of resolution that's requested such as IPv4, IPv6) | SOA (Start of Authority), and CNAME, (see qtype_) |
++------+------------------------------------------------------------------+--------------------------------------------------------+
+|class |The qclass field from the client DNS request message (i.e. The |Either IN (Internet resource) or ANY (Traffic router |
+| |class of resource being requested) | rejects requests with any other value of class) |
++------+------------------------------------------------------------------+--------------------------------------------------------+
+
+**Response Fields**
+
++------+---------------------------------------------------------------------+-----------------------------------------------------+
+|Name | Description | Data |
++======+=====================================================================+=====================================================+
+|ttl | The 'time to live' in seconds for the answer provided by Traffic |A number from 0 to 4294967295 |
+| | Router (clients can reliably use this answer for this long without | |
+| | re-querying traffic router) | |
++------+---------------------------------------------------------------------+-----------------------------------------------------+
+|rcode | The result code for the DNS answer provided by Traffic Router | One of NOERROR (success), NOTIMP (request is not |
+| | | NOTIMP (request is not supported), |
+| | | REFUSED (request is refused to be answered), or |
+| | | NXDOMAIN (the domain/name requested does not exist) |
++------+---------------------------------------------------------------------+-----------------------------------------------------+
+
+.. _rl-tr-ngb:
+
+GeoLimit Failure Redirect feature
+=================================
+
+Overview
+--------
+This feature is also called 'National GeoBlock' feature which is short for 'NGB' feature. In this section, the acronym 'NGB' will be used for this feature.
+
+In the past, if the Geolimit check fails (for example, the client ip is not in the 'US' region but the geolimit is set to 'CZF + US'), the router will return 503 response; but with this feature, when the check fails, it will return 302 if the redirect url is set in the delivery service.
+
+The Geolimit check failure has such scenarios:
+1) When the GeoLimit is set to 'CZF + only', if the client ip is not in the the CZ file, the check fails
+2) When the GeoLimit is set to any region, like 'CZF + US', if the client ip is not in such region, and the client ip is not in the CZ file, the check fails
+
+
+Configuration
+-------------
+To enable the NGB feature, the DS must be configured with the proper redirect url. And the setting lays at 'Delivery Services'->Edit->'GeoLimit Redirect URL'. If no url is put in this field, the feature is disabled.
+
+The URL has 3 kinds of formats, which have different meanings:
+
+1. URL with no domain. If no domain is in the URL (like 'vod/dance.mp4'), the router will try to find a proper cache server within the delivery service and return the redirect url with the format like 'http://<cache server name>.<delivery service's FQDN>/<configured relative path>'
+
+2. URL with domain that matches with the delivery service. For this URL, the router will also try to find a proper cache server within the delivery service and return the same format url as point 1.
+
+3. URL with domain that doesn't match with the delivery service. For this URL, the router will return the configured url directly to the client.
+
+
+.. _rl-deep-cache:
+
+Deep Caching - Deep Coverage Zone Topology
+==========================================
+
+Overview
+--------
+
+Deep Caching is a feature that enables clients to be routed to the closest
+possible "deep" edge caches on a per Delivery Service basis. The term "deep" is
+used in the networking sense, meaning that the edge caches are located deep in
+the network where the number of network hops to a client is as minimal as
+possible. This deep caching topology is desirable because storing content closer
+to the client gives better bandwidth savings, and sometimes the cost of
+bandwidth usage in the network outweighs the cost of adding storage. While it
+may not be feasible to cache an entire copy of the CDN's contents in every deep
+location (for the best possible bandwidth savings), storing just a relatively
+small amount of the CDN's most requested content can lead to very high bandwidth
+savings.
+
+Getting started
+---------------
+
+What you need:
+
+#. Edge caches deployed in "deep" locations and registered in Traffic Ops
+#. A Deep Coverage Zone File (DCZF) mapping these deep cache hostnames to specific network prefixes (see :ref:`rl-deep-czf` for details)
+#. Deep caching parameters in the Traffic Router Profile (see :ref:`rl-ccr-profile` for details):
+
+ * ``deepcoveragezone.polling.interval``
+ * ``deepcoveragezone.polling.url``
+
+#. Deep Caching enabled on one or more HTTP Delivery Services (i.e. ``deepCachingType`` = ALWAYS)
+
+How it works
+------------
+
+Deep Coverage Zone routing is very similar to that of regular Coverage Zone
+routing, except that the DCZF is preferred over the regular CZF for Delivery
+Services with DC (Deep Caching) enabled. If the client requests a DC-enabled
+Delivery Service and their IP address gets a "hit" in the DCZF, Traffic Router
+will attempt to route that client to one of the available deep caches in the
+client's corresponding zone. If there are no deep caches available for a
+client's request, Traffic Router will "fall back" to the regular CZF and
+continue regular CZF routing from there.
+
+
+.. _rl-tr-steering:
+
+Steering feature
+================
+
+Overview
+--------
+A Steering delivery service is a delivery service that is used to "steer" traffic to other delivery services. A Steering delivery service will have target delivery services configured for it with weights assigned to them. Traffic Router uses the weights to make a consistent hash ring which it then uses to make sure that requests are routed to a target based on the configured weights. This consistent hash ring is separate from the consistent hash ring used in cache selection.
+
+Special regular expressions called Filters can also be configured for target delivery services to pin traffic to a specific delivery service. For example, if a filter called .*/news/.* for a target called target-ds-1 is created, any requests to traffic router with 'news' in them will be routed to target-ds-1. This will happen regardless of the configured weights.
+
+A client can bypass the steering functionality by providing a header called X-TC-Steering-Option with the xml_id of the target delivery service to route to. When Traffic Router receives this header it will route to the requested target delivery service regardless of weight configuration.
+
+Some other points of interest:
+
+- Steering is currently only available for HTTP delivery services that are a part of the same CDN.
+- A new role called STEERING has been added to the traffic ops database. Only users with Admin or Steering privileges can modify steering assignments for a Delivery Service.
+- A new API has been created in Traffic Ops under /internal. This API is used by a Steering user to add filters and modify assignments. (Filters can only be added via the API).
+- Traffic Router uses the steering API in Traffic Ops to poll for steering assignments, the assignments are then used when routing traffic.
+
+A couple simple use cases for steering are:
+
+#. Migrating traffic from one delivery service to another over time.
+#. Trying out new functionality for a subset of traffic with an experimental delivery service.
+#. Load balancing between delivery services.
+
+
+
+Configuration
+-------------
+
+The following needs to be completed for Steering to work correctly:
+
+#. Two target delivery services are created in Traffic Ops. They must both be HTTP delivery services part of the same CDN.
+#. A delivery service with type STEERING is created in Traffic Ops.
+#. Target delivery services are assigned to the steering delivery service using Traffic Ops.
+#. A user with the role of Steering is created.
+#. Using the API, the steering user assigns weights to the target delivery services.
+#. If desired, the steering user can create filters for the target delivery services.
+
+For more information see the `steering how-to guide <quick_howto/steering.html>`_.
+
+HTTPS for Http Type Delivery Services
+=====================================
+
+Starting with version 1.7 Traffic Router added the ability to allow https traffic between itself and clients on a per http type delivery service basis.
+
+.. Warning::
+ The establishing of an HTTPS connection is much more computationally demanding than an HTTP connection.
+ Since each client will in turn get redirected to ATS, Traffic Router is most always creating a new HTTPS connection for all HTTPS traffic.
+ It is likely to mean that an existing Traffic Router will have some decrease in performance depending on the amount of https traffic you want to support
+ As noted for DNSSEC, you may need to plan to scale Traffic Router vertically and/or horizontally to handle the new load
+
+The summary for setting up https is to:
+
+#. Select one of 'https', 'http and https', or 'http to https' for the delivery service
+#. Generate private keys for the delivery service using a wildcard domain such as ``*.my-delivery-service.my-cdn.example.com``
+#. Obtain and import signed certificate chain
+#. Snapshot CR Config
+
+Clients may make HTTPS requests delivery services only after Traffic Router receives the certificate chain from Traffic Ops and the new CR Config.
+
+Protocol Options
+----------------
+
+*https only*
+ Traffic Router will only redirect (send a 302) to clients communicating with a secure connection, all other clients will receive a 503
+*http and https*
+ Traffic Router will redirect both secure and non-secure clients
+*http to https*
+ Traffic Router will redirect non-secure clients with a 302 and a location that is secure (i.e. starting with 'https' instead of 'http'), secure clients will remain on https
+*http*
+ Any secure client will get an SSL handshake error. Non-secure clients will experience the same behavior as prior to 1.7
+
+Certificate Retrieval
+---------------------
+
+.. Warning::
+ If you have https delivery services in your CDN, Traffic Router will not accept **any** connections until it is able to
+ fetch certificates from Traffic Ops and load them into memory. Traffic Router does not persist certificates to the java keystore or anywhere else.
+
+Traffic Router fetches certificates into memory:
+
+* At startup time
+* When it receives a new CR Config
+* Once an hour from whenever the most recent of the last of the above occurred
+
+.. Note::
+ To adjust the frequency when Traffic Router fetches certificates add the parameter 'certificates.polling.interval' to CR Config and
+ setting it to the desired time in milliseconds.
+
+.. Note::
+ Taking a snapshot of CR Config may be used at times to avoid waiting the entire polling cycle for a new set of certificates.
+
+.. Warning::
+ If a snapshot of CR Config is made that involves a delivery service missing its certificates, Traffic Router will ignore **ALL** changes in that CR-Config
+ until one of the following occurs:
+ * It receives certificates for that delivery service
+ * Another snapshot of CR Config is created and the delivery service without certificates is changed so it's HTTP protocol is set to 'http'
+
+Certificate Chain Ordering
+--------------------------
+
+The ordering of certificates within the certificate bundle matters. It must be:
+
+#. Primary Certificate (e.g. the one created for ``*.my-delivery-service.my-cdn.example.com``)
+#. Intermediate Certificate(s)
+#. Root Certificate from CA (optional)
+
+.. Warning::
+ If something is wrong with the certificate chain (e.g. the order of the certificates is backwards or for the wrong domain) the
+ client will get an SSL handshake. Inspection of /opt/tomcat/logs/catalina.out is likely to yield information to reveal this.
+
+To see the ordering of certificates you may have to manually split up your certificate chain and use openssl on each individual certificate
+
+Suggested Way of Setting up an HTTPS Delivery Service
+-----------------------------------------------------
+
+Do the following in Traffic Ops:
+
+#. Select one of 'https', 'http and https', or 'http to https' for the protocol field of a delivery service and click 'Save'.
+#. Click 'Manage SSL Keys'.
+#. Click 'Generate New Keys'.
+#. Copy the contents of the Certificate Signing Request field and save it locally.
+#. Click 'Load Keys'.
+#. Select 'http' for the protocol field of the delivery service and click 'Save' (to avoid preventing other CR Config updates from being blocked by Traffic Router)
+#. Follow your standard procedure for obtaining your signed certificate chain from a CA.
+#. After receiving your certificate chain import it into Traffic Ops.
+#. Edit the delivery service.
+#. Restore your original choice for the protocol field and click save.
+#. Click 'Manage SSL Keys'.
+#. Click 'Paste Existing Keys'.
+#. Paste the certificate chain into the CRT field.
+#. Click 'Load Keys'.
+#. Take a new snapshot of CR Config.
+
+Once this is done you should be able to test you are getting correctly redirected by Traffic Router using curl commands to https destinations on your delivery service.
+
+A new testing tool was created for load testing traffic router, it allows you to generate requests from your local box to multiple delivery services of a single cdn.
+You can control which cdn, delivery services, how many transactions per delivery service, and how many concurrent requests.
+During the test it will provide feedback about request latency and transactions per second.
+
+While it is running it is suggested that you monitor your Traffic Router nodes for memory and CPU utilization.
+
+Tuning Recommendations
+======================
+
+The following is an example of /opt/tomcat/bin/setenv.sh that has been tested on a multi core server running under HTTPS load test requests.
+This is following the general recommendation to use the G1 garbage collector for JVM applications running on multi core machines.
+In addition to using the G1 garbage collector the InitiatingHeapOccupancyPercent was lowered to run garbage collection more frequently which
+improved overall throughput for Traffic Router and reduced 'Stop the World' garbage collection. Note that setting the min and max heap settings
+in setenv.sh will override init scripts in /etc/init.d/tomcat.
+
+ /opt/tomcat/bin/setenv.sh::
+
+
+ #! /bin/sh
+ export CATALINA_OPTS="$CATALINA_OPTS -server"
+ export CATALINA_OPTS="$CATALINA_OPTS -Xms2g -Xmx2g"
+ export CATALINA_OPTS="$CATALINA_OPTS -XX:+UseG1GC"
+ export CATALINA_OPTS="$CATALINA_OPTS -XX:+UnlockExperimentalVMOptions"
+ export CATALINA_OPTS="$CATALINA_OPTS -XX:InitiatingHeapOccupancyPercent=30"
diff --git a/docs/latest/_sources/admin/traffic_server.rst.txt b/docs/latest/_sources/admin/traffic_server.rst.txt
new file mode 100644
index 0000000..828cb47
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_server.rst.txt
@@ -0,0 +1,149 @@
+..
+..
+.. 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.
+..
+
+*****************************
+Traffic Server Administration
+*****************************
+Installing Traffic Server
+=========================
+
+#. Build the Traffic Server RPM. The best way to do this is to follow the Traffic Server documents: ::
+
+ https://docs.trafficserver.apache.org/en/latest/getting-started/index.en.html#installation
+
+#. Build the astats RPM using the appropriate version number: ::
+
+ https://github.com/apache/incubator-trafficcontrol/tree/<version>/traffic_server
+
+ Sample link: ::
+
+ https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_server
+
+#. Install Traffic Server and astats: ::
+
+ sudo yum -y install trafficserver-*.rpm astats_over_http*.rpm
+
+#. Add the server using the Traffic Ops web interface:
+
+ #. Select **Servers**.
+ #. Scroll to the bottom of the page and click **Add Server**.
+ #. Complete the "Required Info:" section:
+ * Set 'Interface Name' to the name of the interface from which traffic server delivers content.
+ * Set 'Type' to 'MID' or 'EDGE'.
+ #. Click **Submit**.
+ #. Click **Save**.
+ #. Click **Online Server**.
+ #. Verify that the server status is now listed as **Reported**
+
+#. Install the ORT script and run it in 'badass' mode to create the initial configuration, see :ref:`reference-traffic-ops-ort`
+
+#. Start the service: ``sudo service trafficserver start``
+
+#. Configure traffic server to start automatically: ``sudo systemctl enable trafficserver``
+
+#. Verify that the installation is good:
+
+ #. Make sure that the service is running: ``sudo systemctl status trafficserver``
+
+ #. Assuming a traffic monitor is already installed, browse to it, i.e. http://<trafficmonitorURL>, and verify that the traffic server appears in the "Cache States" table, in white.
+
+
+.. _reference-traffic-ops-ort:
+
+Configuring Traffic Server
+==========================
+All of the Traffic Server application configuration files are generated by Traffic Ops and installed by way of the traffic_ops_ort.pl script.
+The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do the initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below: ::
+
+ $ sudo /opt/ort/traffic_ops_ort.pl
+ ====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
+ Usage: ./traffic_ops_ort.pl <Mode> <Log_Level> <Traffic_Ops_URL> <Traffic_Ops_Login> [optional flags]
+ <Mode> = interactive - asks questions during config process.
+ <Mode> = report - prints config differences and exits.
+ <Mode> = badass - attempts to fix all config differences that it can.
+ <Mode> = syncds - syncs delivery services with what is configured in Traffic Ops.
+ <Mode> = revalidate - checks for updated revalidations in Traffic Ops and applies them. Requires Traffic Ops 2.1.
+
+ <Log_Level> => ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, NONE
+
+ <Traffic_Ops_URL> = URL to Traffic Ops host. Example: https://trafficops.company.net
+
+ <Traffic_Ops_Login> => Example: 'username:password'
+
+ [optional flags]:
+ dispersion=<time> => wait a random number between 0 and <time> before starting. Default = 300.
+ login_dispersion=<time> => wait a random number between 0 and <time> before login. Default = 0.
+ retries=<number> => retry connection to Traffic Ops URL <number> times. Default = 3.
+ wait_for_parents=<0|1> => do not update if parent_pending = 1 in the update json. Default = 1, wait for parents.
+ ====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
+ $
+
+Installing the ORT script
+--------------------------
+
+#. Build the ORT script RPM from the Apache Build Server and install it: ::
+
+ https://builds.apache.org/view/S-Z/view/TrafficControl/
+
+ Sample command: ::
+
+ sudo wget https://builds.apache.org/view/S-Z/view/TrafficControl/job/incubator-trafficcontrol-2.1.x-build/lastSuccessfulBuild/artifact/dist/traffic_ops_ort-2.1.0-6807.1dcd512f.el7.x86_64.rpm
+ sudo yum install traffic_ops_ort*.rpm
+
+#. Install modules required by ORT if needed: ``sudo yum -y install perl-JSON perl-Crypt-SSLeay``
+
+#. For initial configuration or when major changes (like a Profile change) need to be made, run the script in "badass mode". All required rpm packages
+ will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted.
+
+ Example run below: ::
+
+ $ sudo /opt/ort/traffic_ops_ort.pl --dispersion=0 badass warn https://ops.$tcDomain admin:admin123
+
+ .. Note:: First run gives a lot of state errors that are expected. The "badass" mode fixes these issue s. Run it a second time, this should be cleaner.
+ Also, note that many ERROR messages emitted by ORT are actually information messages. Do not panic.
+
+#. Create a cron entry for running ort in 'syncds' mode every 15 minutes.
+ This makes traffic control check periodically if 'Queue Updates' was run on Traffic Ops, and it so, get the updated configuration.
+
+ Run ``sudo crontab -e`` and add the following line ::
+
+ */15 * * * * /opt/ort/traffic_ops_ort.pl syncds warn https://traffops.kabletown.net admin:password --login_dispersion=30 --dispersion=180 > /tmp/ort/syncds.log 2>&1
+
+ Changing ``https://traffops.kabletown.net``, ``admin``, and ``password`` to your CDN URL and credentials.
+
+ .. Note:: By default, running ort on an edge traffic server waits for it's parent (mid) servers to download their configuration before
+ it downloads it's own configuration. Because of this, scheduling ort for running every 15 minutes (with 5 minutes default dispersion) means
+ that it might take up to ~35 minutes for a "Queue Updates" operation to affect all traffic servers. To customize this dispersion time, use
+ the command line option --dispersion=x where x is the number of seconds for the dispersion period. Servers will select a random number from
+ within this dispersion period to being pulling down configuration files from Traffic Ops. Another option, --login_dispersion=x can be used.
+ This option creates a dispersion period after the job begins during which ORT will wait before logging in and checking Traffic Ops for updates
+ to the server. This defaults to 0. If use_reval_pending, a.k.a. Rapid Revalidate is enabled, edges will NOT wait for their parents to download
+ their configuration before downloading their own.
+
+ .. Note:: In 'syncds' mode, the ort script updates only configurations that might be changed as part of normal operations, such as:
+
+ * Delivery Services
+ * SSL certificates
+ * Traffic Monitor IP addresses
+ * Logging configuration
+ * Revalidation requests (By default. If Rapid Revalidate is enabled, this will only be checked by using a separate revalidate command in ORT.)
+
+
+#. If Rapid Revalidate is enabled in Traffic Ops, create a second cron job for revalidation checks. ORT will not check revalidation files if Rapid Revalidate
+ is enabled. This setting allows for a separate check to be performed every 60 seconds to verify if a revalidation update has been made.
+
+ Run ``sudo crontab -e`` and add the following line ::
+
+ */1 * * * * /opt/ort/traffic_ops_ort.pl revalidate warn https://traffops.kabletown.net admin:password --login_dispersion=30 > /tmp/ort/syncds.log 2>&1
diff --git a/docs/latest/_sources/admin/traffic_stats.rst.txt b/docs/latest/_sources/admin/traffic_stats.rst.txt
new file mode 100644
index 0000000..a1d20b3
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_stats.rst.txt
@@ -0,0 +1,188 @@
+..
+..
+.. 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.
+..
+
+****************************
+Traffic Stats Administration
+****************************
+
+Traffic Stats consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.
+
+Installation
+========================
+
+**Installing Traffic Stats:**
+
+ - See the `downloads <https://trafficcontrol.apache.org/downloads/index.html>`_ page for Traffic Control to get the latest release.
+ - Follow our build `intructions <https://github.com/apache/incubator-trafficcontrol/tree/master/build>`_ to generate an RPM.
+ - Copy the RPM to your server
+ - perform the following command: ``sudo rpm -ivh <traffic_stats rpm>``
+
+**Installing InfluxDB:**
+
+ **As of Traffic Stats 1.8.0, InfluxDb 1.0.0 or higher is required. For InfluxDb versions less than 1.0.0 use Traffic Stats 1.7.x**
+
+ In order to store traffic stats data you will need to install `InfluxDB <https://docs.influxdata.com/influxdb/latest/introduction/installation/>`_. While not required, it is recommended to use some sort of high availability option like `Influx enterprise <https://portal.influxdata.com/>`_, `Influxdb Relay <https://github.com/influxdata/influxdb-relay>`_, or another `high availability option <https://www.influxdata.com/high-availability/>`_.
+
+
+**Installing Grafana:**
+
+ Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and can be accessed by Traffic Ops. Documentation on installing Grafana can be found on the `Grafana website <http://docs.grafana.org/installation/>`__.
+
+Configuration
+=========================
+
+**Configuring Traffic Stats:**
+
+ Traffic Stats' configuration file can be found in /opt/traffic_stats/conf/traffic_stats.cfg.
+ The following values need to be configured:
+
+ - *toUser:* The user used to connect to Traffic Ops
+ - *toPasswd:* The password to use when connecting to Traffic Ops
+ - *toUrl:* The URL of the Traffic Ops server used by Traffic Stats
+ - *influxUser:* The user to use when connecting to InfluxDB (if configured on InfluxDB, else leave default)
+ - *influxPassword:* That password to use when connecting to InfluxDB (if configured, else leave blank)
+ - *pollingInterval:* The interval at which Traffic Monitor is polled and stats are stored in InfluxDB
+ - *statusToMon:* The status of Traffic Monitor to poll (poll ONLINE or OFFLINE traffic monitors)
+ - *seelogConfig:* The absolute path of the seelong config file
+ - *dailySummaryPollingInterval:* The interval, in seconds, at which Traffic Stats checks to see if daily stats need to be computed and stored.
+ - *cacheRetentionPolicy:* The default retention policy for cache stats
+ - *dsRetentionPolicy:* The default retention policy for deliveryservice stats
+ - *dailySummaryRetentionPolicy:* The retention policy to be used for the daily stats
+ - *influxUrls:* An array of influxdb hosts for Traffic Stats to write stats to.
+
+**Configuring InfluxDB:**
+
+ As mentioned above, it is recommended that InfluxDb be running in some sort of high availability configuration. There are several ways to achieve high availabilty so it is best to consult the high availability options on the `InfuxDB website <https://www.influxdata.com/high-availability/>`_.
+
+ Once InfluxDB is installed and configured, databases and retention policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the `overview <../overview/traffic_stats.html>`_ page.
+
+ To easily create databases, retention policies, and continuous queries, run create_ts_databases from the /opt/traffic_stats/influxdb_tools directory on your Traffic Stats server. See the `InfluxDb Tools <traffic_stats.html#influxdb-tools>`_ section below for more information.
+
+**Configuring Grafana:**
+
+ In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (more information below) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been configured and that data has been written to it. If this is not true, you will not see any graphs.
+
+ - Login to grafana as an admin user http://grafana_url:3000/login
+ - Choose Data Sources and then Add New
+ - Enter the necessary information to configure your data source
+ - Click on the 'Home' dropdown at the top of the screen and choose New at the bottom
+ - Click on the green menu bar (with 3 lines) at the top and choose Add Panel -> Graph
+ - Where it says 'No Title (click here)' click and choose edit
+ - Choose your data source at the bottom
+ - You can have grafana help you create a query, or you can create your own. Here is a sample query:
+
+ ``SELECT sum(value)*1000 FROM "monthly"."bandwidth.cdn.1min" WHERE $timeFilter GROUP BY time(60s), cdn``
+ - Once you have the graph the way you want it, click the 'Save Dashboard' button at the top
+ - You should now have a new saved graph
+
+ In order for Traffic Ops users to see Grafana graphs, Grafana will need to allow anonymous access. Information on how to configure anonymous access can be found on the configuration page of the `Grafana Website <http://docs.grafana.org/installation/configuration/#authanonymous>`_.
+
+ Traffic Ops uses custom dashboards to display information about individual delivery services or cache groups. In order for the custom graphs to display correctly, the `traffic_ops_*.js <https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_stats/grafana/>`_ files need to be in the ``/usr/share/grafana/public/dashboards/`` directory on the grafana server. If your Grafana server is the same as your Traffic Stats server the RPM install process will take care of putting the files in place. If your grafana server is different from your Traffic Stats server, you will need to manually copy the files to the correct directory.
+
+ More information on custom scripted graphs can be found in the `scripted dashboards <http://docs.grafana.org/reference/scripting/>`_ section of the Grafana documentation.
+
+**Configuring Traffic Ops for Traffic Stats:**
+
+ - The influxDb servers need to be added to Traffic Ops with profile = InfluxDB. Make sure to use port 8086 in the configuration.
+ - The traffic stats server should be added to Traffic Ops with profile = Traffic Stats.
+ - Parameters for which stats will be collected are added with the release, but any changes can be made via parameters that are assigned to the Traffic Stats profile.
+
+**Configuring Traffic Ops to use Grafana Dashboards**
+
+ To configure Traffic Ops to use Grafana Dashboards, you need to enter the following parameters and assign them to the GLOBAL profile. This assumes you followed the above instructions to install and configure InfluxDB and Grafana. You will need to place 'cdn-stats','deliveryservice-stats', and 'daily-summary' with the name of your dashboards.
+
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | parameter name | parameter value |
+ +===========================+================================================================================================+
+ | all_graph_url | https://<grafana_url>/dashboard/db/deliveryservice-stats |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | cachegroup_graph_url | https://<grafanaHost>/dashboard/script/traffic_ops_cachegroup.js?which= |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | deliveryservice_graph_url | https://<grafanaHost>/dashboard/script/traffic_ops_devliveryservice.js?which= |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | server_graph_url | https://<grafanaHost>/dashboard/script/traffic_ops_server.js?which= |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | visual_status_panel_1 | https://<grafanaHost>/dashboard-solo/db/cdn-stats?panelId=2&fullscreen&from=now-24h&to=now-60s |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | visual_status_panel_2 | https://<grafanaHost>/dashboard-solo/db/cdn-stats?panelId=1&fullscreen&from=now-24h&to=now-60s |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | daily_bw_url | https://<grafanaHost>/dashboard-solo/db/daily-summary?panelId=1&fullscreen&from=now-3y&to=now |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | daily_served_url | https://<grafanaHost>/dashboard-solo/db/daily-summary?panelId=2&fullscreen&from=now-3y&to=now |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+
+InfluxDb Tools
+=========================
+
+Under the Traffic Stats source directory there is a directory called influxdb_tools. These tools are meant to be used as one-off scripts to help a user quickly get new databases and continuous queries setup in influxdb.
+They are specific for traffic stats and are not meant to be generic to influxdb. Below is an brief description of each script along with how to use it.
+
+**create/create_ts_databases.go**
+ This script creates all `databases <https://docs.influxdata.com/influxdb/latest/concepts/key_concepts/#database>`_, `retention policies <https://docs.influxdata.com/influxdb/latest/concepts/key_concepts/#retention-policy>`_, and `continuous queries <https://docs.influxdata.com/influxdb/v0.11/query_language/continuous_queries/>`_ required by traffic stats.
+
+ **How to use create_ts_databases:**
+
+ Pre-Requisites:
+
+ 1. Go 1.7 or later
+ 2. configured $GOPATH (e.g. export GOPATH=~/go)
+
+ Using create_ts_databases.go
+
+ 1. go to the traffic_stats/influxdb_tools/create directory
+
+ 2. build it by running ``go build create_ts_databases.go`` or simply ``go build``
+
+ 3. Run it:
+ - ``./create_ts_databases -help`` or ``./create -help``
+ - optional flags:
+ - url - The influxdb url and port
+ - replication - The number of nodes in the cluster
+ - user - The user to use
+ - password - The password to use
+ - example: ``./create_ts_databases -url=localhost:8086 -replication=3 -user=joe -password=mysecret`` or ``./create -url=localhost:8086 -replication=3 -user=joe -password=mysecret``
+
+**sync_ts_databases**
+ This script is used to sync one influxdb environment to another. Only data from continuous queries is synced as it is downsampled data and much smaller in size than syncing raw data. Possible use cases are syncing from Production to Development or Syncing a new cluster once brought online.
+
+ **How to use sync_ts_databases:**
+
+ Pre-Requisites:
+
+ 1. Go 1.7 or later
+ 2. configured $GOPATH (e.g. export GOPATH=~/go)
+
+ Using sync_ts_databases.go:
+
+ 1. go to the traffic_stats/influxdb_tools/create directory
+
+ 2. build it by running ``go build sync_ts_databases.go`` or simply ``go build``
+
+ 3. Run it
+ - ``./sync_ts_databases -help`` or ``./sync -help``
+ - required flags:
+ - source-url - The URL of the source database
+ - target-url - The URL of the target database
+
+ -optional flags:
+ - database - The database to sync (default = sync all databases)
+ - days - Days in the past to sync (default = sync all data)
+ - source-user - The user of the source database
+ - source-pass - The password for the source database
+ - target-user - The user of the target database
+ - target-pass - The password for the target database
+
+ - example: `./sync -source-url=http://idb-01.foo.net:8086 -target-url=http://idb-01.foo.net:8086 -database=cache_stats -days=7 -source-user=admin source-pass=mysecret`
+
diff --git a/docs/latest/_sources/admin/traffic_vault.rst.txt b/docs/latest/_sources/admin/traffic_vault.rst.txt
new file mode 100644
index 0000000..2f6508a
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_vault.rst.txt
@@ -0,0 +1,188 @@
+..
+..
+.. 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.
+..
+
+****************************
+Traffic Vault Administration
+****************************
+Installing Traffic Vault
+========================
+In order to successfully store private keys you will need to install Riak.
+The latest version of Riak can be downloaded on the Riak `website <http://docs.basho.com/riak/latest/downloads/>`_.
+The installation instructions for Riak can be found `here <http://docs.basho.com/riak/latest/ops/building/installing/>`__.
+
+Production is currently running version 2.0.5 of Riak, but the latest version should suffice.
+
+
+Configuring Traffic Vault
+=========================
+The following steps were taken to configure Riak in our environments.
+
+Riak configuration file configuration
+-------------------------------------
+
+The following steps need to be performed on each Riak server in the cluster:
+
+* Log into riak server as root
+
+* cd to /etc/riak/
+
+* Update the following in riak.conf to reflect your IP:
+ - nodename = riak@a-host.sys.kabletown.net
+ - listener.http.internal = a-host.sys.kabletown.net:8098 (can be 80 - This endpoint will not work with sec enabled)
+ - listener.protobuf.internal = a-host.sys.kabletown.net:8087 (can be different port if you want)
+ - listener.https.internal = a-host.sys.kabletown.net:8088 (can be 443)
+
+* Updated the following conf file to point to your cert files
+ - ssl.certfile = /etc/riak/certs/server.crt
+ - ssl.keyfile = /etc/riak/certs/server.key
+ - ssl.cacertfile = /etc/pki/tls/certs/ca-bundle.crt
+
+* Add a line at the bottom of the config for tlsv1
+ - tls_protocols.tlsv1 = on
+
+* Once the config file has been updated restart riak
+ - ``/etc/init.d/riak restart``
+
+* Validate server is running by going to the following URL:
+ - https://<serverHostname>:8088/ping
+
+Riak-admin configuration
+-------------------------
+
+Riak-admin is a command line utility that needs to be run as root on a server in the riak cluster.
+
+Assumptions:
+ * Riak 2.0.2 or greater is installed
+ * SSL Certificates have been generated (signed or self-signed)
+ * Root access to riak servers
+
+Add admin user and riakuser to riak
+ * Admin user will be a super user
+ * Riakuser will be the application user
+
+Login to one of the riak servers in the cluster as root (any will do)
+
+ 1. Enable security
+
+ ``riak-admin security enable``
+
+ 2. Add groups
+
+ ``riak-admin security add-group admins``
+
+ ``riak-admin security add-group keysusers``
+ 3. Add users
+
+ .. Note:: username and password should be stored in /opt/traffic_ops/app/conf/<environment>/riak.conf
+ ..
+
+ ``riak-admin security add-user admin password=<AdminPassword> groups=admins``
+
+ ``riak-admin security add-user riakuser password=<RiakUserPassword> groups=keysusers``
+
+ 4. Grant access for admin and riakuser
+
+ ``riak-admin security add-source riakuser 0.0.0.0/0 password``
+
+ ``riak-admin security add-source admin 0.0.0.0/0 password``
+
+ 5. Grant privs to admins for everything
+
+ ``riak-admin security grant riak_kv.list_buckets,riak_kv.list_keys,riak_kv.get,riak_kv.put,riak_kv.delete on any to admins``
+
+ 6. Grant privs to keysuser for ssl, dnssec, and url_sig_keys buckets only
+
+ ``riak-admin security grant riak_kv.get,riak_kv.put,riak_kv.delete on default ssl to keysusers``
+
+ ``riak-admin security grant riak_kv.get,riak_kv.put,riak_kv.delete on default dnssec to keysusers``
+
+ ``riak-admin security grant riak_kv.get,riak_kv.put,riak_kv.delete on default url_sig_keys to keysusers``
+
+ ``riak-admin security grant riak_kv.get,riak_kv.put,riak_kv.delete on default cdn_uri_sig_keys to keysusers``
+
+.. seealso:: For more information on security in Riak, see the `Riak Security documentation <http://docs.basho.com/riak/2.0.4/ops/advanced/security/>`_.
+.. seealso:: For more information on authentication and authorization in Riak, see the `Riak Authentication and Authorization documentation <http://docs.basho.com/riak/2.0.4/ops/running/authz/>`_.
+
+
+Traffic Ops Configuration
+-------------------------
+
+There are a couple configurations that are necessary in Traffic Ops.
+
+1. Database Updates
+ * The servers in the Riak cluster need to be added to the server table (TCP Port = 8088, type = RIAK, profile = RIAK_ALL)
+
+2. Configuration updates
+ * /opt/traffic_ops/app/conf/<environment>/riak.conf needs to be updated to reflect the correct username and password for accessing riak.
+
+Configuring Riak Search
+=======================
+
+In order to more effectively support retrieval of SSL certificates by Traffic Router and Traffic Ops ORT, Traffic Vault uses `Riak search <http://docs.basho.com/riak/kv/latest/using/reference/search/>`_. Riak Search uses `Apache Solr <http://lucene.apache.org/solr>`_ for indexing and searching of records. The following explains how to enable, configure, and validate Riak Search.
+
+Riak Configuration
+------------------
+
+On Each Riak Server:
+
+1. If java is not already installed on your Riak server, install Java
+ * To see if Java is already installed: ``java -version``
+ * To install Java: ``yum install -y jdk``
+
+2. enable search in riak.conf
+ * ``vim /etc/riak/riak.conf``
+ * look for search and change ``search = off`` to ``search = on``
+
+3. Restart Riak so search is on
+ * ``service riak restart``
+
+One time configuration:
+
+1. **On one of the Riak servers in the cluster run the following riak-admin commands**
+
+``riak-admin security grant search.admin on schema to admin``
+
+``riak-admin security grant search.admin on index to admin``
+
+``riak-admin security grant search.query on index to admin``
+
+``riak-admin security grant search.query on index sslkeys to admin``
+
+``riak-admin security grant search.query on index to riakuser``
+
+``riak-admin security grant search.query on index sslkeys to riakuser``
+
+``riak-admin security grant riak_core.set_bucket on any to admin``
+
+2. Add the search schema to Riak. This schema is a simple Apache Solr configuration file which will index all records on cdn, hostname, and deliveryservice.
+ * Get the schema file by either cloning the project and going to `traffic_ops/app/config/misc/riak_search` or from `github <https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_ops/app/conf/misc/riak_search>`_.
+ * Use curl to add the schema to riak: ``curl -kvs -XPUT "https://admin:pass@riakserver:8088/search/schema/sslkeys" -H 'Content-Type:application/xml' -d @sslkeys.xml``
+
+3. Add search index to Riak
+ * run the following curl command: ``curl -kvs -XPUT "https://admin:pass@riakserver:8088/search/index/sslkeys" -H 'Content-Type: application/json' -d '{"schema":"sslkeys"}'``
+
+4. Associate the sslkeys index to the ssl bucket in Riak
+ * run the following curl command: ``curl -kvs -XPUT "https://admin:pass@riakserver:8088/buckets/ssl/props" -H'content-type:application/json' -d'{"props":{"search_index":"sslkeys"}}'``
+
+Riak Search (using Apache Solr) will now index all NEW records that are added to the "ssl" bucket. The cdn, deliveryservice, and hostname fields are indexed and when a search is performed riak will return the indexed fields along with the crt and key values for a ssl record. In order to add the indexed fields to current records and to get the current records added, a standalone script needs to be run. This does not need to be done on new installs. The following explains how to run the script.
+
+1. Get script from github either by cloning the project and going to `traffic_ops/app/script` or from `here <https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_ops/app/script/update_riak_for_search.pl>`_
+2. Run the script by performing the following command ``./update_riak_for_search.pl -to_url=https://traffic-ops.kabletown.net -to_un=user -to_pw=password``
+
+Validate the search is working by querying against Riak directly:
+``curl -kvs "https://admin:password@riakserver:8088/search/query/sslkeys?wt=json&q=cdn:mycdn"``
+
+Validation can also be done by querying Traffic Ops:
+``curl -Lvs -H "Cookie: $COOKIE" https://traffic-ops.kabletown.net/api/1.2/cdns/name/mycdn/sslkeys.json``
diff --git a/docs/latest/_sources/api/index.rst.txt b/docs/latest/_sources/api/index.rst.txt
new file mode 100644
index 0000000..6cdf32e
--- /dev/null
+++ b/docs/latest/_sources/api/index.rst.txt
@@ -0,0 +1,28 @@
+..
+..
+.. 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.
+..
+
+APIs
+****
+A guide to external RESTful APIs for Traffic Ops
+
+.. toctree::
+ :maxdepth: 2
+
+ traffic_ops_api
+ routes
+ v11/index
+ v12/index
+ v13/index
+
diff --git a/docs/latest/_sources/api/routes.rst.txt b/docs/latest/_sources/api/routes.rst.txt
new file mode 100644
index 0000000..1c849b3
--- /dev/null
+++ b/docs/latest/_sources/api/routes.rst.txt
@@ -0,0 +1,118 @@
+.. raw:: html
+
+ <style>
+ table {
+ table-layout: fixed;
+ width: 100%;
+ }
+
+ td {
+ word-wrap:break-word;
+ }
+ table.docutils col:nth-child(1) {
+ width: 30%;
+ }
+ table.docutils col:nth-child(2) {
+ width: 30%;
+ }
+ table.docutils col:nth-child(3) {
+ width: 30%;
+ }
+ .wy-nav-content {
+ max-width: 1200px;
+ width: 90%;
+ }
+ </style>
+
+..
+..
+.. 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-routes:
+
+API Routes
+==========
+
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| 1.0 | 1.1 | 1.2 |
++====================================+====================================================+====================================================+
+| /asns | :ref:`to-api-v11-asns-route` | :ref:`to-api-v12-asns-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /availableds | :ref:`to-api-v11-ds-route` | :ref:`to-api-v12-ds-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| *Not Implemented* | *Not Implemented* | :ref:`to-api-v12-cache-stats-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datacrans | /api/1.1/crans.json | /api/1.2/crans.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datacrans/orderby/:field | /api/1.1/crans.json | /api/1.2/crans.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datadeliveryservice | :ref:`to-api-v11-ds-route` | :ref:`to-api-v12-ds-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datadeliveryserviceserver | /api/1.1/deliveryserviceserver.json | /api/1.2/deliveryserviceserver.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datadomains | /api/1.1/cdns/domains.json | /api/1.2/cdns/domains.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| *Not Implemented* | *Not Implemented* | :ref:`to-api-v12-ds-stats-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datahwinfo | :ref:`to-api-v11-hwinfo-route` | :ref:`to-api-v12-hwinfo-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datalinks | /api/1.1/deliveryserviceserver.json | /api/1.2/deliveryserviceserver.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datalinks/orderby/:field | /api/1.1/deliveryserviceserver.json | /api/1.2/deliveryserviceserver.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datalogs | :ref:`to-api-v11-change-logs-route` | :ref:`to-api-v12-change-logs-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datalocation/orderby/id | :ref:`to-api-v11-cachegroups-route` | :ref:`to-api-v12-cachegroups-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datalocationparameters | :ref:`to-api-v11-cachegroups-route` | :ref:`to-api-v12-cachegroups-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataparameter | :ref:`to-api-v11-parameters-route` | :ref:`to-api-v12-parameters-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataparameter/:parameter | /api/1.1/parameters/profile/:parameter.json | /api/1.2/parameters/profile/:parameter.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataphys_location | :ref:`to-api-v11-phys-loc-route` | :ref:`to-api-v12-phys-loc-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataprofile | :ref:`to-api-v11-profiles-route` | :ref:`to-api-v12-profiles-route` |
+| | | |
+| /dataprofile/orderby/name | | |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataregion | :ref:`to-api-v11-regions-route` | :ref:`to-api-v12-regions-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datarole | :ref:`to-api-v11-roles-route` | :ref:`to-api-v12-roles-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datarole/orderby/:field | :ref:`to-api-v11-roles-route` | :ref:`to-api-v12-roles-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataserver | :ref:`to-api-v11-servers-route` | :ref:`to-api-v12-servers-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataserver/orderby/:field | :ref:`to-api-v11-servers-route` | :ref:`to-api-v12-servers-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataserverdetail/select/:hostname | /api/1.1/servers/hostname/:hostname/details.json | /api/1.2/servers/hostname/:hostname/details.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datastaticdnsentry | :ref:`to-api-v11-static-dns-route` | :ref:`to-api-v12-static-dns-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datastatus | :ref:`to-api-v11-statuses-route` | :ref:`to-api-v12-statuses-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datastatus/orderby/name | :ref:`to-api-v11-statuses-route` | :ref:`to-api-v12-statuses-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datatype | :ref:`to-api-v11-types-route` | :ref:`to-api-v12-types-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datatype/orderby/:field | :ref:`to-api-v11-types-route` | :ref:`to-api-v12-types-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datauser | :ref:`to-api-v11-users-route` | :ref:`to-api-v12-users-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datauser/orderby/:field | :ref:`to-api-v11-users-route` | :ref:`to-api-v12-users-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| *Not Implemented* | *Not Implemented* | :ref:`to-api-v12-configfiles_ats-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
diff --git a/docs/latest/_sources/api/traffic_ops_api.rst.txt b/docs/latest/_sources/api/traffic_ops_api.rst.txt
new file mode 100644
index 0000000..0ced0ae
--- /dev/null
+++ b/docs/latest/_sources/api/traffic_ops_api.rst.txt
@@ -0,0 +1,196 @@
+..
+..
+.. 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.
+..
+
+API Overview
+************
+The Traffic Ops API provides programmatic access to read and write CDN data providing authorized API consumers with the ability to monitor CDN performance and configure CDN settings and parameters.
+
+Response Structure
+------------------
+All successful responses have the following structure: ::
+
+ {
+ "response": <JSON object with main response>,
+ }
+
+To make the documentation easier to read, only the ``<JSON object with main response>`` is documented, even though the response and version fields are always present.
+
+Using API Endpoints
+-------------------
+1. Authenticate with your Traffic Portal or Traffic Ops user account credentials.
+2. Upon successful user authentication, note the mojolicious cookie value in the response headers.
+3. Pass the mojolicious cookie value, along with any subsequent calls to an authenticated API endpoint.
+
+Example: ::
+
+ [jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+ {"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
+ [jvd@laika ~]$
+ [jvd@laika ~]$ curl -v -H "Accept: application/json" -v -X POST --data '{ "u":"admin", "p":"secret_passwd" }' http://localhost:3000/api/1.1/user/login
+ * Hostname was NOT found in DNS cache
+ * Trying ::1...
+ * connect to ::1 port 3000 failed: Connection refused
+ * Trying 127.0.0.1...
+ * Connected to localhost (127.0.0.1) port 3000 (#0)
+ > POST /api/1.1/user/login HTTP/1.1
+ > User-Agent: curl/7.37.1
+ > Host: localhost:3000
+ > Accept: application/json
+ > Content-Length: 32
+ > Content-Type: application/x-www-form-urlencoded
+ >
+ * upload completely sent off: 32 out of 32 bytes
+ < HTTP/1.1 200 OK
+ < Connection: keep-alive
+ < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ < Access-Control-Allow-Origin: http://localhost:8080
+ < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+ < Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862; expires=Sun, 19 Apr 2015 00:10:01 GMT; path=/; HttpOnly
+ < Content-Type: application/json
+ < Date: Sat, 18 Apr 2015 20:10:01 GMT
+ < Access-Control-Allow-Credentials: true
+ < Content-Length: 81
+ < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ * Server Mojolicious (Perl) is not blacklisted
+ < Server: Mojolicious (Perl)
+ <
+ * Connection #0 to host localhost left intact
+ {"alerts":[{"level":"success","text":"Successfully logged in."}]}
+ [jvd@laika ~]$
+
+ [jvd@laika ~]$ curl -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asns.json
+ {"response":{"asns":[{"lastUpdated":"2012-09-17 15:41:22", .. asn data deleted .. ,}
+ [jvd@laika ~]$
+
+API Errors
+----------
+
+**Response Properties**
+
++----------------------+--------+------------------------------------------------+
+| Parameter | Type | Description |
++======================+========+================================================+
+|``alerts`` | array | A collection of alert messages. |
++----------------------+--------+------------------------------------------------+
+| ``>level`` | string | Success, info, warning or error. |
++----------------------+--------+------------------------------------------------+
+| ``>text`` | string | Alert message. |
++----------------------+--------+------------------------------------------------+
+
+The 3 most common errors returned by Traffic Ops are:
+
+401 Unauthorized
+ When you don't supply the right cookie, this is the response. ::
+
+ [jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+ * Hostname was NOT found in DNS cache
+ * Trying ::1...
+ * connect to ::1 port 3000 failed: Connection refused
+ * Trying 127.0.0.1...
+ * Connected to localhost (127.0.0.1) port 3000 (#0)
+ > GET /api/1.1/usage/asns.json HTTP/1.1
+ > User-Agent: curl/7.37.1
+ > Host: localhost:3000
+ > Accept: application/json
+ >
+ < HTTP/1.1 401 Unauthorized
+ < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ < Content-Length: 84
+ * Server Mojolicious (Perl) is not blacklisted
+ < Server: Mojolicious (Perl)
+ < Connection: keep-alive
+ < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+ < Access-Control-Allow-Origin: http://localhost:8080
+ < Date: Sat, 18 Apr 2015 20:36:12 GMT
+ < Content-Type: application/json
+ < Access-Control-Allow-Credentials: true
+ <
+ * Connection #0 to host localhost left intact
+ {"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
+ [jvd@laika ~]$
+
+404 Not Found
+ When the resource (path) is non existent Traffic Ops returns a 404::
+
+ [jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
+ * Hostname was NOT found in DNS cache
+ * Trying ::1...
+ * connect to ::1 port 3000 failed: Connection refused
+ * Trying 127.0.0.1...
+ * Connected to localhost (127.0.0.1) port 3000 (#0)
+ > GET /api/1.1/asnsjj.json HTTP/1.1
+ > User-Agent: curl/7.37.1
+ > Host: localhost:3000
+ > Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;
+ > Accept: application/json
+ >
+ < HTTP/1.1 404 Not Found
+ * Server Mojolicious (Perl) is not blacklisted
+ < Server: Mojolicious (Perl)
+ < Content-Length: 75
+ < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ < Content-Type: application/json
+ < Date: Sat, 18 Apr 2015 20:37:43 GMT
+ < Access-Control-Allow-Credentials: true
+ < Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAzODYzLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--8a5a61b91473bc785d4073fe711de8d2c63f02dd; expires=Sun, 19 Apr 2015 00:37:43 GMT; path=/; HttpOnly
+ < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ < Connection: keep-alive
+ < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+ < Access-Control-Allow-Origin: http://localhost:8080
+ <
+ * Connection #0 to host localhost left intact
+ {"alerts":[{"text":"Resource not found.","level":"error"}]}
+ [jvd@laika ~]$
+
+500 Internal Server Error
+ When you are asking for a correct path, but the database doesn't match, it returns a 500::
+
+ [jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
+ * Hostname was NOT found in DNS cache
+ * Trying ::1...
+ * connect to ::1 port 3000 failed: Connection refused
+ * Trying 127.0.0.1...
+ * Connected to localhost (127.0.0.1) port 3000 (#0)
+ > GET /api/1.1/servers/hostname/jj/details.json HTTP/1.1
+ > User-Agent: curl/7.37.1
+ > Host: localhost:3000
+ > Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;
+ > Accept: application/json
+ >
+ < HTTP/1.1 500 Internal Server Error
+ * Server Mojolicious (Perl) is not blacklisted
+ < Server: Mojolicious (Perl)
+ < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ < Content-Length: 93
+ < Set-Cookie: mojolicious=eyJhdXRoX2RhdGEiOiJhZG1pbiIsImV4cGlyZXMiOjE0Mjk0MDQzMDZ9--1b08977e91f8f68b0ff5d5e5f6481c76ddfd0853; expires=Sun, 19 Apr 2015 00:45:06 GMT; path=/; HttpOnly
+ < Content-Type: application/json
+ < Date: Sat, 18 Apr 2015 20:45:06 GMT
+ < Access-Control-Allow-Credentials: true
+ < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ < Connection: keep-alive
+ < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+ < Access-Control-Allow-Origin: http://localhost:8080
+ <
+ * Connection #0 to host localhost left intact
+ {"alerts":[{"level":"error","text":"An error occurred. Please contact your administrator."}]}
+ [jvd@laika ~]$
+
+ The rest of the API documentation will only document the ``200 OK`` case, where no errors have occured.
+
+TrafficOps Native Client Libraries
+----------------------------------
+
+TrafficOps client libraries are available in both Golang and Python. You can read more about them at https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_control/clients
diff --git a/docs/latest/_sources/api/v11/asn.rst.txt b/docs/latest/_sources/api/v11/asn.rst.txt
new file mode 100644
index 0000000..b6960d7
--- /dev/null
+++ b/docs/latest/_sources/api/v11/asn.rst.txt
@@ -0,0 +1,69 @@
+..
+..
+.. 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-v11-asn:
+
+ASN
+===
+
+.. _to-api-v11-asns-route:
+
+/api/1.1/asns
++++++++++++++
+
+**GET /api/1.1/asns**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``asns`` | array | A collection of asns |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>id`` | string | Local unique identifier for the ASN |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>cachegroup`` | string | Related cachegroup name |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "asns": [
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "27",
+ "asn": "7015",
+ "cachegroup": "us-ma-woburn"
+ },
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "7016",
+ "cachegroup": "us-pa-pittsburgh"
+ }
+ ]
+ },
+ }
+
diff --git a/docs/latest/_sources/api/v11/cachegroup.rst.txt b/docs/latest/_sources/api/v11/cachegroup.rst.txt
new file mode 100644
index 0000000..5278645
--- /dev/null
+++ b/docs/latest/_sources/api/v11/cachegroup.rst.txt
@@ -0,0 +1,317 @@
+..
+..
+.. 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-v11-cachegroup:
+
+Cache Group
+===========
+
+.. _to-api-v11-cachegroups-route:
+
+/api/1.1/cachegroups
+++++++++++++++++++++
+
+**GET /api/1.1/cachegroups**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ },
+ {
+ "id": "22",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago-1",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/cachegroups/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "dc-chicago"
+ },
+ {
+ "name": "dc-cmc"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/cachegroups/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ }
+ ],
+ }
+
+|
+
+
+**GET /api/1.1/cachegroup/:parameter_id/parameter**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-------------+
+ | Name | Required | Description |
+ +==================+==========+=============+
+ | ``parameter_id`` | yes | |
+ +------------------+----------+-------------+
+
+ **Response Properties**
+
+ +-----------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=================+========+=============+
+ | ``cachegroups`` | array | |
+ +-----------------+--------+-------------+
+ | ``>name`` | string | |
+ +-----------------+--------+-------------+
+ | ``>id`` | string | |
+ +-----------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroups": [
+ {
+ "name": "dc-chicago",
+ "id": "21"
+ },
+ {
+ "name": "dc-cmc",
+ "id": "22"
+ }
+ ]
+ },
+ }
+
+
+**GET /api/1.1/cachegroupparameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------------+--------+-----------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+=========================================+
+ | ``cachegroupParameters`` | array | A collection of cache group parameters. |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>parameter`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>last_updated`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>cachegroup`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroupParameters": [
+ {
+ "parameter": "379",
+ "last_updated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ca-sanjose"
+ },
+ {
+ "parameter": "380",
+ "last_updated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ca-sanjose"
+ },
+ {
+ "parameter": "379",
+ "last_updated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ma-woburn"
+ }
+ ]
+ },
+ }
+
+
+|
+
+**GET /api/1.1/cachegroups/:parameter_id/parameter/available**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-------------+
+ | Name | Required | Description |
+ +==================+==========+=============+
+ | ``parameter_id`` | yes | |
+ +------------------+----------+-------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "dc-chicago",
+ "id": "21"
+ },
+ {
+ "name": "dc-cmc",
+ "id": "22"
+ }
+ ],
+ }
+
diff --git a/docs/latest/_sources/api/v11/cdn.rst.txt b/docs/latest/_sources/api/v11/cdn.rst.txt
new file mode 100644
index 0000000..91c926c
--- /dev/null
+++ b/docs/latest/_sources/api/v11/cdn.rst.txt
@@ -0,0 +1,1088 @@
+..
+..
+.. 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-v11-cdn-health:
+
+CDN
+===
+
+.. _to-api-v11-cdn-health-route:
+
+/api/1.1/cdns
++++++++++++++
+
+**GET /api/1.1/cdns**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "over-the-top",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/cdns/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | CDN id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/cdns/name/:name**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``name`` | yes | CDN name. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+Health
+++++++
+
+**GET /api/1.1/cdns/health**
+
+ Retrieves the health of all locations (cache groups) for all CDNs.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ },
+ }
+
+
+|
+
+**GET /api/1.1/cdns/:name/health**
+
+ Retrieves the health of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |``name`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across the |
+ | | | specified CDN. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across the |
+ | | | specified CDN. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ },
+ }
+
+|
+
+**GET /api/1.1/cdns/usage/overview**
+
+ Retrieves the high-level CDN usage metrics.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``currentGbps`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``tps`` | int | |
+ +----------------------+--------+------------------------------------------------+
+ |``maxGbps`` | int | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "currentGbps": 149.368167,
+ "tps": 36805,
+ "maxGbps": 3961
+ }
+ }
+
+
+**GET /api/1.1/cdns/capacity**
+
+ Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``availablePercent`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``unavailablePercent``| number | |
+ +----------------------+--------+------------------------------------------------+
+ |``utilizedPercent`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``maintenancePercent``| number | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "availablePercent": 89.0939840205533,
+ "unavailablePercent": 0,
+ "utilizedPercent": 10.9060020300395,
+ "maintenancePercent": 0.0000139494071146245
+ }
+ }
+
+|
+
+.. _to-api-v11-cdn-routing:
+
+Routing
++++++++
+
+**GET /api/1.1/cdns/routing**
+
+ Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+-----------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+=========================================+
+ | ``staticRoute`` | number | Used pre-configured DNS entries. |
+ +-----------------+--------+-----------------------------------------+
+ | ``miss`` | number | No location available for client IP. |
+ +-----------------+--------+-----------------------------------------+
+ | ``geo`` | number | Used 3rd party geo-IP mapping. |
+ +-----------------+--------+-----------------------------------------+
+ | ``err`` | number | Error localizing client IP. |
+ +-----------------+--------+-----------------------------------------+
+ | ``cz`` | number | Used Coverage Zone geo-IP mapping. |
+ +-----------------+--------+-----------------------------------------+
+ | ``dsr`` | number | Overflow traffic sent to secondary CDN. |
+ +-----------------+--------+-----------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "staticRoute": 0,
+ "miss": 0,
+ "geo": 37.8855391018869,
+ "err": 0,
+ "cz": 62.1144608981131,
+ "dsr": 0
+ }
+ }
+
+|
+
+.. _to-api-v11-cdn-metrics:
+
+Metrics
++++++++
+
+**GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end**
+
+*Note: this route is not currently implemented in Traffic Ops. See https://github.com/apache/incubator-trafficcontrol/issues/2309*
+
+ Retrieves edge metrics of one or all locations (cache groups).
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------+
+ | Name | Required | Description |
+ +=================+==========+===========================+
+ | ``metric_type`` | yes | ooff, origin_tps |
+ +-----------------+----------+---------------------------+
+ | ``start`` | yes | UNIX time, yesterday, now |
+ +-----------------+----------+---------------------------+
+ | ``end`` | yes | UNIX time, yesterday, now |
+ +-----------------+----------+---------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=====================+========+=============+
+ | ``stats`` | hash | |
+ +---------------------+--------+-------------+
+ | ``>count`` | string | |
+ +---------------------+--------+-------------+
+ | ``>98thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>min`` | string | |
+ +---------------------+--------+-------------+
+ | ``>max`` | string | |
+ +---------------------+--------+-------------+
+ | ``>5thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>95thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>mean`` | string | |
+ +---------------------+--------+-------------+
+ | ``>sum`` | string | |
+ +---------------------+--------+-------------+
+ | ``data`` | array | |
+ +---------------------+--------+-------------+
+ | ``>time`` | int | |
+ +---------------------+--------+-------------+
+ | ``>value`` | number | |
+ +---------------------+--------+-------------+
+ | ``label`` | string | |
+ +---------------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "stats": {
+ "count": 1,
+ "98thPercentile": 1668.03,
+ "min": 1668.03,
+ "max": 1668.03,
+ "5thPercentile": 1668.03,
+ "95thPercentile": 1668.03,
+ "mean": 1668.03,
+ "sum": 1668.03
+ },
+ "data": [
+ [
+ 1425135900000,
+ 1668.03
+ ],
+ [
+ 1425136200000,
+ null
+ ]
+ ],
+ "label": "Origin TPS"
+ }
+ ],
+ }
+
+|
+
+.. _to-api-v11-cdn-domains:
+
+Domains
++++++++
+
+**GET /api/1.1/cdns/domains**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``profileId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``parameterId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``profileName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``profileDescription``| string | |
+ +----------------------+--------+------------------------------------------------+
+ |``domainName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "profileId": "5",
+ "parameterId": "404",
+ "profileName": "CR_FOO",
+ "profileDescription": "Content Router for foo.domain.net",
+ "domainName": "foo.domain.net"
+ },
+ {
+ "profileId": "8",
+ "parameterId": "405",
+ "profileName": "CR_BAR",
+ "profileDescription": "Content Router for bar.domain.net",
+ "domainName": "bar.domain.net"
+ }
+ ],
+ }
+
+|
+
+.. _to-api-v11-cdn-topology:
+
+Topology
+++++++++
+
+**GET /api/1.1/cdns/:cdn_name/configs**
+
+ Retrieves CDN config information based upon the provided cdn name.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +--------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==============+==========+=======================+
+ | ``cdn_name`` | yes | Your cdn name or, all |
+ +--------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +-----------------------+--------+-----------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+===============================================+
+ |``id`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``value`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``name`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``config_file`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+
+ **Response Example** ::
+
+ TBD
+
+|
+
+**GET /api/1.1/cdns/:name/configs/monitoring**
+
+ Retrieves CDN monitoring information.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | CDN name |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------------------------+--------+--------------------+
+ | Parameter | Type | Description |
+ +=================================================+========+====================+
+ | ``trafficServers`` | array | A collection of |
+ | | | Traffic Servers. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>cacheGroup`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>port`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>interfaceName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>type`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hashId`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``cacheGroups`` | array | A collection of |
+ | | | cache groups. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>coordinates`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>name`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``config`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hack.ttl`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.healthParams.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.dataServer.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.timepad`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.polling.interval`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.threadPool`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.polling.interval`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.event-count`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.crConfig.polling.url`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>CDN_name`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``trafficMonitors`` | array | A collection of |
+ | | | Traffic Monitors. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>location`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>port`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``deliveryServices`` | array | A collection of |
+ | | | delivery services. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>xmlId`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>totalTpsThreshold`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>totalKbpsThreshold`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``profiles`` | array | A collection of |
+ | | | profiles. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>parameters`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.connection.timeout`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.queryTime`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>history.count`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.availableBandwidthInKbps`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.loadavg`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>name`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>type`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+
+ **Response Example**
+ ::
+
+ TBD
+
+|
+
+**GET /api/1.1/cdns/:name/configs/routing**
+
+ Retrieves CDN routing information.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------------+---------+-----------------------------------+
+ | Parameter | Type | Description |
+ +=====================================+=========+===================================+
+ | ``trafficServers`` | array | A collection of Traffic Servers. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>cacheGroup`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>deliveryServices`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>xmlId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>remaps`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>interfaceName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>type`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hashId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``stats`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsPath`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>cdnName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsVersion`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsUser`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>date`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsHost`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``cacheGroups`` | array | A collection of cache groups. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coordinates`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>name`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``config`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.admin`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tcoveragezone.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.expire`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coveragezone.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.minimum`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>domain_name`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.AAAA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.refresh`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.NS`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.SOA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation6.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.A`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.retry`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation6.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``trafficMonitors`` | array | A collection of Traffic Monitors. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>location`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``deliveryServices`` | array | A collection of delivery |
+ | | | services. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>xmlId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ttl`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geoEnabled`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coverageZoneOnly`` | boolean | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>matchSets`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>protocol`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>matchList`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>>regex`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>>matchType`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>bypassDestination`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>maxDnsIpsForLocation`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>ttl`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>type`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ttls`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>A`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>SOA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>NS`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>AAAA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>missCoordinates`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>soa`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>admin`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>retry`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>minimum`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>refresh`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>expire`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``trafficRouters`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>location`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>apiPort`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+
+
+**Response Example**
+
+::
+ TBD
+
+
+.. _to-api-v11-cdn-dnsseckeys:
+
+DNSSEC Keys
++++++++++++
+
+**GET /api/1.1/cdns/name/:name/dnsseckeys**
+
+ Gets a list of dnsseckeys for CDN and all associated Delivery Services.
+ Before returning response to user, check to make sure keys aren't expired. If they are expired, generate new ones.
+ Before returning response to user, make sure dnssec keys for all delivery services exist. If they don't exist, create them.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +------------------------+--------+---------------------------------------------------------+
+ | Parameter | Type | Description |
+ +========================+========+=========================================================+
+ | ``cdn name/ds xml_id`` | string | identifier for ds or cdn |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>zsk/ksk`` | array | collection of zsk/ksk data |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>ttl`` | string | time-to-live for dnssec requests |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>inceptionDate`` | string | epoch timestamp for when the keys were created |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>expirationDate`` | string | epoch timestamp representing the expiration of the keys |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>private`` | string | encoded private key |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>public`` | string | encoded public key |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>name`` | string | domain name |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``version`` | string | API version |
+ +------------------------+--------+---------------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cdn1": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750",
+ "ttl": "60"
+ }
+ },
+ "ds-01": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "ds-01.foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "ds-01.foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750"
+ }
+ },
+ ... repeated for each ds in the cdn
+ },
+ }
+
+|
+
+**GET /api/1.1/cdns/name/:name/dnsseckeys/delete**
+
+ Delete dnssec keys for a cdn and all associated delivery services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +----------+----------+----------------------------------------------------------+
+ | Name | Required | Description |
+ +==========+==========+==========================================================+
+ | ``name`` | yes | name of the CDN for which you want to delete dnssec keys |
+ +----------+----------+----------------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------+--------+------------------+
+ | Parameter | Type | Description |
+ +==============+========+==================+
+ | ``response`` | string | success response |
+ +--------------+--------+------------------+
+
+ **Response Example**
+ ::
+
+ {
+ "response": "Successfully deleted dnssec keys for <cdn>"
+ }
+
+|
+
+**POST /api/1.1/deliveryservices/dnsseckeys/generate**
+
+ Generates zsk and ksk keypairs for a cdn and all associated delivery services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Properties**
+
+ +-----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+=========+================================================+
+ | ``key`` | string | name of the cdn |
+ +-----------------------+---------+------------------------------------------------+
+ | ``name`` | string | domain name of the cdn |
+ +-----------------------+---------+------------------------------------------------+
+ | ``ttl`` | string | time to live |
+ +-----------------------+---------+------------------------------------------------+
+ | ``kskExpirationDays`` | string | Expiration (in days) for the key signing keys |
+ +-----------------------+---------+------------------------------------------------+
+ | ``zskExpirationDays`` | string | Expiration (in days) for the zone signing keys |
+ +-----------------------+---------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "cdn1",
+ "name" "ott.kabletown.com",
+ "ttl": "60",
+ "kskExpirationDays": "365",
+ "zskExpirationDays": "90"
+ }
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+
+ {
+ "response": "Successfully created dnssec keys for cdn1"
+ }
+
diff --git a/docs/latest/_sources/api/v11/changelog.rst.txt b/docs/latest/_sources/api/v11/changelog.rst.txt
new file mode 100644
index 0000000..22b1ff1
--- /dev/null
+++ b/docs/latest/_sources/api/v11/changelog.rst.txt
@@ -0,0 +1,154 @@
+..
+..
+.. 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-v11-change-logs:
+
+Change Logs
+===========
+
+.. _to-api-v11-change-logs-route:
+
+/api/1.1/logs
++++++++++++++
+
+**GET /api/1.1/logs.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+==========================================================================+
+ | ``ticketNum`` | string | Optional field to cross reference with any bug tracking systems |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``level`` | string | Log categories for each entry, examples: 'UICHANGE', 'OPER', 'APICHANGE'.|
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | Local unique identifier for the Log |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``user`` | string | Current user who made the change that was logged |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``id`` | string | Local unique identifier for the Log entry |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``message`` | string | Log detail about what occurred |
+ +-----------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "ticketNum": null,
+ "level": "OPER",
+ "lastUpdated": "2015-02-04 22:59:13",
+ "user": "userid852",
+ "id": "22661",
+ "message": "Snapshot CRConfig created."
+ },
+ {
+ "ticketNum": null,
+ "level": "APICHANGE",
+ "lastUpdated": "2015-02-03 17:04:20",
+ "user": "userid853",
+ "id": "22658",
+ "message": "Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"
+ },
+ ],
+ }
+
+|
+
+**GET /api/1.1/logs/:days/days.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-----------------+
+ | Name | Required | Description |
+ +==========+==========+=================+
+ | ``days`` | yes | Number of days. |
+ +----------+----------+-----------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``ticketNum`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``level`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``user`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``message`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "ticketNum": null,
+ "level": "OPER",
+ "lastUpdated": "2015-02-04 22:59:13",
+ "user": "userid852",
+ "id": "22661",
+ "message": "Snapshot CRConfig created."
+ },
+ {
+ "ticketNum": null,
+ "level": "APICHANGE",
+ "lastUpdated": "2015-02-03 17:04:20",
+ "user": "userid853",
+ "id": "22658",
+ "message": "Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/logs/newcount.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``newLogcount`` | int | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "newLogcount": 0
+ }
+ }
+
diff --git a/docs/latest/_sources/api/v11/deliveryservice.rst.txt b/docs/latest/_sources/api/v11/deliveryservice.rst.txt
new file mode 100644
index 0000000..1d01d61
--- /dev/null
+++ b/docs/latest/_sources/api/v11/deliveryservice.rst.txt
@@ -0,0 +1,1286 @@
+..
+..
+.. 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-v11-ds:
+
+Delivery Service
+================
+
+.. _to-api-v11-ds-route:
+
+/api/1.1/deliveryservices
++++++++++++++++++++++++++
+
+**GET /api/1.1/deliveryservices**
+
+ Retrieves all delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "signingAlgorithm": null,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/deliveryservices/:id**
+
+ Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "signingAlgorithm": null,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ ]
+ }
+
+|
+
+
+.. _to-api-v11-ds-health:
+
+Health
+++++++
+
+**GET /api/1.1/deliveryservices/:id/state.json**
+
+ Retrieves the failover state for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+---------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+=================================================+
+ | ``failover`` | hash | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>locations`` | array | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>destination`` | string | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>configured`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>enabled`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+ | ``enabled`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "failover": {
+ "locations": [ ],
+ "destination": null,
+ "configured": false,
+ "enabled": false
+ },
+ "enabled": true
+ }
+ }
+
+|
+
+**GET /api/1.1/deliveryservices/:id/health.json**
+
+ Retrieves the health of all locations (cache groups) for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ }
+ }
+
+
+|
+
+**GET /api/1.1/deliveryservices/:id/capacity.json**
+
+ Retrieves the capacity percentages of a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +========================+========+===================================================+
+ | ``availablePercent`` | number | The percentage of server capacity assigned to |
+ | | | the delivery service that is available. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``unavailablePercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service that is unavailable. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``utilizedPercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service being used. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``maintenancePercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service that is down for maintenance. |
+ +------------------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "availablePercent": 89.0939840205533,
+ "unavailablePercent": 0,
+ "utilizedPercent": 10.9060020300395,
+ "maintenancePercent": 0.0000139494071146245
+ },
+ }
+
+
+|
+
+**GET /api/1.1/deliveryservices/:id/routing.json**
+
+ Retrieves the routing method percentages of a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+=============================================================================================================================+
+ | ``staticRoute`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``miss`` | number | The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP). |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``geo`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``err`` | number | The percentage of Traffic Router requests for this deliveryservice resulting in an error. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``cz`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF hit. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``dsr`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the |
+ | | | client to the overflow CDN. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "staticRoute": 0,
+ "miss": 0,
+ "geo": 37.8855391018869,
+ "err": 0,
+ "cz": 62.1144608981131,
+ "dsr": 0
+ },
+ }
+
+|
+
+.. _to-api-v11-ds-metrics:
+
+Metrics
++++++++
+
+**GET /api/1.1/deliveryservices/:id/server_types/:type/metric_types/start_date/:start/end_date/:end.json**
+
+ Retrieves detailed and summary metrics for MIDs or EDGEs for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+=============================================================================+
+ | ``id`` | yes | The delivery service id. |
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | ``server_types`` | yes | EDGE or MID. |
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | ``metric_types`` | yes | One of the following: "kbps", "tps", "tps_2xx", "tps_3xx", "tps_4xx", |
+ | | | "tps_5xx". |
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | ``start_date`` | yes | UNIX time |
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | ``end_date`` | yes | UNIX time |
+ +------------------+----------+-----------------------------------------------------------------------------+
+
+ **Request Query Parameters**
+
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+=============================================================================+
+ | ``stats`` | no | Flag used to return only summary metrics |
+ +------------------+----------+-----------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+-------------+
+ | Parameter | Type | Description |
+ +======================+========+=============+
+ | ``stats`` | hash | |
+ +----------------------+--------+-------------+
+ | ``>>count`` | int | |
+ +----------------------+--------+-------------+
+ | ``>>98thPercentile`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>min`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>max`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>5thPercentile`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>95thPercentile`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>median`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>mean`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>stddev`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>sum`` | number | |
+ +----------------------+--------+-------------+
+ | ``data`` | array | |
+ +----------------------+--------+-------------+
+ | ``>>item`` | array | |
+ +----------------------+--------+-------------+
+ | ``>>time`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>value`` | number | |
+ +----------------------+--------+-------------+
+ | ``label`` | string | |
+ +----------------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "stats": {
+ "count": 988,
+ "98thPercentile": 16589105.55958,
+ "min": 3185442.975,
+ "max": 17124754.257,
+ "5thPercentile": 3901253.95445,
+ "95thPercentile": 16013210.034,
+ "median": 8816895.576,
+ "mean": 8995846.31741194,
+ "stddev": 3941169.83683573,
+ "sum": 333296106.060112
+ },
+ "data": [
+ [
+ 1414303200000,
+ 12923518.466
+ ],
+ [
+ 1414303500000,
+ 12625139.65
+ ]
+ ],
+ "label": "MID Kbps"
+ }
+ ],
+ }
+
+
+.. _to-api-v11-ds-server:
+
+Server
+++++++
+
+**GET /api/1.1/deliveryserviceserver.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: Yes
+
+ **Request Query Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``page`` | no | The page number for use in pagination. |
+ +-----------+----------+----------------------------------------+
+ | ``limit`` | no | For use in limiting the result set. |
+ +-----------+----------+----------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``lastUpdated`` | array | |
+ +----------------------+--------+------------------------------------------------+
+ |``server`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``deliveryService`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "page": 2,
+ "orderby": "deliveryservice",
+ "response": [
+ {
+ "lastUpdated": "2014-09-26 17:53:43",
+ "server": "20",
+ "deliveryService": "1"
+ },
+ {
+ "lastUpdated": "2014-09-26 17:53:44",
+ "server": "21",
+ "deliveryService": "1"
+ },
+ ],
+ "limit": 2
+ }
+
+|
+
+.. _to-api-v11-ds-sslkeys:
+
+SSL Keys
++++++++++
+
+**GET /api/1.1/deliveryservices/xmlId/:xmlid/sslkeys.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------+
+ | Name | Required | Description |
+ +=============+==========+================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded crt file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded csr file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded private key file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "certificate": {
+ "crt": "crt",
+ "key": "key",
+ "csr": "csr"
+ },
+ "businessUnit": "CDN_Eng",
+ "city": "Denver",
+ "organization": "KableTown",
+ "hostname": "foober.com",
+ "country": "US",
+ "state": "Colorado",
+ "version": "1"
+ }
+ }
+
+|
+
+**GET /api/1.1/deliveryservices/hostname/:hostname/sslkeys.json**
+
+ Authentication Required: Yes
+
+ Role Required: Admin
+
+ **Request Route Parameters**
+
+ +--------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+===================================================+
+ | ``hostname`` | yes | pristine hostname of the desired delivery service |
+ +--------------+----------+---------------------------------------------------+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------+
+ | Name | Required | Description |
+ +=============+==========+================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded crt file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded csr file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded private key file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "certificate": {
+ "crt": "crt",
+ "key": "key",
+ "csr": "csr"
+ },
+ "businessUnit": "CDN_Eng",
+ "city": "Denver",
+ "organization": "KableTown",
+ "hostname": "foober.com",
+ "country": "US",
+ "state": "Colorado",
+ "version": "1"
+ }
+ }
+
+|
+
+**GET /api/1.1/deliveryservices/xmlId/:xmlid/sslkeys/delete.json**
+
+ Authentication Required: Yes
+
+ Role Required: Operations
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------+
+ | Name | Required | Description |
+ +=============+==========+================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +--------------+--------+------------------+
+ | Parameter | Type | Description |
+ +==============+========+==================+
+ | ``response`` | string | success response |
+ +--------------+--------+------------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully deleted ssl keys for <xml_id>"
+ }
+
+|
+
+**POST /api/1.1/deliveryservices/sslkeys/generate**
+
+ Generates SSL crt, csr, and private key for a delivery service
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations
+
+ **Request Properties**
+
+ +--------------+---------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============+=========+=================================================+
+ | ``key`` | string | xml_id of the delivery service |
+ +--------------+---------+-------------------------------------------------+
+ | ``version`` | string | version of the keys being generated |
+ +--------------+---------+-------------------------------------------------+
+ | ``hostname`` | string | the *pristine hostname* of the delivery service |
+ +--------------+---------+-------------------------------------------------+
+ | ``country`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``state`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``city`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``org`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``unit`` | boolean | |
+ +--------------+---------+-------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "ds-01",
+ "businessUnit": "CDN Engineering",
+ "version": "3",
+ "hostname": "tr.ds-01.ott.kabletown.com",
+ "certificate": {
+ "key": "some_key",
+ "csr": "some_csr",
+ "crt": "some_crt"
+ },
+ "country": "US",
+ "organization": "Kabletown",
+ "city": "Denver",
+ "state": "Colorado"
+ }
+
+|
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully created ssl keys for ds-01"
+ }
+
+|
+
+**POST /api/1.1/deliveryservices/sslkeys/add**
+
+ Allows user to add SSL crt, csr, and private key for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations
+
+ **Request Properties**
+
+ +-------------+--------+-------------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+=====================================+
+ | ``key`` | string | xml_id of the delivery service |
+ +-------------+--------+-------------------------------------+
+ | ``version`` | string | version of the keys being generated |
+ +-------------+--------+-------------------------------------+
+ | ``csr`` | string | |
+ +-------------+--------+-------------------------------------+
+ | ``crt`` | string | |
+ +-------------+--------+-------------------------------------+
+ | ``key`` | string | |
+ +-------------+--------+-------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "ds-01",
+ "version": "1",
+ "certificate": {
+ "key": "some_key",
+ "csr": "some_csr",
+ "crt": "some_crt"
+ }
+ }
+
+|
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully added ssl keys for ds-01"
+ }
+
+
+|
+
+**POST /api/1.1/deliveryservices/request**
+
+ Allows a user to send delivery service request details to a specified email address.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | Parameter | Type | Required | Description |
+ +========================================+========+==========+=============================================================================================+
+ | ``emailTo`` | string | yes | The email to which the delivery service request will be sent. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``details`` | hash | yes | Parameters for the delivery service request. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>customer`` | string | yes | Name of the customer to associated with the delivery service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>deliveryProtocol`` | string | yes | Eg. http or http/https |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>routingType`` | string | yes | Eg. DNS or HTTP Redirect |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>serviceDesc`` | string | yes | A description of the delivery service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>peakBPSEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>peakTPSEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>maxLibrarySizeEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>originURL`` | string | yes | The URL path to the origin server. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>hasOriginDynamicRemap`` | bool | yes | This is a feature which allows services to use multiple origin URLs for the same service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>originTestFile`` | string | yes | A URL path to a test file available on the origin server. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>hasOriginACLWhitelist`` | bool | yes | Is access to your origin restricted using an access control list (ACL or whitelist) of Ips? |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>originHeaders`` | string | no | Header values that must be passed to requests to your origin. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>otherOriginSecurity`` | string | no | Other origin security measures that need to be considered for access. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>queryStringHandling`` | string | yes | How to handle query strings that come with the request. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>rangeRequestHandling`` | string | yes | How to handle range requests. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>hasSignedURLs`` | bool | yes | Are Urls signed? |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>hasNegativeCachingCustomization`` | bool | yes | Any customization required for negative caching? |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>negativeCachingCustomizationNote`` | string | yes | Negative caching customization instructions. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>serviceAliases`` | array | no | Service aliases which will be used for this service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>rateLimitingGBPS`` | int | no | Rate Limiting - Bandwidth (Gigabits per second) |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>rateLimitingTPS`` | int | no | Rate Limiting - Transactions/Second |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>overflowService`` | string | no | An overflow point (URL or IP address) used if rate limits are met. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>headerRewriteEdge`` | string | no | Headers can be added or altered at each layer of the CDN. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>headerRewriteMid`` | string | no | Headers can be added or altered at each layer of the CDN. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>headerRewriteRedirectRouter`` | string | no | Headers can be added or altered at each layer of the CDN. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>notes`` | string | no | Additional instructions to provide the delivery service provisioning team. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "emailTo": "foo@bar.com",
+ "details": {
+ "customer": "XYZ Corporation",
+ "contentType": "video-on-demand",
+ "deliveryProtocol": "http",
+ "routingType": "dns",
+ "serviceDesc": "service description goes here",
+ "peakBPSEstimate": "less-than-5-Gbps",
+ "peakTPSEstimate": "less-than-1000-TPS",
+ "maxLibrarySizeEstimate": "less-than-200-GB",
+ "originURL": "http://myorigin.com",
+ "hasOriginDynamicRemap": false,
+ "originTestFile": "http://myorigin.com/crossdomain.xml",
+ "hasOriginACLWhitelist": true,
+ "originHeaders": "",
+ "otherOriginSecurity": "",
+ "queryStringHandling": "ignore-in-cache-key-and-pass-up",
+ "rangeRequestHandling": "range-requests-not-used",
+ "hasSignedURLs": true,
+ "hasNegativeCachingCustomization": true,
+ "negativeCachingCustomizationNote": "negative caching instructions",
+ "serviceAliases": [
+ "http://alias1.com",
+ "http://alias2.com"
+ ],
+ "rateLimitingGBPS": 50,
+ "rateLimitingTPS": 5000,
+ "overflowService": "http://overflowcdn.com",
+ "headerRewriteEdge": "",
+ "headerRewriteMid": "",
+ "headerRewriteRedirectRouter": "",
+ "notes": ""
+ }
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Delivery Service request sent to foo@bar.com."
+ }
+ ]
+ }
+
+|
diff --git a/docs/latest/_sources/api/v11/hwinfo.rst.txt b/docs/latest/_sources/api/v11/hwinfo.rst.txt
new file mode 100644
index 0000000..cc45b38
--- /dev/null
+++ b/docs/latest/_sources/api/v11/hwinfo.rst.txt
@@ -0,0 +1,67 @@
+..
+..
+.. 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-v11-hwinfo:
+
+Hardware Info
+=============
+
+.. _to-api-v11-hwinfo-route:
+
+/api/1.1/hwinfo
++++++++++++++++
+
+**GET /api/1.1/hwinfo.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------+--------+----------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+======================================================================+
+ | ``serverId`` | string | Local unique identifier for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``serverHostName`` | string | Hostname for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``val`` | string | Freeform value used to track anything about a server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``description`` | string | Freeform description for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:0"
+ },
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:1"
+ }
+ ],
+ }
+
diff --git a/docs/latest/_sources/api/v11/index.rst.txt b/docs/latest/_sources/api/v11/index.rst.txt
new file mode 100644
index 0000000..bb50b22
--- /dev/null
+++ b/docs/latest/_sources/api/v11/index.rst.txt
@@ -0,0 +1,40 @@
+..
+..
+.. 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.
+..
+
+API 1.1 Reference
+*****************
+Traffic Ops v1.1 API Documentation
+
+.. toctree::
+ :maxdepth: 1
+
+ asn
+ cachegroup
+ cdn
+ changelog
+ deliveryservice
+ hwinfo
+ parameter
+ phys_location
+ profile
+ region
+ role
+ server
+ static_dns
+ status
+ system
+ to_extension
+ type
+ user
diff --git a/docs/latest/_sources/api/v11/parameter.rst.txt b/docs/latest/_sources/api/v11/parameter.rst.txt
new file mode 100644
index 0000000..1b83d01
--- /dev/null
+++ b/docs/latest/_sources/api/v11/parameter.rst.txt
@@ -0,0 +1,136 @@
+..
+..
+.. 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-v11-parameter:
+
+Parameter
+=========
+
+.. _to-api-v11-parameters-route:
+
+/api/1.1/parameters
++++++++++++++++++++
+
+**GET /api/1.1/parameters.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/parameters/profile/:name.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-------------+
+ | Name | Required | Description |
+ +==================+==========+=============+
+ | ``profile_name`` | yes | |
+ +------------------+----------+-------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+
diff --git a/docs/latest/_sources/api/v11/phys_location.rst.txt b/docs/latest/_sources/api/v11/phys_location.rst.txt
new file mode 100644
index 0000000..6ebaff0
--- /dev/null
+++ b/docs/latest/_sources/api/v11/phys_location.rst.txt
@@ -0,0 +1,449 @@
+..
+..
+.. 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-v11-phys-loc:
+
+Physical Location
+=================
+
+.. _to-api-v11-phys-loc-route:
+
+/api/1.1/phys_locations
++++++++++++++++++++++++
+
+**GET /api/1.1/phys_locations**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ },
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/phys_locations/trimmed.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+=========+================================================+
+ |``name`` | string | |
+ +----------------------+---------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "Albuquerque"
+ },
+ {
+ "name": "Ashburn"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/phys_locations/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Physical location ID. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.1/phys_locations/:id**
+ Update a physical location
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Physical location id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+================================================+
+ | ``address`` | yes | Physical location address. |
+ +-------------------+----------+------------------------------------------------+
+ | ``city`` | yes | Physical location city. |
+ +-------------------+----------+------------------------------------------------+
+ | ``comments`` | no | Physical location comments. |
+ +-------------------+----------+------------------------------------------------+
+ | ``email`` | no | Physical location email. |
+ +-------------------+----------+------------------------------------------------+
+ | ``name`` | yes | Physical location name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``phone`` | no | Physical location phone. |
+ +-------------------+----------+------------------------------------------------+
+ | ``poc`` | no | Physical location point of contact. |
+ +-------------------+----------+------------------------------------------------+
+ | ``regionId`` | no | Physical location region ID. |
+ +-------------------+----------+------------------------------------------------+
+ | ``shortName`` | yes | Physical location short name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``state`` | yes | Physical location state. |
+ +-------------------+----------+------------------------------------------------+
+ | ``zip`` | yes | Physical location zip. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "regionId": "1",
+ "poc": "Jane Doesssss",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "address": "123 East 9rd St",
+ "shortName": "Albuquerque"
+ }
+
+|
+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Physical location update was successful."
+ }
+ ],
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.1/regions/:region_name/phys_locations**
+ Create physical location.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ region_name: the name of the region to create physical location into.
+
+ **Request Route Parameters**
+
+ +-----------------+----------+-----------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================+
+ | ``region_name`` | yes | The name of the physical location |
+ +-----------------+----------+-----------------------------------+
+
+ **Request Properties**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | yes | The name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``shortName`` | yes | The short name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``address`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``city`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``state`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``zip`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``phone`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``poc`` | no | Point of contact |
+ +-----------------+----------+---------------------------------------------------+
+ | ``email`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``comments`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name" : "my physical location1",
+ "shortName" : "myphylocation1",
+ "address" : "",
+ "city" : "Shanghai",
+ "state": "SH",
+ "zip": "200000",
+ "comments": "this is physical location1"
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+===================================================+
+ | ``id`` | string | The id of the physical location created. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``name`` | string | The name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``shortName`` | string | The short name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionName`` | string | The region name the physical location belongs to. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionId`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``address`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``city`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``state`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``zip`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``phone`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``poc`` | string | Point of contact |
+ +-----------------+--------+---------------------------------------------------+
+ | ``email`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``comments`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v11/profile.rst.txt b/docs/latest/_sources/api/v11/profile.rst.txt
new file mode 100644
index 0000000..5c37690
--- /dev/null
+++ b/docs/latest/_sources/api/v11/profile.rst.txt
@@ -0,0 +1,129 @@
+..
+..
+.. 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-v11-profile:
+
+Profiles
+========
+
+.. _to-api-v11-profiles-route:
+
+/api/1.1/profiles
++++++++++++++++++
+
+**GET /api/1.1/profiles**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/profiles/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "CCR_TOP"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/profiles/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+------------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+============+================================================+
+ | ``id`` | yes | The ID of the profile. |
+ +-----------------+------------+------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v11/region.rst.txt b/docs/latest/_sources/api/v11/region.rst.txt
new file mode 100644
index 0000000..d521f33
--- /dev/null
+++ b/docs/latest/_sources/api/v11/region.rst.txt
@@ -0,0 +1,235 @@
+..
+..
+.. 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-v11-region:
+
+Regions
+=======
+
+.. _to-api-v11-regions-route:
+
+/api/1.1/regions
+++++++++++++++++
+
+**GET /api/1.1/regions**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
+ },
+ {
+ "id": "7",
+ "name": "Denver",
+ "division": "2",
+ "divisionName": "West"
+ },
+ ]
+ }
+
+
+**GET /api/1.1/regions/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Region id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
+ }
+ ]
+ }
+
+
+**PUT /api/1.1/regions/:id**
+ Update a region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Region id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +================+==========+==========================+
+ | ``name`` | yes | The name of the region |
+ +----------------+----------+--------------------------+
+ | ``division`` | yes | The division Id |
+ +----------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ "division": "4"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``division`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Region update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "myregion1",
+ "division": "4",
+ "divisionName": "mydivision1"
+ }
+ }
+
+
+**POST /api/1.1/divisions/:division_name/regions**
+ Create Region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ division_name - The name of division to create new region into.
+
+ ** Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +===================+==========+================================================+
+ | ``division_name`` | yes | The name of division will create new region in |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+==========================================+
+ | ``name`` | yes | The name of the region |
+ +-------------------+----------+------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+===========================================+
+ | ``name`` | string | name of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``id`` | string | id of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionName`` | string | the division name the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionId`` | string | the id of division the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'divisionName': 'mydivision1',
+ 'divsionId': '4',
+ 'name': 'myregion1',
+ 'id': '19'
+ }
+ }
+
+|
diff --git a/docs/latest/_sources/api/v11/role.rst.txt b/docs/latest/_sources/api/v11/role.rst.txt
new file mode 100644
index 0000000..bf3337c
--- /dev/null
+++ b/docs/latest/_sources/api/v11/role.rst.txt
@@ -0,0 +1,58 @@
+..
+..
+.. 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-v11-roles:
+
+Roles
+=====
+
+.. _to-api-v11-roles-route:
+
+/api/1.1/roles
+++++++++++++++
+
+**GET /api/1.1/roles.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``privLevel`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "read-only",
+ "id": "2",
+ "privLevel": "10",
+ "description": "read-only user"
+ }
+ ],
+ }
+
diff --git a/docs/latest/_sources/api/v11/server.rst.txt b/docs/latest/_sources/api/v11/server.rst.txt
new file mode 100644
index 0000000..44f1292
--- /dev/null
+++ b/docs/latest/_sources/api/v11/server.rst.txt
@@ -0,0 +1,630 @@
+..
+..
+.. 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-v11-server:
+
+Server
+======
+
+.. _to-api-v11-servers-route:
+
+/api/1.1/servers
+++++++++++++++++
+
+**GET /api/1.1/servers**
+
+ Retrieves properties of CDN servers.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+=============================================+
+ | ``dsId`` | no | Used to filter servers by delivery service. |
+ +--------------------+----------+---------------------------------------------+
+ | ``status`` | no | Used to filter servers by status. |
+ +--------------------+----------+---------------------------------------------+
+ | ``type`` | no | Used to filter servers by type. |
+ +--------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/servers/:id**
+
+ Retrieves properties of a CDN server by server ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Server id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/servers/summary**
+
+ Retrieves a count of CDN servers by type.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------+--------+------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===========+========+========================================================================+
+ | ``count`` | int | The number of servers of this type in this instance of Traffic Ops. |
+ +-----------+--------+------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of the server count (see :ref:`to-api-v11-type`). |
+ +-----------+--------+------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "count": 4,
+ "type": "CCR"
+ },
+ {
+ "count": 55,
+ "type": "EDGE"
+ },
+ {
+ "type": "MID",
+ "count": 18
+ },
+ {
+ "count": 0,
+ "type": "INFLUXDB"
+ },
+ {
+ "count": 4,
+ "type": "RASCAL"
+ }
+ }
+
+|
+
+**GET /api/1.1/servers/hostname/:name/details**
+
+ Retrieves the details of a server.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+----------------------------------+
+ | Name | Required | Description |
+ +==========+==========+==================================+
+ | ``name`` | yes | The host name part of the cache. |
+ +----------+----------+----------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``deliveryservices`` | array | Array of strings with the delivery service ids assigned (see :ref:`to-api-v11-ds`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``hardwareInfo`` | hash | Hwinfo struct (see :ref:`to-api-v11-hwinfo`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time/Date of the last update for this server. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The default HTTPS port on which the main application listens (443 for a cache in most cases). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``xmppId`` | string | Deprecated. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``xmppPasswd`` | string | Deprecated. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroup": "us-il-chicago",
+ "deliveryservices": [
+ "1",
+ "2",
+ "3",
+ "4"
+ ],
+ "domainName": "chi.kabletown.net",
+ "hardwareInfo": {
+ "Physical Disk 0:1:3": "D1S2",
+ "Physical Disk 0:1:2": "D1S2",
+ "Physical Disk 0:1:15": "D1S2",
+ "Power Supply.Slot.2": "04.07.15",
+ "Physical Disk 0:1:24": "YS08",
+ "Physical Disk 0:1:1": "D1S2",
+ "Model": "PowerEdge R720xd",
+ "Physical Disk 0:1:22": "D1S2",
+ "Physical Disk 0:1:18": "D1S2",
+ "Enterprise UEFI Diagnostics": "4217A5",
+ "Lifecycle Controller": "1.0.8.42",
+ "Physical Disk 0:1:8": "D1S2",
+ "Manufacturer": "Dell Inc.",
+ "Physical Disk 0:1:6": "D1S2",
+ "SysMemTotalSize": "196608",
+ "PopulatedDIMMSlots": "24",
+ "Physical Disk 0:1:20": "D1S2",
+ "Intel(R) Ethernet 10G 2P X520 Adapter": "13.5.7",
+ "Physical Disk 0:1:14": "D1S2",
+ "BACKPLANE FIRMWARE": "1.00",
+ "Dell OS Drivers Pack, 7.0.0.29, A00": "7.0.0.29",
+ "Integrated Dell Remote Access Controller": "1.57.57",
+ "Physical Disk 0:1:5": "D1S2",
+ "ServiceTag": "D6XPDV1",
+ "PowerState": "2",
+ "Physical Disk 0:1:23": "D1S2",
+ "Physical Disk 0:1:25": "D903",
+ "BIOS": "1.3.6",
+ "Physical Disk 0:1:12": "D1S2",
+ "System CPLD": "1.0.3",
+ "Physical Disk 0:1:4": "D1S2",
+ "Physical Disk 0:1:0": "D1S2",
+ "Power Supply.Slot.1": "04.07.15",
+ "PERC H710P Mini": "21.0.2-0001",
+ "PowerCap": "689",
+ "Physical Disk 0:1:16": "D1S2",
+ "Physical Disk 0:1:10": "D1S2",
+ "Physical Disk 0:1:11": "D1S2",
+ "Lifecycle Controller 2": "1.0.8.42",
+ "BP12G+EXP 0:1": "1.07",
+ "Physical Disk 0:1:9": "D1S2",
+ "Physical Disk 0:1:17": "D1S2",
+ "Broadcom Gigabit Ethernet BCM5720": "7.2.20",
+ "Physical Disk 0:1:21": "D1S2",
+ "Physical Disk 0:1:13": "D1S2",
+ "Physical Disk 0:1:7": "D1S2",
+ "Physical Disk 0:1:19": "D1S2"
+ },
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "physLocation": "plocation-chi-1",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "xmppId": "atsec-chi-00-dummyxmpp",
+ "xmppPasswd": "X"
+
+ }
+ }
+
+|
+
+**POST /api/1.1/servercheck**
+
+ Post a server check result to the serverchecks table.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------------------+----------+-------------+
+ | Name | Required | Description |
+ +============================+==========+=============+
+ | ``id`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``host_name`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``servercheck_short_name`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``value`` | yes | |
+ +----------------------------+----------+-------------+
+
+ **Request Example** ::
+
+ {
+ "id": "",
+ "host_name": "",
+ "servercheck_short_name": "",
+ "value": ""
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+
+ Response Example:
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Server Check was successfully updated."
+ }
+ ],
+ }
+
diff --git a/docs/latest/_sources/api/v11/static_dns.rst.txt b/docs/latest/_sources/api/v11/static_dns.rst.txt
new file mode 100644
index 0000000..c9d3a3d
--- /dev/null
+++ b/docs/latest/_sources/api/v11/static_dns.rst.txt
@@ -0,0 +1,63 @@
+..
+..
+.. 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-v11-dns:
+
+Static DNS Entries
+==================
+
+.. _to-api-v11-static-dns-route:
+
+/api/1.1/staticdnsentries
++++++++++++++++++++++++++
+
+**GET /api/1.1/staticdnsentries.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +---------------------+-----------+------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+===========+============================================================+
+ | ``deliveryservice`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``ttl`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``type`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``address`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``cachegroup`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``host`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "deliveryservice": "foo-ds",
+ "ttl": "30",
+ "type": "CNAME_RECORD",
+ "address": "bar.foo.baz.tv.",
+ "cachegroup": "us-co-denver",
+ "host": "mm"
+ }
+ ]
+ }
diff --git a/docs/latest/_sources/api/v11/status.rst.txt b/docs/latest/_sources/api/v11/status.rst.txt
new file mode 100644
index 0000000..6a8c92a
--- /dev/null
+++ b/docs/latest/_sources/api/v11/status.rst.txt
@@ -0,0 +1,127 @@
+..
+..
+.. 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-v11-status:
+
+Status
+======
+
+.. _to-api-v11-statuses-route:
+
+/api/1.1/statuses
++++++++++++++++++
+
+**GET /api/1.1/statuses**
+
+ Retrieves a list of the server status codes available.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "5",
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "1",
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "2",
+ "name": "ONLINE",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "3",
+ "name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
+**GET /api/1.1/statuses/:id**
+
+ Retrieves a server status by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Status id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
diff --git a/docs/latest/_sources/api/v11/system.rst.txt b/docs/latest/_sources/api/v11/system.rst.txt
new file mode 100644
index 0000000..c4e53df
--- /dev/null
+++ b/docs/latest/_sources/api/v11/system.rst.txt
@@ -0,0 +1,79 @@
+..
+..
+.. 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-v11-sys:
+
+System
+======
+
+.. _to-api-v11-sys-route:
+
+/api/1.1/system
++++++++++++++++
+
+**GET /api/1.1/system/info.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Key | Type | Description |
+ +============================+========+======================================================================================================================================+
+ | ``parameters`` | hash | This is a hash with the parameter names that describe the Traffic Ops installation as keys. |
+ | | | These are all the parameters in the ``GLOBAL`` profile. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.toolname`` | string | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated |
+ | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.instance_name`` | string | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>traffic_rtr_fwd_proxy`` | string | When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through. |
+ | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
+ | | | this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to |
+ | | | set this parameter on a production system. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.url`` | string | The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated |
+ | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>traffic_mon_fwd_proxy`` | string | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. |
+ | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
+ | | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to |
+ | | | set this parameter on a production system. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.logourl`` | string | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.infourl`` | string | This is the "for more information go here" URL, which is visible in the About page. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "parameters": {
+ "tm.toolname": "Traffic Ops",
+ "tm.infourl": "http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info",
+ "traffic_mon_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
+ "traffic_rtr_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
+ "tm.logourl": "\/images\/tc_logo.png",
+ "tm.url": "https:\/\/tm.kabletown.net\/",
+ "tm.instance_name": "Kabletown CDN"
+ }
+ },
+ }
+
+
diff --git a/docs/latest/_sources/api/v11/to_extension.rst.txt b/docs/latest/_sources/api/v11/to_extension.rst.txt
new file mode 100644
index 0000000..5ed2654
--- /dev/null
+++ b/docs/latest/_sources/api/v11/to_extension.rst.txt
@@ -0,0 +1,210 @@
+..
+..
+.. 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-v11-ext:
+
+TO Extensions
+=============
+
+.. _to-api-v11-ext-route:
+
+/api/1.1/to_extensions
+++++++++++++++++++++++
+
+**GET /api/1.1/to_extensions.json**
+
+Retrieves the list of extensions.
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+**Response Properties**
+
++--------------------------+--------+--------------------------------------------+
+| 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"
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.1/to_extensions**
+
+ Creates a Traffic Ops extension.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **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 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."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.1/to_extensions/:id/delete**
+
+ Deletes a Traffic Ops extension.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +--------+----------+-----------------+
+ | Name | Required | Description |
+ +========+==========+=================+
+ | ``id`` | yes | TO extension id |
+ +--------+----------+-----------------+
+
+ **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."
+ }
+ ],
+ }
+
+
+|
+
diff --git a/docs/latest/_sources/api/v11/type.rst.txt b/docs/latest/_sources/api/v11/type.rst.txt
new file mode 100644
index 0000000..6c7806b
--- /dev/null
+++ b/docs/latest/_sources/api/v11/type.rst.txt
@@ -0,0 +1,151 @@
+..
+..
+.. 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-v11-type:
+
+Types
+=====
+
+.. _to-api-v11-types-route:
+
+/api/1.1/types
+++++++++++++++
+
+**GET /api/1.1/types**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``useInTable`` | no | Filter types by the table in which they apply |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
+
+**GET /api/1.1/types/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "AAAA_RECORD"
+ },
+ {
+ "name": "ACTIVE_DIRECTORY"
+ },
+ {
+ "name": "A_RECORD"
+ },
+ {
+ "name": "CCR"
+ }
+ ],
+ }
+
+**GET /api/1.1/types/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``id`` | yes | Type ID. |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
diff --git a/docs/latest/_sources/api/v11/user.rst.txt b/docs/latest/_sources/api/v11/user.rst.txt
new file mode 100644
index 0000000..2ef5012
--- /dev/null
+++ b/docs/latest/_sources/api/v11/user.rst.txt
@@ -0,0 +1,778 @@
+..
+..
+.. 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-v11-users:
+
+Users
+=====
+
+.. _to-api-v11-users-route:
+
+/api/1.1/users
+++++++++++++++
+
+**GET /api/1.1/users**
+
+ Retrieves all users.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/users/:id**
+
+ Retrieves user by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | User id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/user/current**
+
+ Retrieves the profile for the authenticated user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``localUser`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "email": "email@email.com",
+ "city": "",
+ "id": "50",
+ "phoneNumber": "",
+ "company": "",
+ "country": "",
+ "fullName": "Tom Callahan",
+ "localUser": true,
+ "uid": "0",
+ "stateOrProvince": "",
+ "username": "tommyboy",
+ "newUser": false,
+ "addressLine2": "",
+ "role": "6",
+ "addressLine1": "",
+ "gid": "0",
+ "postalCode": ""
+ },
+ }
+
+|
+
+**POST /api/1.1/user/current/update**
+
+ Updates the date for the authenticated user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``localUser`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "user": {
+ "email": "",
+ "city": "",
+ "id": "",
+ "phoneNumber": "",
+ "company": "",
+ "country": "",
+ "fullName": "",
+ "localUser": true,
+ "uid": "0",
+ "stateOrProvince": "",
+ "username": "tommyboy",
+ "newUser": false,
+ "addressLine2": "",
+ "role": "6",
+ "addressLine1": "",
+ "gid": "0",
+ "postalCode": ""
+ }
+ }
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "UserProfile was successfully updated."
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/user/current/jobs.json**
+
+ Retrieves the user's list of jobs.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+========================================+
+ | ``keyword`` | no | PURGE |
+ +--------------+----------+----------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``keyword`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``objectName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``assetUrl`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``assetType`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``status`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``dsId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``dsXmlId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``parameters`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``enteredTime`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``objectType`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``agent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``startTime`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example**
+ ::
+
+ {
+ "response": [
+ {
+ "id": "1",
+ "keyword": "PURGE",
+ "objectName": null,
+ "assetUrl": "",
+ "assetType": "file",
+ "status": "PENDING",
+ "dsId": "9999",
+ "dsXmlId": "ds-xml-id",
+ "username": "peewee",
+ "parameters": "TTL:56h",
+ "enteredTime": "2015-01-21 18:00:16",
+ "objectType": null,
+ "agent": "",
+ "startTime": "2015-01-21 10:45:38"
+ }
+ ],
+ }
+
+
+|
+
+**POST/api/1.1/user/current/jobs**
+
+Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
+
+.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
+
+Authentication Required: Yes
+
+Role(s) Required: Yes
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``dsId`` | string | Unique Delivery Service ID |
+ +----------------------+--------+------------------------------------------------+
+ |``regex`` | string | Path Regex this should be a |
+ | | | `PCRE <http://www.pcre.org/>`_ compatible |
+ | | | regular expression for the path to match for |
+ | | | forcing the revalidation. Be careful to only |
+ | | | match on the content you need to remove - |
+ | | | revalidation is an expensive operation for |
+ | | | many origins, and a simple ``/.*`` can cause |
+ | | | an overload condition of the origin. |
+ +----------------------+--------+------------------------------------------------+
+ |``startTime`` | string | Start Time is the time when the revalidation |
+ | | | rule will be made active. Populate |
+ | | | with the current time to schedule ASAP. |
+ +----------------------+--------+------------------------------------------------+
+ |``ttl`` | int | Time To Live is how long the revalidation rule |
+ | | | will be active for in hours. It usually makes |
+ | | | sense to make this the same as the |
+ | | | ``Cache-Control`` header from the origin which |
+ | | | sets the object time to live in cache |
+ | | | (by ``max-age`` or ``Expires``). Entering a |
+ | | | longer TTL here will make the caches do |
+ | | | unnecessary work. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "dsId": "9999",
+ "regex": "/path/to/content.jpg",
+ "startTime": "2015-01-27 11:08:37",
+ "ttl": 54
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Successfully created purge job for: ."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.1/user/login**
+
+ Authentication of a user using username and password. Traffic Ops will send back a session cookie.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``u`` | string | username |
+ +----------------------+--------+------------------------------------------------+
+ |``p`` | string | password |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "u": "username",
+ "p": "password"
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Successfully logged in."
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/user/:id/deliveryservices/available.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``xmlId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "xmlId": "ns-img",
+ "id": "90"
+ },
+ {
+ "xmlId": "ns-img-secure",
+ "id": "280"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.1/user/login/token**
+
+ Authentication of a user using a token.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``t`` | string | token-value |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "t": "token-value"
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=============+========+=============+
+ | ``alerts`` | array | |
+ +-------------+--------+-------------+
+ | ``>level`` | string | |
+ +-------------+--------+-------------+
+ | ``>text`` | string | |
+ +-------------+--------+-------------+
+ | ``version`` | string | |
+ +-------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "error",
+ "text": "Unauthorized, please log in."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.1/user/logout**
+
+ User logout. Invalidates the session cookie.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``alerts`` | array | |
+ +----------------------+--------+------------------------------------------------+
+ |* ``level`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |* ``text`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example**
+
+ ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "You are logged out."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.1/user/reset_password**
+
+ Reset user password.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``email`` | string | The email address of the user to initiate |
+ | | | password reset. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example**
+ ::
+
+ {
+ "email": "email@email.com"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``alerts`` | array | A collection of alert messages. |
+ +----------------------+--------+------------------------------------------------+
+ |* ``level`` | string | Success, info, warning or error. |
+ +----------------------+--------+------------------------------------------------+
+ |* ``text`` | string | Alert message. |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Successfully sent password reset to email 'email@email.com'"
+ }
+ ],
+ }
+
+
diff --git a/docs/latest/_sources/api/v12/api_capability.rst.txt b/docs/latest/_sources/api/v12/api_capability.rst.txt
new file mode 100644
index 0000000..618cd52
--- /dev/null
+++ b/docs/latest/_sources/api/v12/api_capability.rst.txt
@@ -0,0 +1,320 @@
+..
+..
+.. 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-v12-api_capability:
+
+API-Capabilities
+================
+
+.. _to-api-v12-api-capability-route:
+
+/api/1.2/api_capabilities
++++++++++++++++++++++++++
+
+**GET /api/1.2/api_capabilities**
+
+ Get all API-capability mappings.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Query Parameters**
+
+ +----------------+----------+--------+------------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+========+====================================+
+ | ``capability`` | no | string | Capability name. |
+ +----------------+----------+--------+------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+--------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+==================================================+
+ | ``id`` | int | Mapping id. |
+ +-------------------+--------+--------------------------------------------------+
+ | ``httpMethod`` | enum | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
+ +-------------------+--------+--------------------------------------------------+
+ | ``httpRoute`` | string | API route. |
+ +-------------------+--------+--------------------------------------------------+
+ | ``capability`` | string | Capability name. |
+ +-------------------+--------+--------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+--------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "httpMethod": "GET",
+ "httpRoute": "/api/*/asns",
+ "capability": "asn-read",
+ "lastUpdated": "2017-04-02 08:22:43"
+ },
+ {
+ "id": "7",
+ "httpMethod": "GET",
+ "httpRoute": "/api/*/asns/*",
+ "capability": "asn-read",
+ "lastUpdated": "2017-04-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/api_capabilities/:id**
+
+ Get an API-capability mapping by id.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------+----------+-------+-------------------------------------+
+ | Name | Required | Type | Description |
+ +=============+==========+=======+=====================================+
+ | ``id`` | yes | int | Mapping id. |
+ +-------------+----------+-------+-------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+--------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+==================================================+
+ | ``id`` | int | Mapping id. |
+ +-------------------+--------+--------------------------------------------------+
+ | ``httpMethod`` | enum | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
+ +-------------------+--------+--------------------------------------------------+
+ | ``httpRoute`` | string | API route. |
+ +-------------------+--------+--------------------------------------------------+
+ | ``capability`` | string | Capability name. |
+ +-------------------+--------+--------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+--------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "httpMethod": "GET",
+ "httpRoute": "/api/*/asns",
+ "capability": "asn-read",
+ "lastUpdated": "2017-04-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/api_capabilities**
+
+ Create an API-capability mapping.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +----------------+----------+--------+--------------------------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+========+==================================================+
+ | ``httpMethod`` | yes | enum | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
+ +----------------+----------+--------+--------------------------------------------------+
+ | ``httpRoute`` | yes | string | API route. |
+ +----------------+----------+--------+--------------------------------------------------+
+ | ``capability`` | yes | string | Capability name |
+ +----------------+----------+--------+--------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "httpMethod": "POST",
+ "httpRoute": "/api/*/cdns",
+ "capability": "cdn-write"
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+--------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+==================================================+
+ | ``response`` | hash | The details of the creation, if success. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>id`` | int | Mapping id. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>httpMethod`` | enum | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>httpRoute`` | string | API route. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>capability`` | string | Capability name |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>lastUpdated`` | string | |
+ +--------------------+--------+--------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+--------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": "6",
+ "httpMethod": "POST",
+ "httpRoute": "/api/*/cdns",
+ "capability": "cdn-write",
+ "lastUpdated": "2017-04-02 08:22:43"
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "API-capability mapping was created."
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/api_capabilities/{:id}**
+
+ Edit an API-capability mapping.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+--------+---------------------------------------+
+ | Name | Required | Type | Description |
+ +===================+==========+========+=======================================+
+ | ``id`` | yes | string | Mapping id. |
+ +-------------------+----------+--------+---------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+--------+--------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+==================================================+
+ | ``httpMethod`` | enum | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
+ +-------------------+--------+--------------------------------------------------+
+ | ``httpRoute`` | string | API route. |
+ +-------------------+--------+--------------------------------------------------+
+ | ``capability`` | string | Capability name |
+ +-------------------+--------+--------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "httpMethod": "GET",
+ "httpRoute": "/api/*/cdns",
+ "capability": "cdn-read"
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+--------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+==================================================+
+ | ``response`` | hash | The details of the creation, if success. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>id`` | int | Mapping id. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>httpMethod`` | enum | One of: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>httpRoute`` | string | API route. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>capability`` | string | Capability name |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>lastUpdated`` | string | |
+ +--------------------+--------+--------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+--------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+--------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": "6",
+ "httpMethod": "GET",
+ "httpRoute": "/api/*/cdns",
+ "capability": "cdn-read",
+ "lastUpdated": "2017-04-02 08:22:43"
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "API-capability mapping was updated."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/api_capabilities/{:id}**
+
+ Delete a capability.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+--------+---------------------------------------+
+ | Name | Required | Type | Description |
+ +===================+==========+========+=======================================+
+ | ``id`` | yes | string | Mapping id. |
+ +-------------------+----------+--------+---------------------------------------+
+
+ **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": "API-capability mapping deleted."
+ }
+ ],
+ }
diff --git a/docs/latest/_sources/api/v12/asn.rst.txt b/docs/latest/_sources/api/v12/asn.rst.txt
new file mode 100644
index 0000000..b5803cd
--- /dev/null
+++ b/docs/latest/_sources/api/v12/asn.rst.txt
@@ -0,0 +1,200 @@
+..
+..
+.. 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-v12-asn:
+
+ASN
+===
+
+.. _to-api-v12-asns-route:
+
+/api/1.2/asns
++++++++++++++
+
+**GET /api/1.2/asns**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +---------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +=====================+==========+=============================================+
+ | ``cachegroup`` | no | Filter ASNs by cache group ID |
+ +---------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``id`` | string | Local unique identifier for the ASN |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroup`` | string | Related cachegroup name |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | Related cachegroup id |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "27",
+ "asn": "7015",
+ "cachegroup": "us-ma-woburn",
+ "cachegroupId": "27",
+ },
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "7016",
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "13"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/asns/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | ASN id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``id`` | string | Local unique identifier for the ASN |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroup`` | string | Related cachegroup name |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | Related cachegroup id |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "7016",
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "13"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/asns/{:id}**
+
+ Allows user to edit an ASN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | ASN id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``asn`` | string | ASN |
+ +-------------------+--------+-------------------------------------------------+
+ | ``cachegroupId`` | string | The cachegroup the ASN belongs to |
+ +-------------------+--------+-------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "asn": "99",
+ "cachegroupId": "177"
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+=================================================+
+ | ``response`` | hash | The details of the update, if success. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | CDN name. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>id`` | int | CDN id. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "99",
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "177"
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was updated."
+ }
+ ]
+ }
+
+|
+
+
diff --git a/docs/latest/_sources/api/v12/cache.rst.txt b/docs/latest/_sources/api/v12/cache.rst.txt
new file mode 100644
index 0000000..f56b46c
--- /dev/null
+++ b/docs/latest/_sources/api/v12/cache.rst.txt
@@ -0,0 +1,84 @@
+..
+..
+.. 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-v12-cache:
+
+Cache
+=====
+
+.. _to-api-v12-cache-route:
+
+/api/1.2/caches/stats
++++++++++++++++++++++
+
+**GET /api/1.2/caches/stats**
+
+ Retrieves cache stats from Traffic Monitor. Also includes rows for aggregates.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +============================+===============+=========================================================================================+
+ |``profile`` | string | The profile of the cache. |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``cachegroup`` | string | The cache group of the cache. |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``hostname`` | string | The hostname of the cache. |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``ip`` | string | The IP address of the cache. |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``status`` | string | The status of the cache. |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``healthy`` | string | Has Traffic Monitor marked the cache as healthy or unhealthy? |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``connections`` | string | Cache connections |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``kbps`` | string | Cache kbps out |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "profile": "ALL",
+ "cachegroup": "ALL",
+ "hostname": "ALL",
+ "ip": null,
+ "status": "ALL",
+ "healthy": true,
+ "connections": 934424,
+ "kbps": 618631875
+ },
+ {
+ "profile": "EDGE1_FOO_721-ATS621-45",
+ "cachegroup": "us-nm-albuquerque",
+ "hostname": "foo-bar-alb-01",
+ "ip": "2.2.2.2",
+ "status": "REPORTED",
+ "healthy": true,
+ "connections": 373,
+ "kbps": 390136
+ },
+ ]
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/cache_stats.rst.txt b/docs/latest/_sources/api/v12/cache_stats.rst.txt
new file mode 100644
index 0000000..dffc9a4
--- /dev/null
+++ b/docs/latest/_sources/api/v12/cache_stats.rst.txt
@@ -0,0 +1,134 @@
+..
+..
+.. 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-v12-cache-stats:
+
+Cache Statistics
+===========================
+
+.. _to-api-v12-cache-stats-route:
+
+/api/1.2/cache_stats
+++++++++++++++++++++
+
+**GET /api/1.2/cache_stats.json**
+
+ Retrieves statistics about the CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+==============================================================================================================================================+
+ | ``cdnName`` | yes | The CDN name to return cache stats for |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``metricType`` | yes | The metric type (valid metric types: 'ats.proxy.process.http.current_client_connections', 'bandwidth', 'maxKbps') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``startDate`` | yes | The begin date (Formatted as ISO8601, for example: '2015-08-11T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``endDate`` | yes | The end date (Formatted as ISO8601, for example: '2015-08-12T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +============================+===============+=========================================================================================+
+ |``summary`` | hash | Summary data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>min`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>max`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>fifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyEighthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyFifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>average`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``series`` | hash | Series data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>columns`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>name`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>values`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>time`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>value`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "series": {
+ "columns": [
+ "time",
+ ""
+ ],
+ "count": 29,
+ "name": "bandwidth",
+ "tags": {
+ "cdn": "over-the-top"
+ },
+ "values": [
+ [
+ "2015-08-10T22:40:00Z",
+ 229340299720
+ ],
+ [
+ "2015-08-10T22:41:00Z",
+ 224309221713.334
+ ],
+ [
+ "2015-08-10T22:42:00Z",
+ 229551834168.334
+ ],
+ [
+ "2015-08-10T22:43:00Z",
+ 225179658876.667
+ ],
+ [
+ "2015-08-10T22:44:00Z",
+ 230443968275
+ ]
+ ]
+ },
+ "summary": {
+ "average": 970410.295,
+ "count": 1376041798,
+ "fifthPercentile": 202.03,
+ "max": 3875441.02,
+ "min": 0,
+ "ninetyEighthPercentile": 2957940.93,
+ "ninetyFifthPercentile": 2366728.63
+ }
+ }
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/cachegroup.rst.txt b/docs/latest/_sources/api/v12/cachegroup.rst.txt
new file mode 100644
index 0000000..2c6d8f9
--- /dev/null
+++ b/docs/latest/_sources/api/v12/cachegroup.rst.txt
@@ -0,0 +1,821 @@
+..
+..
+.. 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-v12-cachegroup:
+
+Cache Group
+===========
+
+.. _to-api-v12-cachegroups-route:
+
+/api/1.2/cachegroups
+++++++++++++++++++++
+
+**GET /api/1.2/cachegroups**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``type`` | no | Filter cache groups by Type ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``fallbackToClosest`` | bool | Behaviour during non-availability/ failure of configured fallbacks |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4",
+ "fallbackToClosest":true
+ },
+ {
+ "id": "22",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago-1",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4",
+ "fallbackToClosest":false
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/cachegroups/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "dc-chicago"
+ },
+ {
+ "name": "dc-cmc"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/cachegroups/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``fallbackToClosest`` | bool | Behaviour during non-availability/ failure of configured fallbacks |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4",
+ "fallbackToClosest":true
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/cachegroups/:id/parameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | int | Local unique identifier for the parameter |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | Name of the parameter |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``value`` | string | Value of the parameter |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``configFile`` | string | Config file associated with the parameter |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secure`` | bool | Is the parameter value only visible to admin users |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1100",
+ "name": "cgw.originUrl",
+ "value": "http://to-short.g.foo.net/data/",
+ "configFile": "foo.config",
+ "secure": false,
+ "lastUpdated": "2015-08-27 15:11:49"
+ },
+ { ... }
+ ]
+ }
+
+|
+
+**GET /api/1.2/cachegroups/:id/unassigned_parameters**
+
+ Retrieves all parameters NOT assigned to the cache group.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==================+==========+=======================+
+ | ``id`` | yes | Cache group id |
+ +------------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/cachegroup/:parameter_id/parameter**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-------------+
+ | Name | Required | Description |
+ +==================+==========+=============+
+ | ``parameter_id`` | yes | |
+ +------------------+----------+-------------+
+
+ **Response Properties**
+
+ +-----------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=================+========+=============+
+ | ``cachegroups`` | array | |
+ +-----------------+--------+-------------+
+ | ``>name`` | string | |
+ +-----------------+--------+-------------+
+ | ``>id`` | string | |
+ +-----------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroups": [
+ {
+ "name": "dc-chicago",
+ "id": "21"
+ },
+ {
+ "name": "dc-cmc",
+ "id": "22"
+ }
+ ]
+ },
+ }
+
+|
+
+**GET /api/1.2/cachegroupparameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------------+--------+-----------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+=========================================+
+ | ``cachegroupParameters`` | array | A collection of cache group parameters. |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>parameter`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>lastUpdated`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>cachegroup`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroupParameters": [
+ {
+ "parameter": "379",
+ "lastUpdated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ca-sanjose"
+ },
+ {
+ "parameter": "380",
+ "lastUpdated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ca-sanjose"
+ },
+ {
+ "parameter": "379",
+ "lastUpdated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ma-woburn"
+ }
+ ]
+ },
+ }
+
+|
+
+**GET /api/1.2/cachegroups/:parameter_id/parameter/available**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-------------+
+ | Name | Required | Description |
+ +==================+==========+=============+
+ | ``parameter_id`` | yes | |
+ +------------------+----------+-------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "dc-chicago",
+ "id": "21"
+ },
+ {
+ "name": "dc-cmc",
+ "id": "22"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/cachegroups**
+
+ Create cache group.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``name`` | yes | The name of the Cache Group entry |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``shortName`` | yes | Abbreviation of the Cache Group Name |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``latitude`` | no | Latitude for the Cache Group |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``longitude`` | no | Longitude for the Cache Group |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``parentCachegroup`` | no | Name of Parent Cache Group entry. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroup`` | no | Name of Secondary Parent Cache Group entry. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``typeId`` | yes | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``fallbackToClosest`` | no | Behaviour on configured fallbacks failure, true / false |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "cache_group_edge",
+ "shortName": "cg_edge",
+ "latitude": 12,
+ "longitude": 45,
+ "parentCachegroup": "cache_group_mid",
+ "typeId": 6,
+ "fallbackToClosest":true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``id`` | string | The id of cache group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``parentCachegroup`` | string | Name of Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | id of Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroup`` | string | Name of Secondary Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | id of Secondary Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``typeName`` | string | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``fallbackToClosest`` | bool | Behaviour during non-availability/failure of configured fallbacks |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Cachegroup successfully created: cache_group_edge"
+ }
+ ],
+ "response": {
+ 'longitude' : '45',
+ 'lastUpdated' : '2016-01-25 13:55:30',
+ 'shortName' : 'cg_edge',
+ 'name' : 'cache_group_edge',
+ 'parentCachegroup' : 'cache_group_mid',
+ 'secondaryParentCachegroup' : null,
+ 'latitude' : '12',
+ 'typeName' : 'EDGE_LOC',
+ 'id' : '104',
+ 'parentCachegroupId' : '103',
+ 'secondaryParentCachegroupId' : null,
+ 'fallbackToClosest':true
+ }
+ }
+
+|
+
+**PUT /api/1.2/cachegroups/{:id}**
+
+ Update cache group.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------+----------+------------------------------------+
+ | Name | Required | Description |
+ +======+==========+====================================+
+ | id | yes | The id of the cache group to edit. |
+ +------+----------+------------------------------------+
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``name`` | yes | The name of the Cache Group entry |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``shortName`` | yes | Abbreviation of the Cache Group Name |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``latitude`` | no | Latitude for the Cache Group |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``longitude`` | no | Longitude for the Cache Group |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``parentCachegroup`` | no | Name of Parent Cache Group entry. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroup`` | no | Name of Secondary Parent Cache Group entry. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``typeName`` | yes | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``fallbackToClosest`` | no | Behaviour on configured fallbacks failure, true / false |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "cache_group_edge",
+ "shortName": "cg_edge",
+ "latitude": 12,
+ "longitude": 45,
+ "parentCachegroup": "cache_group_mid",
+ "typeName": "EDGE_LOC",
+ "fallbackToClosest":true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``id`` | string | The id of cache group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``parentCachegroup`` | string | Name of Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | id of Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroup`` | string | Name of Secondary Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | id of Secondary Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``typeName`` | string | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``fallbackToClosest`` | bool | Behaviour during non-availability/failure of configured fallbacks |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Cachegroup was updated: cache_group_edge"
+ }
+ ],
+ "response": {
+ 'longitude' : '45',
+ 'lastUpdated' : '2016-01-25 13:55:30',
+ 'shortName' : 'cg_edge',
+ 'name' : 'cache_group_edge',
+ 'parentCachegroup' : 'cache_group_mid',
+ 'secondaryParentCachegroup' : null,
+ 'latitude' : '12',
+ 'typeName' : 'EDGE_LOC',
+ 'id' : '104',
+ 'parentCachegroupId' : '103',
+ 'secondaryParentCachegroupId' : null,
+ 'fallbackToClosest':true
+ }
+ }
+
+|
+
+**DELETE /api/1.2/cachegroups/{:id}**
+
+ Delete cache group. The request to delete a cache group, which has servers or child cache group, will be rejected.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------+----------+--------------------------------------+
+ | Name | Required | Description |
+ +======+==========+======================================+
+ | id | yes | The id of the cache group to delete. |
+ +------+----------+--------------------------------------+
+
+ **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": "Cachegroup was deleted: cache_group_edge"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/cachegroups/{:id}/queue_update**
+
+ Queue or dequeue updates for all servers assigned to a cache group limited to a specific CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+----------------------+
+ | Name | Required | Description |
+ +=================+==========+======================+
+ | id | yes | the cachegroup id. |
+ +-----------------+----------+----------------------+
+
+ **Request Properties**
+
+ +--------------+---------+-----------------------------------------------+
+ | Name | Type | Description |
+ +==============+=========+===============================================+
+ | action | string | queue or dequeue |
+ +--------------+---------+-----------------------------------------------+
+ | cdn | string | cdn name or cdn ID is required |
+ +--------------+---------+-----------------------------------------------+
+ | cdnId | string | cdn ID or cdn name is required |
+ +--------------+---------+-----------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+---------+----------------------------------------------------+
+ | Name | Type | Description |
+ +=================+=========+====================================================+
+ | action | string | The action processed, queue or dequeue. |
+ +-----------------+---------+----------------------------------------------------+
+ | cachegroupId | integer | cachegroup id |
+ +-----------------+---------+----------------------------------------------------+
+ | cachegroupName | string | cachegroup name |
+ +-----------------+---------+----------------------------------------------------+
+ | cdn | string | cdn name |
+ +-----------------+---------+----------------------------------------------------+
+ | serverNames | array | servers name array in the cachegroup in cdn |
+ +-----------------+---------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroupName": "us-il-chicago",
+ "action": "queue",
+ "serverNames": [
+ "atsec-chi-00",
+ "atsec-chi-01",
+ "atsec-chi-02",
+ "atsec-chi-03",
+ ],
+ "cachegroupId": "93",
+ "cdn": "cdn_number_1",
+ }
+ }
+
+|
+
+**POST /api/1.2/cachegroups/{:id}/deliveryservices**
+
+ Assign deliveryservices for servers in cachegroup
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------------------+----------+------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+==============================================================================+
+ | id | yes | The cachegroup id. |
+ +------------------+----------+------------------------------------------------------------------------------+
+
+ **Request Properties**
+
+ +------------------+----------+------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+==========+==============================================================================+
+ | deliveryServices | array | The Ids of the delivery services to assign to each server in the cachegroup. |
+ +------------------+----------+------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "deliveryServices": [ 234, 235 ]
+ }
+
+ **Response Properties**
+
+ +--------------------+----------+--------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+==========+========================================================+
+ | response | hash | The details of the assignment, if success. |
+ +--------------------+----------+--------------------------------------------------------+
+ | >id | int | The cachegroup id. |
+ +--------------------+----------+--------------------------------------------------------+
+ | >serverNames | array | The server name array in the cachegroup. |
+ +--------------------+----------+--------------------------------------------------------+
+ | >deliveryServices | array | The deliveryservice id array. |
+ +--------------------+----------+--------------------------------------------------------+
+ | alerts | array | A collection of alert messages. |
+ +--------------------+----------+--------------------------------------------------------+
+ | >level | string | Success, info, warning or error. |
+ +--------------------+----------+--------------------------------------------------------+
+ | >text | string | Alert message. |
+ +--------------------+----------+--------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "id": 3,
+ "serverNames": [ "atlanta-edge-01", "atlanta-edge-07" ],
+ "deliveryServices": [ 234, 235 ]
+ }
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Delivery services successfully assigned to all the servers of cache group 3."
+ }
+ ],
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v12/cachegroup_fallbacks.rst.txt b/docs/latest/_sources/api/v12/cachegroup_fallbacks.rst.txt
new file mode 100644
index 0000000..cabc450
--- /dev/null
+++ b/docs/latest/_sources/api/v12/cachegroup_fallbacks.rst.txt
@@ -0,0 +1,288 @@
+..
+..
+.. 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-v12-cachegroupfallbacks:
+
+Cache Group Fallback
+====================
+
+.. _to-api-v12-cachegroupfallbacks-route:
+
+/api/1.2/cachegroup_fallbacks
+++++++++++++++++++++++++++++++
+
+**GET /api/1.2/cachegroup_fallbacks?cacheGroupId={id}**
+**GET /api/1.2/cachegroup_fallbacks?fallbackId={id}**
+**GET /api/1.2/cachegroup_fallbacks?cacheGroupId={id}&fallbackId={id}**
+
+ Retrieve fallback related configurations for a cache group.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ Query parameter is mandatory. Either one of the parameters must be used. Both can also be used simultaneously.
+
+ +-----------------+---------------------------------------------------------------------------+
+ | Name | Description |
+ +=================+===========================================================================+
+ | cacheGroupId | The id of the cache group whose backup configurations has to be retrieved |
+ +-----------------+---------------------------------------------------------------------------+
+ | fallbackId | The id of the fallback cache group associated with a cache group |
+ +-----------------+---------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | | array | parameters array |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>cacheGroupId`` | int | Cache group id |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackId`` | int | fallback cache group id |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>cacheGroupName`` | string | Cache group name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackName`` | string | Fallback cache group name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackOrder`` | int | Ordering list in the list of backups |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cacheGroupId":1,
+ "cacheGroupName":"GROUP1",
+ "fallbackId":2,
+ "fallbackOrder":10,
+ "fallbackName":"GROUP2"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/cachegroup_fallbacks**
+
+ Creates fallback configuration for the cache group. New fallbacks can be added only via POST.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+ The request parameters should be in array format.
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | | array | parameters array |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>cacheGroupId`` | int | Cache group id |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackId`` | int | Fallback cache group id |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackOrder`` | int | Ordering list in the list of backups |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ [
+ {
+ "cacheGroupId": 1,
+ "fallbackId": 3,
+ "fallbackOrder": 10
+ }
+ ]
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | | array | parameters array |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>cacheGroupId`` | int | Cache group id |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackId`` | int | fallback cache group id |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>cacheGroupName`` | string | Cache group name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackName`` | string | Fallback cache group name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackOrder`` | int | Ordering list in the list of backups |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level":"success",
+ "text":"Backup configuration CREATE for cache group 1 successful."
+ }
+ ],
+ "response": [
+ {
+ "cacheGroupId":1,
+ "cacheGroupName":"GROUP1",
+ "fallbackId":3,
+ "fallbackName":"GROUP2",
+ "fallbackorder":10,
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/cachegroup_fallbacks**
+
+ Updates an existing fallback configuration for the cache group.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+ The request parameters should be in array format.
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | | array | parameters array |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>cacheGroupId`` | int | Cache group id |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackId`` | int | Fallback cache group id |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackOrder`` | int | Ordering list in the list of backups |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ [
+ {
+ "cacheGroupId": 1,
+ "fallbackId": 3,
+ "fallbackOrder": 10
+ }
+ ]
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | | array | parameters array |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>cacheGroupId`` | int | Cache group id |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackId`` | int | fallback cache group id |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>cacheGroupName`` | string | Cache group name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackName`` | string | Fallback cache group name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>fallbackOrder`` | int | Ordering list in the list of backups |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level":"success",
+ "text":"Backup configuration UPDATE for cache group 1 successful."
+ }
+ ],
+ "response": [
+ {
+ "cacheGroupId":1,
+ "cacheGroupName":"GROUP1",
+ "fallbackId":3,
+ "fallbackName":"GROUP2",
+ "fallbackorder":10,
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/cachegroup_fallbacks?cacheGroupId={id}**
+**DELETE /api/1.2/cachegroup_fallbacks?fallbackId={id}**
+**DELETE /api/1.2/cachegroup_fallbacks?fallbackId={id}&cacheGroupId={id}**
+
+ Delete fallback list assigned to the cache group.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Query Parameters**
+
+ Query parameter is mandatory. Either one of the parameters must be used. Both can also be used simultaneously.
+
+ +-----------------+----------+--------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+======================================================================================+
+ | cacheGroupId | Yes | The id of the cache group whose backup configurations has to be deleted |
+ +-----------------+----------+--------------------------------------------------------------------------------------+
+ | fallbackId | Yes | The id of the fallback cachegroup which has to be deleted from the list of fallbacks |
+ +-----------------+----------+--------------------------------------------------------------------------------------+
+
+ **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": "Backup configuration DELETED"
+ }
+ ],
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v12/cachegroup_parameter.rst.txt b/docs/latest/_sources/api/v12/cachegroup_parameter.rst.txt
new file mode 100644
index 0000000..1872c51
--- /dev/null
+++ b/docs/latest/_sources/api/v12/cachegroup_parameter.rst.txt
@@ -0,0 +1,177 @@
+..
+..
+.. 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-v12-cachegroupparameters:
+
+
+Cache Group parameters
+======================
+
+.. _to-api-v12-cachegroupparameters-route:
+
+/api/1.2/cachegroupparameters
++++++++++++++++++++++++++++++
+
+**POST /api/1.2/cachegroupparameters**
+
+ Assign parameter(s) to cache group(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Properties**
+
+ Two formats are acceptable.
+
+ Single cachegroup-parameter format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | ``cacheGroupId`` | yes | cache group id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ Profile-parameter array format:
+
+ +-----------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +=======================+==========+====================================================+
+ | | yes | cachegroup-parameter array. |
+ +-----------------------+----------+----------------------------------------------------+
+ | ``>cacheGroupId`` | yes | cache group id. |
+ +-----------------------+----------+----------------------------------------------------+
+ | ``>parameterId`` | yes | parameter id. |
+ +-----------------------+----------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ Single cachegroup-parameter format:
+
+ {
+ "cacheGroupId": 2,
+ "parameterId": 6
+ }
+
+ Cachegroup-parameter array format:
+
+ [
+ {
+ "cacheGroupId": 2,
+ "parameterId": 6
+ },
+ {
+ "cacheGroupId": 2,
+ "parameterId": 7
+ },
+ {
+ "cacheGroupId": 3,
+ "parameterId": 6
+ }
+ ]
+
+ **Response Properties**
+
+ +-------------------+---------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+=========+=====================================================+
+ | ``response`` | array | Cache group-parameter associations. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>cacheGroupId`` | string | Cache Group id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>parameterId`` | string | Parameter id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+---------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":[
+ {
+ "cacheGroupId": "2",
+ "parameterId": "6"
+ },
+ {
+ "cacheGroupId": "2",
+ "parameterId": "7"
+ },
+ {
+ "cacheGroupId": "3",
+ "parameterId": "6"
+ }
+ ]
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Cache group parameter associations were created."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/cachegroupparameters/{:cachegroup_id}/{:parameter_id}**
+
+ Delete a cache group parameter association.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Route Parameters**
+
+ +------------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+====================================================+
+ | ``cachegroup_id``| yes | cache group id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameter_id`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=====================================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+--------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Cache group parameter association was deleted."
+ }
+ ]
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/capability.rst.txt b/docs/latest/_sources/api/v12/capability.rst.txt
new file mode 100644
index 0000000..570a811
--- /dev/null
+++ b/docs/latest/_sources/api/v12/capability.rst.txt
@@ -0,0 +1,271 @@
+..
+..
+.. 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-v12-capability:
+
+Capabilities
+============
+
+.. _to-api-v12-capability-route:
+
+/api/1.2/capabilities
++++++++++++++++++++++
+
+**GET /api/1.2/capabilities**
+
+ Get all capabilities.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``name`` | string | Capability name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``description`` | string | Describing the APIs covered by the capability. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "cdn-read",
+ "description": "View CDN configuration",
+ "lastUpdated": "2017-04-02 08:22:43"
+ },
+ {
+ "name": "cdn-write",
+ "description": "Create, edit or delete CDN configuration",
+ "lastUpdated": "2017-04-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/capabilities/:name**
+
+ Get a capability by name.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------+----------+--------+------------------------------------+
+ | Name | Required | Type | Description |
+ +=============+==========+========+====================================+
+ | ``name`` | yes | string | Capability name. |
+ +-------------+----------+--------+------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``name`` | string | Capability name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``description`` | string | Describing the APIs covered by the capability. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "cdn-read",
+ "description": "View CDN configuration",
+ "lastUpdated": "2017-04-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/capabilities**
+
+ Create a capability.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+
+ +-----------------+----------+--------+-------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+========+=================================================+
+ | ``name`` | yes | string | Capability name. |
+ +-----------------+----------+--------+-------------------------------------------------+
+ | ``description`` | yes | string | Describing the APIs covered by the capability. |
+ +-----------------+----------+--------+-------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "cdn-write",
+ "description": "Create, edit or delete CDN configuration"
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+=================================================+
+ | ``response`` | hash | The details of the creation, if success. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Capability name. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>description`` | string | Describing the APIs covered by the capability. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+-------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "name": "cdn-write",
+ "description": "Create, edit or delete CDN configuration"
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Capability was created."
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/capabilities/{:name}**
+
+ Edit a capability.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``name`` | int | Capability name. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``description`` | string | Describing the APIs covered by the capability. |
+ +-------------------+--------+-------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "description": "View CDN configuration"
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+=================================================+
+ | ``response`` | hash | The details of the update, if success. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Capability name. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>description`` | int | Describing the APIs covered by the capability. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "name": "cdn-read",
+ "description": "View CDN configuration"
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Capability was updated."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/capabilities/{:name}**
+
+ Delete a capability.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+================================================+
+ | ``name`` | yes | Capability name. |
+ +-----------------+----------+------------------------------------------------+
+
+ **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": "Capability deleted."
+ }
+ ],
+ }
diff --git a/docs/latest/_sources/api/v12/cdn.rst.txt b/docs/latest/_sources/api/v12/cdn.rst.txt
new file mode 100644
index 0000000..7cdf9b0
--- /dev/null
+++ b/docs/latest/_sources/api/v12/cdn.rst.txt
@@ -0,0 +1,1410 @@
+..
+..
+.. 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-v12-cdn:
+
+CDN
+===
+
+.. _to-api-v12-cdn-route:
+
+/api/1.2/cdns
++++++++++++++
+
+**GET /api/1.2/cdns**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``domainName`` | string | TLD of the CDN. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "cdn1",
+ "domainName": "cdn1.foo.com",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "domainName": "cdn2.foo.com",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/cdns/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | CDN id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``domainName`` | string | TLD of the CDN. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "domainName": "cdn2.foo.com",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/cdns/name/:name**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``name`` | yes | CDN name. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``domainName`` | string | TLD of the CDN. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "domainName": "cdn2.foo.com",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/cdns**
+
+ Allows user to create a CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``domainName`` | string | TLD of the CDN. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | Whether dnssec is enabled. |
+ | | | - false: disabled |
+ | | | - true: enabled |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "cdn_test",
+ "domainName": "cdn3.foo.com",
+ "dnssecEnabled": true
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+=================================================+
+ | ``response`` | hash | The details of the creation, if success. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>id`` | int | CDN id. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | CDN name. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>domainName`` | string | TLD of the CDN. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+-------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": 3
+ "name": "cdn_test",
+ "domainName": "cdn3.foo.com",
+ "dnssecEnabled": true
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was created."
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/cdns/{:id}**
+
+ Allows user to edit a CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | CDN id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``domainName`` | string | TLD of the CDN. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | Whether dnssec is enabled. |
+ | | | - false: disabled |
+ | | | - true: enabled |
+ +-------------------+--------+-------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "name": "cdn_test2",
+ "domainName": "cdn3.foo.com",
+ "dnssecEnabled": false
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+=================================================+
+ | ``response`` | hash | The details of the update, if success. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | CDN name. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>id`` | int | CDN id. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>domainName`` | string | TLD of the CDN. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>dnssecEnabled`` | bool | Whether dnssec is enabled. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": 3,
+ "name": "cdn_test2",
+ "domainName": "cdn3.foo.com",
+ "dnssecEnabled": false
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was updated."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/cdns/{:id}**
+
+ Allows user to delete a CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+================================================+
+ | ``id`` | yes | CDN id. |
+ +-----------------+----------+------------------------------------------------+
+
+ **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": "cdn was deleted."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/cdns/{:id}/queue_update**
+
+ Queue or dequeue updates for all servers assigned to a specific CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+----------------------+
+ | Name | Required | Description |
+ +=================+==========+======================+
+ | id | yes | the cdn id. |
+ +-----------------+----------+----------------------+
+
+ **Request Properties**
+
+ +--------------+---------+-----------------------------------------------+
+ | Name | Type | Description |
+ +==============+=========+===============================================+
+ | action | string | queue or dequeue |
+ +--------------+---------+-----------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "action": "queue"
+ }
+
+
+ **Response Properties**
+
+ +-----------------+---------+----------------------------------------------------+
+ | Name | Type | Description |
+ +=================+=========+====================================================+
+ | action | string | The action processed, queue or dequeue. |
+ +-----------------+---------+----------------------------------------------------+
+ | cdnId | integer | cdn id |
+ +-----------------+---------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "action": "queue",
+ "cdn": 1
+ }
+ }
+
+|
+
+
+Health
+++++++
+
+.. _to-api-v12-cdn-health-route:
+
+**GET /api/1.2/cdns/health**
+
+ Retrieves the health of all locations (cache groups) for all CDNs.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ },
+ }
+
+|
+
+**GET /api/1.2/cdns/:name/health**
+
+ Retrieves the health of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |``name`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across the |
+ | | | specified CDN. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across the |
+ | | | specified CDN. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ },
+ }
+
+|
+
+**GET /api/1.2/cdns/usage/overview**
+
+ Retrieves the high-level CDN usage metrics.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``currentGbps`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``tps`` | int | |
+ +----------------------+--------+------------------------------------------------+
+ |``maxGbps`` | int | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "currentGbps": 149.368167,
+ "tps": 36805,
+ "maxGbps": 3961
+ }
+ }
+
+|
+
+**GET /api/1.2/cdns/capacity**
+
+ Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``availablePercent`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``unavailablePercent``| number | |
+ +----------------------+--------+------------------------------------------------+
+ |``utilizedPercent`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``maintenancePercent``| number | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "availablePercent": 89.0939840205533,
+ "unavailablePercent": 0,
+ "utilizedPercent": 10.9060020300395,
+ "maintenancePercent": 0.0000139494071146245
+ }
+ }
+
+|
+
+.. _to-api-v12-cdn-routing:
+
+Routing
++++++++
+
+**GET /api/1.2/cdns/routing**
+
+ Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+-----------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+=========================================+
+ | ``staticRoute`` | number | Used pre-configured DNS entries. |
+ +-----------------+--------+-----------------------------------------+
+ | ``miss`` | number | No location available for client IP. |
+ +-----------------+--------+-----------------------------------------+
+ | ``geo`` | number | Used 3rd party geo-IP mapping. |
+ +-----------------+--------+-----------------------------------------+
+ | ``err`` | number | Error localizing client IP. |
+ +-----------------+--------+-----------------------------------------+
+ | ``cz`` | number | Used Coverage Zone geo-IP mapping. |
+ +-----------------+--------+-----------------------------------------+
+ | ``dsr`` | number | Overflow traffic sent to secondary CDN. |
+ +-----------------+--------+-----------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "staticRoute": 0,
+ "miss": 0,
+ "geo": 37.8855391018869,
+ "err": 0,
+ "cz": 62.1144608981131,
+ "dsr": 0
+ }
+ }
+
+|
+
+.. _to-api-v12-cdn-metrics:
+
+Metrics
++++++++
+
+
+**GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end**
+
+*Note: this route is not currently implemented in Traffic Ops. See https://github.com/apache/incubator-trafficcontrol/issues/2309*
+
+ Retrieves edge metrics of one or all locations (cache groups).
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------+
+ | Name | Required | Description |
+ +=================+==========+===========================+
+ | ``metric_type`` | yes | ooff, origin_tps |
+ +-----------------+----------+---------------------------+
+ | ``start`` | yes | UNIX time, yesterday, now |
+ +-----------------+----------+---------------------------+
+ | ``end`` | yes | UNIX time, yesterday, now |
+ +-----------------+----------+---------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=====================+========+=============+
+ | ``stats`` | hash | |
+ +---------------------+--------+-------------+
+ | ``>count`` | string | |
+ +---------------------+--------+-------------+
+ | ``>98thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>min`` | string | |
+ +---------------------+--------+-------------+
+ | ``>max`` | string | |
+ +---------------------+--------+-------------+
+ | ``>5thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>95thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>mean`` | string | |
+ +---------------------+--------+-------------+
+ | ``>sum`` | string | |
+ +---------------------+--------+-------------+
+ | ``data`` | array | |
+ +---------------------+--------+-------------+
+ | ``>time`` | int | |
+ +---------------------+--------+-------------+
+ | ``>value`` | number | |
+ +---------------------+--------+-------------+
+ | ``label`` | string | |
+ +---------------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "stats": {
+ "count": 1,
+ "98thPercentile": 1668.03,
+ "min": 1668.03,
+ "max": 1668.03,
+ "5thPercentile": 1668.03,
+ "95thPercentile": 1668.03,
+ "mean": 1668.03,
+ "sum": 1668.03
+ },
+ "data": [
+ [
+ 1425135900000,
+ 1668.03
+ ],
+ [
+ 1425136200000,
+ null
+ ]
+ ],
+ "label": "Origin TPS"
+ }
+ ],
+ }
+
+|
+
+.. _to-api-v12-cdn-domains:
+
+Domains
++++++++
+
+**GET /api/1.2/cdns/domains**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``profileId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``parameterId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``profileName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``profileDescription``| string | |
+ +----------------------+--------+------------------------------------------------+
+ |``domainName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "profileId": "5",
+ "parameterId": "404",
+ "profileName": "CR_FOO",
+ "profileDescription": "Content Router for foo.domain.net",
+ "domainName": "foo.domain.net"
+ },
+ {
+ "profileId": "8",
+ "parameterId": "405",
+ "profileName": "CR_BAR",
+ "profileDescription": "Content Router for bar.domain.net",
+ "domainName": "bar.domain.net"
+ }
+ ],
+ }
+
+|
+
+.. _to-api-v12-cdn-topology:
+
+Topology
+++++++++
+
+**GET /api/1.2/cdns/:cdn_name/configs**
+
+ Retrieves CDN config information.
+
+ Authentication Required: Yes
+
+ **Request Route Parameters**
+
+ +--------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==============+==========+=======================+
+ | ``cdn_name`` | yes | Your cdn name or, all |
+ +--------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +-----------------------+--------+-----------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+===============================================+
+ |``id`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``value`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``name`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``config_file`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+
+ **Response Example** ::
+
+ TBD
+
+|
+
+**GET /api/1.2/cdns/:name/configs/monitoring**
+
+ Retrieves CDN monitoring information.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | CDN name |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------------------------+--------+--------------------+
+ | Parameter | Type | Description |
+ +=================================================+========+====================+
+ | ``trafficServers`` | array | A collection of |
+ | | | Traffic Servers. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>cacheGroup`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>port`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>interfaceName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>type`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hashId`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``cacheGroups`` | array | A collection of |
+ | | | cache groups. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>coordinates`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>name`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``config`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hack.ttl`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.healthParams.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.dataServer.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.timepad`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.polling.interval`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.threadPool`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.polling.interval`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.event-count`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.crConfig.polling.url`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>CDN_name`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``trafficMonitors`` | array | A collection of |
+ | | | Traffic Monitors. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>location`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>port`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``deliveryServices`` | array | A collection of |
+ | | | delivery services. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>xmlId`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>totalTpsThreshold`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>totalKbpsThreshold`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``profiles`` | array | A collection of |
+ | | | profiles. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>parameters`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.connection.timeout`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.queryTime`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>history.count`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.availableBandwidthInKbps`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.loadavg`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>name`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>type`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+
+ **Response Example**
+ ::
+
+ TBD
+
+|
+
+**GET /api/1.2/cdns/:name/configs/routing**
+
+ Retrieves CDN routing information.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------------+---------+-----------------------------------+
+ | Parameter | Type | Description |
+ +=====================================+=========+===================================+
+ | ``trafficServers`` | array | A collection of Traffic Servers. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>cacheGroup`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>deliveryServices`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>xmlId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>remaps`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>interfaceName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>type`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hashId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``stats`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsPath`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>cdnName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsVersion`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsUser`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>date`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsHost`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``cacheGroups`` | array | A collection of cache groups. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coordinates`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>name`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``config`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.admin`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tcoveragezone.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.expire`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coveragezone.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.minimum`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>domain_name`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.AAAA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.refresh`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.NS`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.SOA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation6.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.A`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.retry`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation6.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``trafficMonitors`` | array | A collection of Traffic Monitors. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>location`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``deliveryServices`` | array | A collection of delivery |
+ | | | services. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>xmlId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ttl`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geoEnabled`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coverageZoneOnly`` | boolean | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>matchSets`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>protocol`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>matchList`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>>regex`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>>matchType`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>bypassDestination`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>maxDnsIpsForLocation`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>ttl`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>type`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ttls`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>A`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>SOA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>NS`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>AAAA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>missCoordinates`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>soa`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>admin`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>retry`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>minimum`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>refresh`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>expire`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``trafficRouters`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>location`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>apiPort`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+
+**Response Example**
+::
+
+ TBD
+
+|
+
+
+.. _to-api-v12-cdn-dnsseckeys:
+
+DNSSEC Keys
++++++++++++
+
+**GET /api/1.2/cdns/name/:name/dnsseckeys**
+
+ Gets a list of dnsseckeys for a CDN and all associated Delivery Services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===============================+========+===============================================================+
+ | ``cdn name/ds xml_id`` | string | identifier for ds or cdn |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>zsk/ksk`` | array | collection of zsk/ksk data |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>ttl`` | string | time-to-live for dnssec requests |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>inceptionDate`` | string | epoch timestamp for when the keys were created |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>expirationDate`` | string | epoch timestamp representing the expiration of the keys |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>private`` | string | encoded private key |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>public`` | string | encoded public key |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>name`` | string | domain name |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``version`` | string | API version |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``ksk>>dsRecord>>algorithm`` | string | The algorithm of the referenced DNSKEY-recor. |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``ksk>>dsRecord>>digestType`` | string | Cryptographic hash algorithm used to create the Digest value. |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``ksk>>dsRecord>>digest`` | string | A cryptographic hash value of the referenced DNSKEY-record. |
+ +-------------------------------+--------+---------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cdn1": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750",
+ "ttl": "60",
+ dsRecord: {
+ "algorithm": "5",
+ "digestType": "2",
+ "digest": "abc123def456"
+ }
+ }
+ },
+ "ds-01": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "ds-01.foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "ds-01.foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750"
+ }
+ },
+ ... repeated for each ds in the cdn
+ },
+ }
+
+
+|
+
+**GET /api/1.2/cdns/name/:name/dnsseckeys/delete**
+
+ Delete dnssec keys for a cdn and all associated delivery services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +----------+----------+----------------------------------------------------------+
+ | Name | Required | Description |
+ +==========+==========+==========================================================+
+ | ``name`` | yes | name of the CDN for which you want to delete dnssec keys |
+ +----------+----------+----------------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------+--------+------------------+
+ | Parameter | Type | Description |
+ +==============+========+==================+
+ | ``response`` | string | success response |
+ +--------------+--------+------------------+
+
+ **Response Example**
+ ::
+
+ {
+ "response": "Successfully deleted dnssec keys for <cdn>"
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/dnsseckeys/generate**
+
+ Generates ZSK and KSK keypairs for a CDN and all associated Delivery Services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Properties**
+
+ +-----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+=========+================================================+
+ | ``key`` | string | name of the cdn |
+ +-----------------------+---------+------------------------------------------------+
+ | ``name`` | string | domain name of the cdn |
+ +-----------------------+---------+------------------------------------------------+
+ | ``ttl`` | string | time to live |
+ +-----------------------+---------+------------------------------------------------+
+ | ``kskExpirationDays`` | string | Expiration (in days) for the key signing keys |
+ +-----------------------+---------+------------------------------------------------+
+ | ``zskExpirationDays`` | string | Expiration (in days) for the zone signing keys |
+ +-----------------------+---------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "cdn1",
+ "name" "ott.kabletown.com",
+ "ttl": "60",
+ "kskExpirationDays": "365",
+ "zskExpirationDays": "90"
+ }
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+
+ {
+ "response": "Successfully created dnssec keys for cdn1"
+ }
+
+.. _to-api-v12-cdn-sslkeys:
+
+SSL Keys
++++++++++++
+
+**GET /api/1.2/cdns/name/:name/sslkeys**
+
+ Returns ssl certificates for all Delivery Services that are a part of the CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===============================+========+===============================================================+
+ | ``deliveryservice`` | string | identifier for deliveryservice xml_id |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``certificate`` | array | collection of certificate |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>key`` | string | base64 encoded private key for ssl certificate |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>crt`` | string | base64 encoded ssl certificate |
+ +-------------------------------+--------+---------------------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "deliveryservice": "ds1",
+ "certificate": {
+ "crt": "base64encodedcrt1",
+ "key": "base64encodedkey1"
+ }
+ },
+ {
+ "deliveryservice": "ds2",
+ "certificate": {
+ "crt": "base64encodedcrt2",
+ "key": "base64encodedkey2"
+ }
+ }
+ ]
+ }
diff --git a/docs/latest/_sources/api/v12/changelog.rst.txt b/docs/latest/_sources/api/v12/changelog.rst.txt
new file mode 100644
index 0000000..ff0d72d
--- /dev/null
+++ b/docs/latest/_sources/api/v12/changelog.rst.txt
@@ -0,0 +1,164 @@
+..
+..
+.. 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-v12-change-logs:
+
+Change Logs
+===========
+
+.. _to-api-v12-change-logs-route:
+
+/api/1.2/logs
++++++++++++++
+
+**GET /api/1.2/logs**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``days`` | no | The number of days of change logs to return. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``limit`` | no | The number of rows to limit the response to. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+==========================================================================+
+ | ``ticketNum`` | string | Optional field to cross reference with any bug tracking systems |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``level`` | string | Log categories for each entry, examples: 'UICHANGE', 'OPER', 'APICHANGE'.|
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | Local unique identifier for the Log |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``user`` | string | Current user who made the change that was logged |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``id`` | string | Local unique identifier for the Log entry |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``message`` | string | Log detail about what occurred |
+ +-----------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "ticketNum": null,
+ "level": "OPER",
+ "lastUpdated": "2015-02-04 22:59:13",
+ "user": "userid852",
+ "id": "22661",
+ "message": "Snapshot CRConfig created."
+ },
+ {
+ "ticketNum": null,
+ "level": "APICHANGE",
+ "lastUpdated": "2015-02-03 17:04:20",
+ "user": "userid853",
+ "id": "22658",
+ "message": "Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"
+ },
+ ],
+ }
+
+|
+
+**GET /api/1.2/logs/:days/days**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-----------------+
+ | Name | Required | Description |
+ +==========+==========+=================+
+ | ``days`` | yes | Number of days. |
+ +----------+----------+-----------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``ticketNum`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``level`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``user`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``message`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "ticketNum": null,
+ "level": "OPER",
+ "lastUpdated": "2015-02-04 22:59:13",
+ "user": "userid852",
+ "id": "22661",
+ "message": "Snapshot CRConfig created."
+ },
+ {
+ "ticketNum": null,
+ "level": "APICHANGE",
+ "lastUpdated": "2015-02-03 17:04:20",
+ "user": "userid853",
+ "id": "22658",
+ "message": "Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/logs/newcount**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``newLogcount`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "newLogcount": 0
+ }
+ }
+
diff --git a/docs/latest/_sources/api/v12/configfiles_ats.rst.txt b/docs/latest/_sources/api/v12/configfiles_ats.rst.txt
new file mode 100644
index 0000000..f2b051a
--- /dev/null
+++ b/docs/latest/_sources/api/v12/configfiles_ats.rst.txt
@@ -0,0 +1,193 @@
+..
+..
+.. 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-v12-configfiles_ats:
+
+Config Files and Config File Metadata
+=====================================
+
+.. _to-api-v12-configfiles_ats-route:
+
+/api/1.2/servers/:hostname/configfiles/ats
+++++++++++++++++++++++++++++++++++++++++++
+
+**GET /api/1.2/servers/:hostname/configfiles/ats**
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operator
+
+ **Request Query Parameters**
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | | | Info Section |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=========================================================================+
+ | ``profileId`` | int | The ID of the profile assigned to the cache. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the profile assigned to the cache. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``toRevProxyUrl`` | string | The configured reverse proxy cache for configfile requests. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``toURL`` | string | The configured URL for Traffic Ops. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``serverIpv4`` | string | The configured IP address of the cache. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``serverName`` | string | The cache's short form hostname. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``serverId`` | int | The cache's Traffic Ops ID. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``cdnId`` | int | The ID of the cache's assigned CDN. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``cdnName`` | string | The name of the cache's assigned CDN. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``serverTcpPort`` | int | The configured port of the server's used by ATS. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``fnameOnDisk`` | string | The filename of the configuration file as stored on the cache. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``location`` | string | The directory location of the configuration file as stored on the cache.|
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``apiUri`` | string | The path to generate the configuration file from Traffic Ops. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+ | ``scope`` | string | The scope of the configuration file. |
+ +-------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "info": {
+ "profileId": 278,
+ "toRevProxyUrl": "https://to.example.com:81",
+ "toUrl": "https://to.example.com/",
+ "serverIpv4": "192.168.1.5",
+ "serverTcpPort": 80,
+ "serverName": "cache-ats-01",
+ "cdnId": 1,
+ "cdnName": "CDN_1",
+ "serverId": 21,
+ "profileName": "EDGE_CDN_1_EXAMPLE"
+ },
+ "configFiles": [
+ {
+ "fnameOnDisk": "remap.config",
+ "location": "/opt/trafficserver/etc/trafficserver",
+ "apiUri": "/api/1.2/profiles/EDGE_CDN_1_EXAMPLE/configfiles/ats/remap.config",
+ "scope": "profiles"
+ },
+ {
+ "fnameOnDisk": "ssl_multicert.config",
+ "location": "/opt/trafficserver/etc/trafficserver",
+ "apiUri": "/api/1.2/cdns/CDN_1/configfiles/ats/ssl_multicert.config",
+ "scope": "cdns"
+ },
+ {
+ "fnameOnDisk": "parent.config",
+ "location": "/opt/trafficserver/etc/trafficserver",
+ "apiUri": "/api/1.2/servers/cache-ats-01/configfiles/ats/parent.config"
+ }
+ ]
+ }
+
+
+/api/1.2/servers/:hostname/configfiles/ats/:configfile
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+**GET /api/1.2/servers/:hostname/configfiles/ats/:configfile**
+**GET /api/1.2/servers/:host_id/configfiles/ats/:configfile**
+
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operator
+
+ **Request Query Parameters**
+
+ **Response Properties**
+
+ Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "error",
+ "text": "Error - incorrect file scope for route used. Please use the profiles route."
+ }
+ ]
+ }
+
+
+/api/1.2/profiles/:profile_name/configfiles/ats/:configfile
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+**GET /api/1.2/profiles/:profile_name/configfiles/ats/:configfile**
+**GET /api/1.2/profiles/:profile_id/configfiles/ats/:configfile**
+
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operator
+
+ **Request Query Parameters**
+
+ **Response Properties**
+
+ Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "error",
+ "text": "Error - incorrect file scope for route used. Please use the cdns route."
+ }
+ ]
+ }
+
+
+/api/1.2/cdns/:cdn_name/configfiles/ats/:configfile
++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+**GET /api/1.2/cdns/:cdn_name/configfiles/ats/:configfile**
+**GET /api/1.2/cdns/:cdn_id/configfiles/ats/:configfile**
+
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operator
+
+ **Request Query Parameters**
+
+ **Response Properties**
+
+ Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "error",
+ "text": "Error - incorrect file scope for route used. Please use the servers route."
+ }
+ ]
+ }
+
diff --git a/docs/latest/_sources/api/v12/deliveryservice.rst.txt b/docs/latest/_sources/api/v12/deliveryservice.rst.txt
new file mode 100644
index 0000000..f977fc9
--- /dev/null
+++ b/docs/latest/_sources/api/v12/deliveryservice.rst.txt
@@ -0,0 +1,3486 @@
+..
+..
+.. 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-v12-ds:
+
+Delivery Service
+================
+
+.. _to-api-v12-ds-route:
+
+/api/1.2/deliveryservices
++++++++++++++++++++++++++
+
+**GET /api/1.2/deliveryservices**
+
+ Retrieves all delivery services (if admin or ops) or all delivery services assigned to user. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``cdn`` | no | Filter delivery services by CDN ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``profile`` | no | Filter delivery services by Profile ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``tenant`` | no | Filter delivery services by Tenant ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``type`` | no | Filter delivery services by Type ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``logsEnabled`` | no | Filter by logs enabled (true|false). |
+ +-----------------+----------+---------------------------------------------------+
+
+
+ **Response Properties**
+
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``anonymousBlockingEnabled`` | bool | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassCname`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | int | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | int | The deliveryservice id (database row number). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 1. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. 39.7391500 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. -104.9847000 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | int | How to treat range requests: |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | List of header keys separated by __RETURN__. Listed headers will be included in TR access log entries under the "rh=" token. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | List of header name:value pairs separated by __RETURN__. Listed pairs will be included in all TR HTTP responses. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "deepCachingType": "NEVER",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://foo.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "fqPacingRate": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "39.7391500",
+ "missLong": "-104.9847000",
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "foo",
+ "signed": false,
+ "signingAlgorithm": null,
+ "sslKeyVersion": "0",
+ "tenant": "root",
+ "tenantId": 1,
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/deliveryservices/:id**
+
+ Retrieves a specific delivery service. If not admin / ops, delivery service must be assigned to user. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | Delivery service ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``anonymousBlockingEnabled`` | bool | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassCname`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | int | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | int | The deliveryservice id (database row number). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 1. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. 39.7391500 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. -104.9847000 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | int | How to treat range requests: |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "deepCachingType": "NEVER",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://foo.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "fqPacingRate": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "39.7391500",
+ "missLong": "-104.9847000",
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "foo",
+ "signed": false,
+ "signingAlgorithm": null,
+ "sslKeyVersion": "0",
+ "tenant": "root",
+ "tenantId": 1,
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/:id/servers**
+
+ Retrieves properties of CDN EDGE or ORG servers assigned to a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations or delivery service must be assigned to user.
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | Delivery service ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/:id/servers/unassigned**
+
+ Retrieves properties of CDN EDGE or ORG servers not assigned to a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations or delivery service must be assigned to user
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | Delivery service ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/:id/servers/eligible**
+
+ Retrieves properties of CDN EDGE or ORG servers not eligible for assignment to a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations or delivery service must be assigned to user
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | Delivery service ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+
+.. _to-api-v12-ds-health:
+
+Health
+++++++
+
+**GET /api/1.2/deliveryservices/:id/state**
+
+ Retrieves the failover state for a delivery service. Delivery service must be assigned to user if user is not admin or operations.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+---------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+=================================================+
+ | ``failover`` | hash | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>locations`` | array | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>destination`` | hash | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>>location`` | string | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>>type`` | string | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>configured`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>enabled`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+ | ``enabled`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "failover": {
+ "locations": [ ],
+ "destination": {
+ "location": null,
+ "type": "DNS",
+ },
+ "configured": false,
+ "enabled": false
+ },
+ "enabled": true
+ }
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/:id/health**
+
+ Retrieves the health of all locations (cache groups) for a delivery service. Delivery service must be assigned to user if user is not admin or operations.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ }
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/:id/capacity**
+
+ Retrieves the capacity percentages of a delivery service. Delivery service must be assigned to user if user is not admin or operations.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +========================+========+===================================================+
+ | ``availablePercent`` | number | The percentage of server capacity assigned to |
+ | | | the delivery service that is available. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``unavailablePercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service that is unavailable. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``utilizedPercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service being used. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``maintenancePercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service that is down for maintenance. |
+ +------------------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "availablePercent": 89.0939840205533,
+ "unavailablePercent": 0,
+ "utilizedPercent": 10.9060020300395,
+ "maintenancePercent": 0.0000139494071146245
+ },
+ }
+
+
+|
+
+**GET /api/1.2/deliveryservices/:id/routing**
+
+ Retrieves the routing method percentages of a delivery service. Delivery service must be assigned to user if user is not admin or operations.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+=============================================================================================================================+
+ | ``staticRoute`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``miss`` | number | The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP). |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``geo`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``err`` | number | The percentage of Traffic Router requests for this deliveryservice resulting in an error. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``cz`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF (coverage zone file) hit. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``dsr`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the |
+ | | | client to the overflow CDN. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``fed`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to a federated CDN. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalAlternate`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to the alternate |
+ | | | regional geoblocking URL. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalDenied`` | number | The percent of Traffic Router requests for this deliveryservice denied due to geolocation policy. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "staticRoute": 0,
+ "miss": 0,
+ "geo": 37.8855391018869,
+ "err": 0,
+ "cz": 62.1144608981131,
+ "dsr": 0,
+ "fed": 0,
+ "regionalAlternate": 0,
+ "regionalDenied": 0
+ },
+ }
+
+
+.. _to-api-v12-ds-server:
+
+Delivery Service Server
++++++++++++++++++++++++
+
+**GET /api/1.2/deliveryserviceserver**
+
+ Retrieves delivery service / server assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``page`` | no | The page number for use in pagination. |
+ +-----------+----------+----------------------------------------+
+ | ``limit`` | no | For use in limiting the result set. |
+ +-----------+----------+----------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``lastUpdated`` | array | |
+ +----------------------+--------+------------------------------------------------+
+ |``server`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``deliveryService`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "page": 2,
+ "orderby": "deliveryservice",
+ "response": [
+ {
+ "lastUpdated": "2014-09-26 17:53:43",
+ "server": "20",
+ "deliveryService": "1"
+ },
+ {
+ "lastUpdated": "2014-09-26 17:53:44",
+ "server": "21",
+ "deliveryService": "1"
+ },
+ ],
+ "limit": 2
+ }
+
+**POST /api/1.2/deliveryserviceserver**
+
+ Create one or more delivery service / server assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations or the delivery service is assigned to the user.
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``dsId`` | yes | The ID of the delivery service. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``servers`` | yes | An array of server IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing ds/server assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "dsId": 246,
+ "servers": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``dsId`` | int | The ID of the delivery service. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``servers`` | array | An array of server IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | array | Existing ds/server assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Server assignments complete."
+ }
+ ],
+ "response": {
+ "dsId" : 246,
+ "servers" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
+
+**DELETE /api/1.2/deliveryservice_server/:dsId/:serverId**
+
+ Removes a server (cache) from a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Oper (if delivery service is not assigned to user)
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``dsId`` | yes | Delivery service ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``serverId`` | yes | Server (cache) ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Server unlinked from delivery service."
+ }
+ ],
+ }
+
+|
+
+.. _to-api-v12-ds-user:
+
+Delivery Service User
++++++++++++++++++++++
+
+**POST /api/1.2/deliveryservice_user**
+
+ Create one or more user / delivery service assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``userId`` | yes | The ID of the user. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``deliveryServices`` | yes | An array of delivery service IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing user/ds assignments? (true|false). |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "userId": 50,
+ "deliveryServices": [ 23, 34, 45, 56, 67 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``userId`` | int | The ID of the user. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``deliveryServices`` | array | An array of delivery service IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | array | Existing user/ds assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Delivery service assignments complete."
+ }
+ ],
+ "response": {
+ "userId" : 50,
+ "deliveryServices": [ 23, 34, 45, 56, 67 ],
+ "replace": true
+ }
+ }
+
+|
+
+**DELETE /api/1.2/deliveryservice_user/:dsId/:userId**
+
+ Removes a delivery service from a user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``dsId`` | yes | Delivery service ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``userId`` | yes | User ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "User and delivery service were unlinked."
+ }
+ ],
+ }
+
+|
+
+.. _to-api-v12-ds-sslkeys:
+
+SSL Keys
+++++++++
+
+**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys**
+
+ Retrieves ssl keys for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+============================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------------------+
+ | ``decode`` | no | a boolean value to decode the certs or not |
+ +-------------+----------+--------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded (or not if decode=true) crt file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded (or not if decode=true) csr file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded (or not if decode=true) private key file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdn`` | string | The CDN of the delivery service for which the certs were generated. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deliveryservice`` | string | The XML ID of the delivery service for which the cert was generated. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname generated by Traffic Ops that is used as the common name when generating the certificate. |
+ | | | This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "certificate": {
+ "crt": "crt",
+ "key": "key",
+ "csr": "csr"
+ },
+ "deliveryservice": "my-ds",
+ "cdn": "qa",
+ "businessUnit": "CDN_Eng",
+ "city": "Denver",
+ "organization": "KableTown",
+ "hostname": "foober.com",
+ "country": "US",
+ "state": "Colorado",
+ "version": "1"
+ }
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/hostname/:hostname/sslkeys**
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +--------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+===================================================+
+ | ``hostname`` | yes | pristine hostname of the desired delivery service |
+ +--------------+----------+---------------------------------------------------+
+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+============================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------------------+
+ | ``decode`` | no | a boolean value to decode the certs or not |
+ +-------------+----------+--------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded (or not if decode=true) crt file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded (or not if decode=true) csr file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded (or not if decode=true) private key file for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdn`` | string | The CDN of the delivery service for which the certs were generated. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deliveryservice`` | string | The XML ID of the delivery service for which the cert was generated. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname generated by Traffic Ops that is used as the common name when generating the certificate. |
+ | | | This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "certificate": {
+ "crt": "crt",
+ "key": "key",
+ "csr": "csr"
+ },
+ "deliveryservice": "my-ds",
+ "cdn": "qa",
+ "businessUnit": "CDN_Eng",
+ "city": "Denver",
+ "organization": "KableTown",
+ "hostname": "foober.com",
+ "country": "US",
+ "state": "Colorado",
+ "version": "1"
+ }
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys/delete**
+
+ Authentication Required: Yes
+
+ Role Required: Operations
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------+
+ | Name | Required | Description |
+ +=============+==========+================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +--------------+--------+------------------+
+ | Parameter | Type | Description |
+ +==============+========+==================+
+ | ``response`` | string | success response |
+ +--------------+--------+------------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully deleted ssl keys for <xml_id>"
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/sslkeys/generate**
+
+ Generates SSL crt, csr, and private key for a delivery service
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations
+
+ **Request Properties**
+
+ +---------------------+---------+-----------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+=========+=================================================================+
+ | ``key`` | string | xml_id of the delivery service |
+ +---------------------+---------+-----------------------------------------------------------------+
+ | ``version`` | string | version of the keys being generated |
+ +---------------------+---------+-----------------------------------------------------------------+
+ | ``hostname`` | string | the *pristine hostname* of the delivery service |
+ +---------------------+---------+-----------------------------------------------------------------+
+ | ``country`` | string | Country |
+ +---------------------+---------+-----------------------------------------------------------------+
+ | ``state`` | string | State |
+ +---------------------+---------+-----------------------------------------------------------------+
+ | ``city`` | string | City |
+ +---------------------+---------+-----------------------------------------------------------------+
+ | ``org`` | string | Organization |
+ +---------------------+---------+-----------------------------------------------------------------+
+ | ``unit`` | boolean | Business Unit |
+ +---------------------+---------+-----------------------------------------------------------------+
+ | ``deliveryservice`` | string | The deliveryservice xml-id for which you want to generate certs |
+ +---------------------+---------+-----------------------------------------------------------------+
+ | ``cdn`` | string | The name of the CDN for which the deliveryservice belongs |
+ +---------------------+---------+-----------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "ds-01",
+ "businessUnit": "CDN Engineering",
+ "version": "3",
+ "hostname": "tr.ds-01.ott.kabletown.com",
+ "certificate": {
+ "key": "some_key",
+ "csr": "some_csr",
+ "crt": "some_crt"
+ },
+ "country": "US",
+ "organization": "Kabletown",
+ "city": "Denver",
+ "state": "Colorado",
+ "deliveryservice" : "ds-01",
+ "cdn": "cdn1"
+ }
+
+|
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully created ssl keys for ds-01"
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/sslkeys/add**
+
+ Allows user to add SSL crt, csr, and private key for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations
+
+ **Request Properties**
+
+ +---------------------+--------+-----------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=================================================================+
+ | ``key`` | string | xml_id of the delivery service |
+ +---------------------+--------+-----------------------------------------------------------------+
+ | ``version`` | string | version of the keys being generated |
+ +---------------------+--------+-----------------------------------------------------------------+
+ | ``csr`` | string | |
+ +---------------------+--------+-----------------------------------------------------------------+
+ | ``crt`` | string | |
+ +---------------------+--------+-----------------------------------------------------------------+
+ | ``key`` | string | |
+ +---------------------+--------+-----------------------------------------------------------------+
+ | ``deliveryservice`` | string | The deliveryservice xml-id for which you want to generate certs |
+ +---------------------+--------+-----------------------------------------------------------------+
+ | ``cdn`` | string | The name of the CDN for which the deliveryservice belongs |
+ +---------------------+--------+-----------------------------------------------------------------+
+ | ``hostname`` | string | the *pristine hostname* of the delivery service |
+ +---------------------+--------+-----------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "ds-01",
+ "version": "1",
+ "certificate": {
+ "key": "some_key",
+ "csr": "some_csr",
+ "crt": "some_crt"
+ }
+ }
+
+|
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully added ssl keys for ds-01"
+ }
+
+URL Sig Keys
+++++++++++++
+
+**GET /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys**
+
+ Retrieves URL sig keys for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=========================================================================================================================================+
+ | ``key0`` | string | base64 encoded key for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key2`` | string | base64 encoded key for delivery service |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``keyn...`` | string | base64 encoded key for delivery service -- repeats to 15 (16 total) and is currently unsorted. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ key9":"ZvVQNYpPVQWQV8tjQnUl6osm4y7xK4zD",
+ "key6":"JhGdpw5X9o8TqHfgezCm0bqb9SQPASWL",
+ "key8":"ySXdp1T8IeDEE1OCMftzZb9EIw_20wwq",
+ "key0":"D4AYzJ1AE2nYisA9MxMtY03TPDCHji9C",
+ "key3":"W90YHlGc_kYlYw5_I0LrkpV9JOzSIneI",
+ "key12":"ZbtMb3mrKqfS8hnx9_xWBIP_OPWlUpzc",
+ "key2":"0qgEoDO7sUsugIQemZbwmMt0tNCwB1sf",
+ "key4":"aFJ2Gb7atmxVB8uv7T9S6OaDml3ycpGf",
+ "key1":"wnWNR1mCz1O4C7EFPtcqHd0xUMQyNFhA",
+ "key11":"k6HMzlBH1x6htKkypRFfWQhAndQqe50e",
+ "key10":"zYONfdD7fGYKj4kLvIj4U0918csuZO0d",
+ "key15":"3360cGaIip_layZMc_0hI2teJbazxTQh",
+ "key5":"SIwv3GOhWN7EE9wSwPFj18qE4M07sFxN",
+ "key13":"SqQKBR6LqEOzp8AewZUCVtBcW_8YFc1g",
+ "key14":"DtXsu8nsw04YhT0kNoKBhu2G3P9WRpQJ",
+ "key7":"cmKoIIxXGAxUMdCsWvnGLoIMGmNiuT5I"
+ }
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys/generate**
+
+ Generates Url sig keys for a delivery service
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+|
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully generated and stored keys"
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys/copyFromXmlId/:copyFromXmlId**
+
+ Allows user to copy url sig keys from a specified delivery service to a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations
+
+**Request Route Parameters**
+
+ +-------------------+----------+-----------------------------------------------------------+
+ | Name | Required | Description |
+ +===================+==========+===========================================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-------------------+----------+-----------------------------------------------------------+
+ | ``copyFromXmlId`` | yes | xml_id of the delivery service to copy url sig keys from |
+ +-------------------+----------+-----------------------------------------------------------+
+
+|
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully copied and stored keys"
+ }
+
+**POST /api/1.2/deliveryservices/request**
+
+ Allows a user to send delivery service request details to a specified email address.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | Parameter | Type | Required | Description |
+ +========================================+========+==========+=============================================================================================+
+ | ``emailTo`` | string | yes | The email to which the delivery service request will be sent. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``details`` | hash | yes | Parameters for the delivery service request. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>customer`` | string | yes | Name of the customer to associated with the delivery service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>deepCachingType`` | string | no | When to do Deep Caching for this Delivery Service: |
+ | | | | |
+ | | | | - NEVER (default) |
+ | | | | - ALWAYS |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>deliveryProtocol`` | string | yes | Eg. http or http/https |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>routingType`` | string | yes | Eg. DNS or HTTP Redirect |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>routingName`` | string | no | The routing name for the delivery service, e.g. <routingName>.<xmlId>.cdn.com |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>serviceDesc`` | string | yes | A description of the delivery service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>peakBPSEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>peakTPSEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>maxLibrarySizeEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>originURL`` | string | yes | The URL path to the origin server. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>hasOriginDynamicRemap`` | bool | yes | This is a feature which allows services to use multiple origin URLs for the same service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>originTestFile`` | string | yes | A URL path to a test file available on the origin server. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>hasOriginACLWhitelist`` | bool | yes | Is access to your origin restricted using an access control list (ACL or whitelist) of Ips? |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>originHeaders`` | string | no | Header values that must be passed to requests to your origin. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>otherOriginSecurity`` | string | no | Other origin security measures that need to be considered for access. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>queryStringHandling`` | string | yes | How to handle query strings that come with the request. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>rangeRequestHandling`` | string | yes | How to handle range requests. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>hasSignedURLs`` | bool | yes | Are Urls signed? |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>hasNegativeCachingCustomization`` | bool | yes | Any customization required for negative caching? |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>negativeCachingCustomizationNote`` | string | yes | Negative caching customization instructions. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>serviceAliases`` | array | no | Service aliases which will be used for this service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>rateLimitingGBPS`` | int | no | Rate Limiting - Bandwidth (Gbps) |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>rateLimitingTPS`` | int | no | Rate Limiting - Transactions/Second |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>overflowService`` | string | no | An overflow point (URL or IP address) used if rate limits are met. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>headerRewriteEdge`` | string | no | Headers can be added or altered at each layer of the CDN. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>headerRewriteMid`` | string | no | Headers can be added or altered at each layer of the CDN. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>headerRewriteRedirectRouter`` | string | no | Headers can be added or altered at each layer of the CDN. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>notes`` | string | no | Additional instructions to provide the delivery service provisioning team. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "emailTo": "foo@bar.com",
+ "details": {
+ "customer": "XYZ Corporation",
+ "contentType": "video-on-demand",
+ "deepCachingType": "NEVER",
+ "deliveryProtocol": "http",
+ "routingType": "dns",
+ "routingName": "foo",
+ "serviceDesc": "service description goes here",
+ "peakBPSEstimate": "less-than-5-Gbps",
+ "peakTPSEstimate": "less-than-1000-TPS",
+ "maxLibrarySizeEstimate": "less-than-200-GB",
+ "originURL": "http://myorigin.com",
+ "hasOriginDynamicRemap": false,
+ "originTestFile": "http://myorigin.com/crossdomain.xml",
+ "hasOriginACLWhitelist": true,
+ "originHeaders": "",
+ "otherOriginSecurity": "",
+ "queryStringHandling": "ignore-in-cache-key-and-pass-up",
+ "rangeRequestHandling": "range-requests-not-used",
+ "hasSignedURLs": true,
+ "hasNegativeCachingCustomization": true,
+ "negativeCachingCustomizationNote": "negative caching instructions",
+ "serviceAliases": [
+ "http://alias1.com",
+ "http://alias2.com"
+ ],
+ "rateLimitingGBPS": 50,
+ "rateLimitingTPS": 5000,
+ "overflowService": "http://overflowcdn.com",
+ "headerRewriteEdge": "",
+ "headerRewriteMid": "",
+ "headerRewriteRedirectRouter": "",
+ "notes": ""
+ }
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Delivery Service request sent to foo@bar.com."
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/deliveryservices**
+
+ Allows user to create a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Properties**
+
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +==============================+==========+=========================================================================================================+
+ | active | yes | true if active, false if inactive. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | anonymousBlockingEnabled | no | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | cacheurl | no | Cache URL rule to apply to this delivery service. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | ccrDnsTtl | no | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | cdnId | yes | cdn id |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | checkPath | no | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | deepCachingType | no | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | displayName | yes | Display name |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassCname | no | Bypass CNAME |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassIp | no | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassIp6 | no | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassTtl | no | The TTL of the DNS bypass response. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dscp | yes | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | edgeHeaderRewrite | no | The EDGE header rewrite actions to perform. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | fqPacingRate | no | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimit | yes | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from geo limit countries |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimitCountries | no | The geo limit countries. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoProvider | yes | - 0: Maxmind(default) |
+ | | | - 1: Neustar |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | globalMaxMbps | no | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | globalMaxTps | no | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | httpBypassFqdn | no | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more |
+ | | | than the globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | infoUrl | no | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | initialDispersion | yes|no | Initial dispersion. Required for HTTP* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | ipv6RoutingEnabled | yes|no | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ | | | Required for DNS*, HTTP* and STEERING* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | logsEnabled | yes | - false: No |
+ | | | - true: Yes |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc | no | Description field. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc1 | no | Description field 1. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc2 | no | Description field 2. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | maxDnsAnswers | no | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | midHeaderRewrite | no | The MID header rewrite actions to perform. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | missLat | yes|no | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | missLong | yes|no | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | multiSiteOrigin | yes|no | true if enabled, false if disabled. Required for DNS* and HTTP* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | orgServerFqdn | yes|no | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. This field is |
+ | | | required if type is DNS* or HTTP*. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | originShield | no | Origin shield |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | profileId | no | DS profile ID |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | protocol | yes|no | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ | | | |
+ | | | Required for DNS*, HTTP* or *STEERING* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | qstringIgnore | yes|no | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ | | | |
+ | | | Required for DNS* and HTTP* delivery services. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | rangeRequestHandling | yes|no | How to treat range requests (required for DNS* and HTTP* delivery services): |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
+ | | | be a HIT) |
+ | | | - 1 Use the background_fetch plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | regionalGeoBlocking | yes | Is the Regional Geo Blocking feature enabled. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | remapText | no | Additional raw remap line text. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | routingName | yes | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | signingAlgorithm | no | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | sslKeyVersion | no | SSL key version |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | tenantId | No | Owning tenant ID |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | trRequestHeaders | no | Traffic router log request headers |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | trResponseHeaders | no | Traffic router additional response headers |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | typeId | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | xmlId | yes | Unique string that describes this deliveryservice. |
+ +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "xmlId": "my_ds_1",
+ "displayName": "my_ds_displayname_1",
+ "tenantId": 1,
+ "protocol": 1,
+ "orgServerFqdn": "http://10.75.168.91",
+ "cdnId": 2,
+ "typeId": 42,
+ "active": false,
+ "dscp": 10,
+ "geoLimit": 0,
+ "geoProvider": 0,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": false,
+ "logsEnabled": false,
+ "multiSiteOrigin": false,
+ "missLat": 39.7391500,
+ "missLong": -104.9847000,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regionalGeoBlocking": false,
+ "anonymousBlockingEnabled": false,
+ "signed": false,
+ "signingAlgorithm": null
+ }
+
+
+ **Response Properties**
+
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``anonymousBlockingEnabled`` | bool | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassCname`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | int | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | int | The deliveryservice id (database row number). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 1. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. 39.7391500 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. -104.9847000 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | int | How to treat range requests: |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "deepCachingType": "NEVER",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://foo.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "fqPacingRate": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "39.7391500",
+ "missLong": "-104.9847000",
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "foo",
+ "signed": false,
+ "signingAlgorithm": null,
+ "sslKeyVersion": "0",
+ "tenantId": 1,
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/deliveryservices/{:id}**
+
+ Allows user to edit a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Properties**
+
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +==========================+==========+=========================================================================================================+
+ | active | yes | true if active, false if inactive. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | anonymousBlockingEnabled | no | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | cacheurl | no | Cache URL rule to apply to this delivery service. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | ccrDnsTtl | no | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | cdnId | yes | cdn id |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | checkPath | no | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | deepCachingType | no | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | displayName | yes | Display name |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassCname | no | Bypass CNAME |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassIp | no | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassIp6 | no | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassTtl | no | The TTL of the DNS bypass response. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dscp | yes | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | edgeHeaderRewrite | no | The EDGE header rewrite actions to perform. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | fqPacingRate | no | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimit | yes | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from geo limit countries |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimitCountries | no | The geo limit countries. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoProvider | yes | - 0: Maxmind(default) |
+ | | | - 1: Neustar |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | globalMaxMbps | no | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | globalMaxTps | no | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | httpBypassFqdn | no | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more |
+ | | | than the globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | infoUrl | no | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | initialDispersion | yes|no | Initial dispersion. Required for HTTP* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | ipv6RoutingEnabled | yes|no | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ | | | Required for DNS*, HTTP* and STEERING* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | logsEnabled | yes | - false: No |
+ | | | - true: Yes |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc | no | Description field. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc1 | no | Description field 1. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc2 | no | Description field 2. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | maxDnsAnswers | no | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | midHeaderRewrite | no | The MID header rewrite actions to perform. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | missLat | yes|no | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | missLong | yes|no | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | multiSiteOrigin | yes|no | true if enabled, false if disabled. Required for DNS* and HTTP* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | orgServerFqdn | yes|no | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. This field is |
+ | | | required if type is DNS* or HTTP*. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | originShield | no | Origin shield |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | profileId | no | DS profile ID |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | protocol | yes|no | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ | | | |
+ | | | Required for DNS*, HTTP* or *STEERING* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | qstringIgnore | yes|no | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ | | | |
+ | | | Required for DNS* and HTTP* delivery services. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | rangeRequestHandling | yes|no | How to treat range requests (required for DNS* and HTTP* delivery services): |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
+ | | | be a HIT) |
+ | | | - 1 Use the background_fetch plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | regionalGeoBlocking | yes | Is the Regional Geo Blocking feature enabled. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | remapText | no | Additional raw remap line text. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | routingName | yes | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | signingAlgorithm | no | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | sslKeyVersion | no | SSL key version |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | tenantId | No | Owning tenant ID |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | trRequestHeaders | no | Traffic router log request headers |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | trResponseHeaders | no | Traffic router additional response headers |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | typeId | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | xmlId | yes | Unique string that describes this deliveryservice. This value cannot be changed on update. |
+ +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "xmlId": "my_ds_1",
+ "displayName": "my_ds_displayname_1",
+ "tenantId": 1,
+ "protocol": 1,
+ "orgServerFqdn": "http://10.75.168.91",
+ "cdnId": 2,
+ "typeId": 42,
+ "active": false,
+ "dscp": 10,
+ "geoLimit": 0,
+ "geoProvider": 0,
+ "initialDispersion": 1,
+ "ipv6RoutingEnabled": false,
+ "logsEnabled": false,
+ "multiSiteOrigin": false,
+ "missLat": 39.7391500,
+ "missLong": -104.9847000,
+ "qstringIgnore": 0,
+ "rangeRequestHandling": 0,
+ "regionalGeoBlocking": false,
+ "anonymousBlockingEnabled": false,
+ "signed": false,
+ "signingAlgorithm": null
+ }
+
+
+ **Response Properties**
+
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``anonymousBlockingEnabled`` | bool | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassCname`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | int | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | int | The deliveryservice id (database row number). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 1. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. 39.7391500 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. -104.9847000 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | int | How to treat range requests: |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "deepCachingType": "NEVER",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://foo.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "fqPacingRate": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "39.7391500",
+ "missLong": "-104.9847000",
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "foo",
+ "signed": false,
+ "signingAlgorithm": null,
+ "sslKeyVersion": "0",
+ "tenantId": 1,
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/deliveryservices/{:id}/safe**
+
+ Allows a user to edit limited fields of an assigned delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: users with the delivery service assigned or ops and above
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Properties**
+
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +========================+==========+=========================================================================================================+
+ | displayName | no | Display name |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | infoUrl | no | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc | no | Description field. |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | longDesc1 | no | Description field 1. |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | all other fields | n/a | All other fields will be silently ignored |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "displayName": "My Cool Delivery Service",
+ "infoUrl": "www.info.com",
+ "longDesc": "some info about the service",
+ "longDesc1": "the customer label"
+ }
+
+
+ **Response Properties**
+
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``anonymousBlockingEnabled`` | bool | - true: enable blocking clients with anonymous ips |
+ | | | - false: disabled |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | int | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | int | Id of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassCname`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | int | The TTL of the DNS bypass response. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | int | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``fqPacingRate`` | int | The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded, |
+ | | | will be rate limited by the Linux kernel. A default value of 0 disables this feature |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | int | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | int | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | int | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | int | The deliveryservice id (database row number). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 1. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | int | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | float | The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. 39.7391500 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
+ | | | - e.g. -104.9847000 or null |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | int | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | int | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | int | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | int | How to treat range requests: |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signingAlgorithm`` | string | - null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - "url_sig": URL Sign token based auth is enabled for this deliveryservice. |
+ | | | - "uri_signing": URI Signing token based auth is enabled for this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | int | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | int | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "anonymousBlockingEnabled": false,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "deepCachingType": "NEVER",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://foo.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "fqPacingRate": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "www.info.com",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "some info about the service",
+ "longDesc1": "the customer label",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "39.7391500",
+ "missLong": "-104.9847000",
+ "multiSiteOrigin": false,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "foo",
+ "signed": false,
+ "signingAlgorithm": null,
+ "sslKeyVersion": "0",
+ "tenantId": 1,
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/deliveryservices/{:id}**
+
+ Allows user to delete a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Delivery service was deleted."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/:xml_id/servers**
+
+ Assign caches to a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +--------+----------+-----------------------------------+
+ | Name | Required | Description |
+ +========+==========+===================================+
+ | xml_id | yes | the xml_id of the deliveryservice |
+ +--------+----------+-----------------------------------+
+
+ **Request Properties**
+
+ +--------------+----------+-------------------------------------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +==============+==========+=============================================================================================================+
+ | serverNames | yes | array of hostname of cache servers to assign to this deliveryservice, for example: [ "server1", "server2" ] |
+ +--------------+----------+-------------------------------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "serverNames": [
+ "tc1_ats1"
+ ]
+ }
+
+ **Response Properties**
+
+ +--------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============+========+=============================================================================================================+
+ | xml_id | string | Unique string that describes this delivery service. |
+ +--------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | serverNames | string | array of hostname of cache servers to assign to this deliveryservice, for example: [ "server1", "server2" ] |
+ +--------------+--------+-------------------------------------------------------------------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "serverNames":[
+ "tc1_ats1"
+ ],
+ "xmlId":"my_ds_1"
+ }
+ }
+
+|
+
+URI Signing Keys
+++++++++++++++++
+
+**DELETE /api/1.2/deliveryservices/:xml_id/urisignkeys**
+
+ Deletes URISigning objects for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | xml_id | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+**GET /api/1.2/deliveryservices/:xml_id/urisignkeys**
+
+ Retrieves one or more URISigning objects for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | xml_id | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=========================================================================================================================================+
+ | ``Issuer`` | string | a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``renewal_kid`` | string | a string naming the jwt key used for renewals. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``keys`` | string | json array of jwt symmetric keys . |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``alg`` | string | this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``kid`` | string | this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``kty`` | string | this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``k`` | string | this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "Kabletown URI Authority": {
+ "renewal_kid": "Second Key",
+ "keys": [
+ {
+ "alg": "HS256",
+ "kid": "First Key",
+ "kty": "oct",
+ "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"
+ },
+ {
+ "alg": "HS256",
+ "kid": "Second Key",
+ "kty": "oct",
+ "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"
+ }
+ ]
+ }
+ }
+
+
+**POST /api/1.2/deliveryservices/:xml_id/urisignkeys**
+
+ Assigns URISigning objects to a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | xml_id | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+ **Request Properties**
+
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=========================================================================================================================================+
+ | ``Issuer`` | string | a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``renewal_kid`` | string | a string naming the jwt key used for renewals. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``keys`` | string | json array of jwt symmetric keys . |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``alg`` | string | this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``kid`` | string | this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``kty`` | string | this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``k`` | string | this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "Kabletown URI Authority": {
+ "renewal_kid": "Second Key",
+ "keys": [
+ {
+ "alg": "HS256",
+ "kid": "First Key",
+ "kty": "oct",
+ "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"
+ },
+ {
+ "alg": "HS256",
+ "kid": "Second Key",
+ "kty": "oct",
+ "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"
+ }
+ ]
+ }
+ }
+
+**PUT /api/1.2/deliveryservices/:xml_id/urisignkeys**
+
+ updates URISigning objects on a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | xml_id | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+ **Request Properties**
+
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+=========================================================================================================================================+
+ | ``Issuer`` | string | a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``renewal_kid`` | string | a string naming the jwt key used for renewals. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``keys`` | string | json array of jwt symmetric keys . |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``alg`` | string | this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``kid`` | string | this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``kty`` | string | this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``k`` | string | this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516. |
+ +---------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "Kabletown URI Authority": {
+ "renewal_kid": "Second Key",
+ "keys": [
+ {
+ "alg": "HS256",
+ "kid": "First Key",
+ "kty": "oct",
+ "k": "Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"
+ },
+ {
+ "alg": "HS256",
+ "kid": "Second Key",
+ "kty": "oct",
+ "k": "fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"
+ }
+ ]
+ }
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v12/deliveryservice_regex.rst.txt b/docs/latest/_sources/api/v12/deliveryservice_regex.rst.txt
new file mode 100644
index 0000000..ccd12c4
--- /dev/null
+++ b/docs/latest/_sources/api/v12/deliveryservice_regex.rst.txt
@@ -0,0 +1,374 @@
+..
+..
+.. 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-v12-ds-regexes:
+
+Delivery Service Regexes
+========================
+
+.. _to-api-v12-ds-regexes-route:
+
+
+**GET /api/1.2/deliveryservices_regexes**
+
+ Retrieves regexes for all delivery services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Oper
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``dsName`` | array | Delivery service name. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``regexes`` | array | An array of regexes for the delivery service. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>type`` | string | The regex type. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>pattern`` | string | The regex pattern. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>setNumber`` | string | The order in which the regex is evaluated. |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "dsName": "foo-bar",
+ "regexes": [
+ {
+ "type": "HOST_REGEXP",
+ "pattern": ".*\.foo-bar\..*",
+ "setNumber": 0
+ },
+ {
+ "type": "HOST_REGEXP",
+ "pattern": "foo.bar.com",
+ "setNumber": 1
+ }
+ ]
+ },
+ { ... }
+ ]
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/{:dsId}/regexes**
+
+ Retrieves regexes for a specific delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``dsId`` | yes | Delivery service id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``id`` | string | Delivery service regex ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``type`` | string | Delivery service regex type ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``typeName`` | string | Delivery service regex type name. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``pattern`` | string | Delivery service regex pattern. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 852,
+ "type": 18,
+ "typeName": "HOST_REGEXP",
+ "pattern": ".*\.foo-bar\..*",
+ "setNumber": 0
+ },
+ {
+ "id": 853,
+ "type": 18,
+ "typeName": "HOST_REGEXP",
+ "pattern": "foo.bar.com",
+ "setNumber": 1
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/{:dsId}/regexes/{:id}**
+
+ Retrieves a regex for a specific delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``dsId`` | yes | Delivery service id. |
+ +-----------+----------+---------------------------------------------+
+ | ``id`` | yes | Delivery service regex id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``id`` | string | Delivery service regex ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``type`` | string | Delivery service regex type ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``typeName`` | string | Delivery service regex type name. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``pattern`` | string | Delivery service regex pattern. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 852,
+ "type": 18,
+ "typeName": "HOST_REGEXP",
+ "pattern": ".*\.foo-bar\..*",
+ "setNumber": 0
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/{:dsId}/regexes**
+
+ Create a regex for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Oper
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``dsId`` | yes | Delivery service id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Request Properties**
+
+ +---------------+----------+---------------------------------------------+
+ | Parameter | Required | Description |
+ +===============+==========+=============================================+
+ | ``pattern`` | yes | Regex pattern. |
+ +---------------+----------+---------------------------------------------+
+ | ``type`` | yes | Regex type ID. |
+ +---------------+----------+---------------------------------------------+
+ | ``setNumber`` | yes | Regex type ID. |
+ +---------------+----------+---------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "pattern": ".*\.foo-bar\..*"
+ "type": 18
+ "setNumber": 0
+ }
+
+|
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``id`` | string | Delivery service regex ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``type`` | string | Delivery service regex type ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``typeName`` | string | Delivery service regex type name. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``pattern`` | string | Delivery service regex pattern. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": 852,
+ "type": 18,
+ "typeName": "HOST_REGEXP",
+ "pattern": ".*\.foo-bar\..*",
+ "setNumber": 0
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Delivery service regex creation was successful."
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/deliveryservices/{:dsId}/regexes/{:id}**
+
+ Update a regex for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Oper
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``dsId`` | yes | Delivery service id. |
+ +-----------+----------+---------------------------------------------+
+ | ``id`` | yes | Delivery service regex id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Request Properties**
+
+ +---------------+----------+---------------------------------------------+
+ | Parameter | Required | Description |
+ +===============+==========+=============================================+
+ | ``pattern`` | yes | Regex pattern. |
+ +---------------+----------+---------------------------------------------+
+ | ``type`` | yes | Regex type ID. |
+ +---------------+----------+---------------------------------------------+
+ | ``setNumber`` | yes | Regex type ID. |
+ +---------------+----------+---------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "pattern": ".*\.foo-bar\..*"
+ "type": 18
+ "setNumber": 0
+ }
+
+|
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``id`` | string | Delivery service regex ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``type`` | string | Delivery service regex type ID. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``typeName`` | string | Delivery service regex type name. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``pattern`` | string | Delivery service regex pattern. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``setNumber`` | string | The order in which the regex is evaluated for the delivery service. |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": 852,
+ "type": 18,
+ "typeName": "HOST_REGEXP",
+ "pattern": ".*\.foo-bar\..*",
+ "setNumber": 0
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Delivery service regex update was successful."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/deliveryservices/{:dsId}/regexes/{:id}**
+
+ Delete delivery service regex.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Oper
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``dsId`` | yes | Delivery service id. |
+ +-----------+----------+---------------------------------------------+
+ | ``id`` | yes | Delivery service regex id. |
+ +-----------+----------+---------------------------------------------+
+
+ **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": "Delivery service regex delete was successful."
+ }
+ ],
+ }
+
+|
+
+
+
+
diff --git a/docs/latest/_sources/api/v12/deliveryservice_stats.rst.txt b/docs/latest/_sources/api/v12/deliveryservice_stats.rst.txt
new file mode 100644
index 0000000..8d9dadb
--- /dev/null
+++ b/docs/latest/_sources/api/v12/deliveryservice_stats.rst.txt
@@ -0,0 +1,155 @@
+..
+..
+.. 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-v12-ds-stats:
+
+Delivery Service Statistics
+===========================
+
+.. _to-api-v12-ds-stats-route:
+
+/api/1.2/deliveryservice_stats
+++++++++++++++++++++++++++++++
+
+**GET /api/1.2/deliveryservice_stats.json**
+
+ Retrieves statistics on the delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+==============================================================================================================================================+
+ | ``deliveryServiceName`` | yes | The delivery service with the desired stats |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``metricType`` | yes | The metric type (valid metric types: 'kbps', 'out_bytes', 'status_4xx', 'status_5xx', tps_total', 'tps_2xx','tps_3xx', 'tps_4xx', 'tps_5xx') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``startDate`` | yes | The begin date (Formatted as ISO8601, for example: '2015-08-11T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``endDate`` | yes | The end date (Formatted as ISO8601, for example: '2015-08-12T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +============================+===============+=========================================================================================+
+ |``source`` | string | The source of the data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``summary`` | hash | Summary data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>totalBytes`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>min`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>max`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>fifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyEighthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyFifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>average`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>totalTransactions`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``series`` | hash | Series data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>columns`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>name`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>values`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>time`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>value`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "source": "TrafficStats",
+ "summary": {
+ "average": 1081172.785,
+ "count": 28,
+ "fifthPercentile": 888827.26,
+ "max": 1326680.31,
+ "min": 888827.26,
+ "ninetyEighthPercentile": 1324785.47,
+ "ninetyFifthPercentile": 1324785.47,
+ "totalBytes": 37841047.475,
+ "totalTransactions": 1020202030101
+ },
+ "series": {
+ "columns": [
+ "time",
+ ""
+ ],
+ "count": 60,
+ "name": "kbps",
+ "tags": {
+ "cachegroup": "total"
+ },
+ "values": [
+ [
+ "2015-08-11T11:36:00Z",
+ 888827.26
+ ],
+ [
+ "2015-08-11T11:37:00Z",
+ 980336.563333333
+ ],
+ [
+ "2015-08-11T11:38:00Z",
+ 952111.975
+ ],
+ [
+ "2015-08-11T11:39:00Z",
+ null
+ ],
+ [
+ "2015-08-11T11:43:00Z",
+ null
+ ],
+ [
+ "2015-08-11T11:44:00Z",
+ 934682.943333333
+ ],
+ [
+ "2015-08-11T11:45:00Z",
+ 1251121.28
+ ],
+ [
+ "2015-08-11T11:46:00Z",
+ 1111012.99
+ ]
+ ]
+ }
+ }
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/division.rst.txt b/docs/latest/_sources/api/v12/division.rst.txt
new file mode 100644
index 0000000..e0f1756
--- /dev/null
+++ b/docs/latest/_sources/api/v12/division.rst.txt
@@ -0,0 +1,203 @@
+..
+..
+.. 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-v12-division:
+
+Divisions
+=========
+
+.. _to-api-v12-division-route:
+
+/api/1.2/divisions
+++++++++++++++++++
+
+**GET /api/1.2/divisions**
+ Get all divisions.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "West",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/divisions/:id**
+ Get division by Id.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**PUT /api/1.2/divisions/:id**
+ Update a division
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Division id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+==========================+
+ | ``name`` | yes | The name of the division |
+ +-----------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "mydivision1"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Division update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "mydivision1"
+ }
+ }
+
+|
+
+
+**POST /api/1.2/divisions**
+ Create division
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +-----------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+==========================+
+ | ``name`` | yes | The name of the division |
+ +-----------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "mydivision1"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'name': 'mydivision1',
+ 'id': '4'
+ }
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/federation.rst.txt b/docs/latest/_sources/api/v12/federation.rst.txt
new file mode 100644
index 0000000..84ef4c8
--- /dev/null
+++ b/docs/latest/_sources/api/v12/federation.rst.txt
@@ -0,0 +1,434 @@
+..
+..
+.. 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-v12-federation:
+
+Federation
+==========
+
+.. _to-api-v12-federation-route:
+
+/api/1.2/federations
+++++++++++++++++++++
+
+**GET /api/1.2/federations.json**
+
+ Retrieves a list of federation mappings (aka federation resolvers) for a the current user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``cname`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``ttl`` | int | Time to live for the cname. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "mappings": [
+ "cname": "cname-01.",
+ "ttl": 8865,
+ ]
+ "deliveryService": "ds-01",
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/federations.json**
+
+ Allows a user to add federations for their delivery service(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Request Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve4`` | array | Array of IPv4 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve6`` | array | Array of IPv6 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "federations": [
+ {
+ "deliveryService": "ccp-omg-01",
+ "mappings": {
+ "resolve4": [
+ "255.255.255.255"
+ ],
+ "resolve6": [
+ "FE80::0202:B3FF:FE1E:8329",
+ ]
+ }
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/federations.json**
+
+ Deletes **all** federations associated with a user's delivery service(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+|
+
+
+**PUT /api/1.2/federations.json**
+
+ Deletes **all** federations associated with a user's delivery service(s) then adds the new federations.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Request Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve4`` | array | Array of IPv4 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve6`` | array | Array of IPv6 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "federations": [
+ {
+ "deliveryService": "ccp-omg-01",
+ "mappings": {
+ "resolve4": [
+ "255.255.255.255"
+ ],
+ "resolve6": [
+ "FE80::0202:B3FF:FE1E:8329",
+ ]
+ }
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/cdns/:name/federations**
+
+ Retrieves a list of federations for a cdn.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``cname`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``ttl`` | int | Time to live for the cname. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``deliveryService`` | hash | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``>>id`` | int | Delivery service ID |
+ +---------------------+--------+----------------------------------------------------+
+ | ``>>xmlId`` | string | Delivery service xml id |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 41
+ "cname": "booya.com.",
+ "ttl": 34,
+ "description": "fooya",
+ "deliveryService": {
+ "id": 61,
+ "xmlId": "the-xml-id"
+ }
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/cdns/:name/federations/:id**
+
+ Retrieves a federation for a cdn.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``cdn`` | string | CDN name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``cname`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``ttl`` | int | Time to live for the cname. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``deliveryService`` | hash | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``>>id`` | int | Delivery service ID |
+ +---------------------+--------+----------------------------------------------------+
+ | ``>>xmlId`` | string | Delivery service xml id |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 41
+ "cname": "booya.com.",
+ "ttl": 34,
+ "description": "fooya",
+ "deliveryService": {
+ "id": 61,
+ "xmlId": "the-xml-id"
+ }
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/cdns/:name/federations**
+ Create a federation
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``cdn`` | string | CDN name. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +======================+==========+==========================+
+ | ``cname`` | yes | CNAME ending with a dot |
+ +----------------------+----------+--------------------------+
+ | ``ttl`` | yes | TTL |
+ +----------------------+----------+--------------------------+
+ | ``description`` | no | Description |
+ +----------------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "cname": "the.cname.com.",
+ "ttl": 48,
+ "description": "the description"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``cname`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``ttl`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Federation created [ cname = the.cname. ] with id: 26."
+ }
+ ],
+ "response": {
+ "id": 26,
+ "cname": "the.cname.com.",
+ "ttl": 48,
+ "description": "the description",
+ }
+ }
+
+|
+
+**PUT /api/1.2/cdns/:name/federations/:id**
+ Update a federation
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``cdn`` | string | CDN name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +======================+==========+==========================+
+ | ``cname`` | yes | CNAME ending with a dot |
+ +----------------------+----------+--------------------------+
+ | ``ttl`` | yes | TTL |
+ +----------------------+----------+--------------------------+
+ | ``description`` | no | Description |
+ +----------------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "cname": "the.cname.com.",
+ "ttl": 48,
+ "description": "the description"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``cname`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``ttl`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Federation updated [ cname = the.cname. ] with id: 26."
+ }
+ ],
+ "response": {
+ "id": 26,
+ "cname": "the.cname.com.",
+ "ttl": 48,
+ "description": "the description",
+ }
+ }
+
+|
+
+**DELETE /api/1.2/cdns/:name/federations/{:id}**
+
+ Allow user to delete a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``cdn`` | string | CDN name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Federation deleted [ cname = the.cname. ] with id: 26."
+ }
+ ],
+ }
+
+|
+
+
+
+
diff --git a/docs/latest/_sources/api/v12/federation_deliveryservice.rst.txt b/docs/latest/_sources/api/v12/federation_deliveryservice.rst.txt
new file mode 100644
index 0000000..395e73f
--- /dev/null
+++ b/docs/latest/_sources/api/v12/federation_deliveryservice.rst.txt
@@ -0,0 +1,155 @@
+..
+..
+.. 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-v12-federation-deliveryservice:
+
+Federation Delivery Service
+===========================
+
+.. _to-api-v12-federation-deliveryservice-route:
+
+/api/1.2/federations/:id/deliveryservices
++++++++++++++++++++++++++++++++++++++++++
+
+**GET /api/1.2/federations/:id/deliveryservices**
+
+ Retrieves delivery services assigned to a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``id`` | int | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``cdn`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``type`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``xmlId`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 41
+ "cdn": "cdn1",
+ "type": "DNS",
+ "xmlId": "booya-12"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/federations/:id/deliveryservices**
+
+ Create one or more federation / delivery service assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``dsIds`` | yes | An array of delivery service IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing fed/ds assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "dsIds": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``dsIds`` | array | An array of delivery service IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | array | Existing fed/ds assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "5 delivery service(s) were assigned to the cname. federation"
+ }
+ ],
+ "response": {
+ "dsIds" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
+
+**DELETE /api/1.2/federations/:id/deliveryservices/:id**
+
+ Removes a delivery service from a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``federation`` | yes | Federation ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``ds`` | yes | Delivery Service ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Removed delivery service [ booya-12 ] from federation [ cname1. ]"
+ }
+ ],
+ }
+
+|
+
+
+
diff --git a/docs/latest/_sources/api/v12/federation_federationresolver.rst.txt b/docs/latest/_sources/api/v12/federation_federationresolver.rst.txt
new file mode 100644
index 0000000..86e6649
--- /dev/null
+++ b/docs/latest/_sources/api/v12/federation_federationresolver.rst.txt
@@ -0,0 +1,118 @@
+..
+..
+.. 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-v12-federation-federationresolver:
+
+Federation Federation Resolver
+==============================
+
+.. _to-api-v12-federation-federationresolver-route:
+
+/api/1.2/federations/:id/federation_resolvers
++++++++++++++++++++++++++++++++++++++++++++++
+
+**GET /api/1.2/federations/:id/federation_resolvers**
+
+ Retrieves federation resolvers assigned to a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``id`` | int | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``ipAddress`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``type`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 41
+ "ipAddress": "2.2.2.2/16",
+ "type": "RESOLVE4"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/federations/:id/federation_resolvers**
+
+ Create one or more federation / federation resolver assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``fedResolverIds`` | yes | An array of federation resolver IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing fed/ds assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "fedResolverIds": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``fedResolverIds`` | array | An array of federation resolver IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | array | Existing fed/fed resolver assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "5 resolvers(s) were assigned to the cname. federation"
+ }
+ ],
+ "response": {
+ "fedResolverIds" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/federation_resolver.rst.txt b/docs/latest/_sources/api/v12/federation_resolver.rst.txt
new file mode 100644
index 0000000..2f24f20
--- /dev/null
+++ b/docs/latest/_sources/api/v12/federation_resolver.rst.txt
@@ -0,0 +1,110 @@
+..
+..
+.. 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-v12-federation-resolver:
+
+Federation Resolver
+===================
+
+.. _to-api-v12-federation-resolver-route:
+
+/api/1.2/federation_resolvers
++++++++++++++++++++++++++++++
+
+**POST /api/1.2/federation_resolvers**
+
+ Create a federation resolver.
+
+ Authentication Required: Yes
+
+ Role(s) Required: ADMIN
+
+ **Request Properties**
+
+ +-------------------------+----------+------------------------------------------+
+ | Parameter | Required | Description |
+ +=========================+==========+==========================================+
+ | ``ipAddress`` | yes | IP or CIDR range |
+ +-------------------------+----------+------------------------------------------+
+ | ``typeId`` | yes | Type Id where useintable=federation |
+ +-------------------------+----------+------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "ipAddress": "2.2.2.2/32",
+ "typeId": 245
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | int | |
+ +----------------------+--------+------------------------------------------------+
+ |``ipAddress`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``type`` | int | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Federation resolver created [ IP = 2.2.2.2/32 ] with id: 27"
+ }
+ ],
+ "response": {
+ "id" : 27,
+ "ipAddress" : "2.2.2.2/32",
+ "typeId" : 245,
+ }
+ }
+
+|
+
+**DELETE /api/1.2/federation_resolvers/:id**
+
+ Deletes a federation resolver.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``resolver`` | yes | Federation resolver ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Federation resolver deleted [ IP = 2.2.2.2/32 ] with id: 27"
+ }
+ ],
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/federation_user.rst.txt b/docs/latest/_sources/api/v12/federation_user.rst.txt
new file mode 100644
index 0000000..55b4188
--- /dev/null
+++ b/docs/latest/_sources/api/v12/federation_user.rst.txt
@@ -0,0 +1,161 @@
+..
+..
+.. 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-v12-federation-user:
+
+Federation User
+===============
+
+.. _to-api-v12-federation-user-route:
+
+/api/1.2/federations/:id/users
+++++++++++++++++++++++++++++++
+
+**GET /api/1.2/federations/:id/users**
+
+ Retrieves users assigned to a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``federation`` | string | Federation ID. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``company`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``id`` | int | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``username`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``role`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``email`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``fullName`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 41
+ "username": "booya",
+ "company": "XYZ Corporation",
+ "role": "federation",
+ "email": "booya@fooya.com",
+ "fullName": "Booya Fooya"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/federations/:id/users**
+
+ Create one or more federation / user assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``userIds`` | yes | An array of user IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing fed/user assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "userIds": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``userIds`` | array | An array of user IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | array | Existing fed/user assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "5 user(s) were assigned to the cname. federation"
+ }
+ ],
+ "response": {
+ "userIds" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
+
+**DELETE /api/1.2/federations/:id/users/:id**
+
+ Removes a user from a federation.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``federation`` | yes | Federation ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``user`` | yes | User ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Removed user [ bobmack ] from federation [ cname1. ]"
+ }
+ ],
+ }
+
+|
+
+
+
diff --git a/docs/latest/_sources/api/v12/hwinfo.rst.txt b/docs/latest/_sources/api/v12/hwinfo.rst.txt
new file mode 100644
index 0000000..2da59c5
--- /dev/null
+++ b/docs/latest/_sources/api/v12/hwinfo.rst.txt
@@ -0,0 +1,68 @@
+..
+..
+.. 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-v12-hwinfo:
+
+Hardware Info
+=============
+
+.. _to-api-v12-hwinfo-route:
+
+/api/1.2/hwinfo
++++++++++++++++
+
+**GET /api/1.2/hwinfo.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------+--------+----------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+======================================================================+
+ | ``serverId`` | string | Local unique identifier for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``serverHostName`` | string | Hostname for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``val`` | string | Freeform value used to track anything about a server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``description`` | string | Freeform description for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:0"
+ },
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:1"
+ }
+ ]
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/index.rst.txt b/docs/latest/_sources/api/v12/index.rst.txt
new file mode 100644
index 0000000..b60943d
--- /dev/null
+++ b/docs/latest/_sources/api/v12/index.rst.txt
@@ -0,0 +1,63 @@
+..
+..
+.. 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.
+..
+
+
+API 1.2 Reference
+*****************
+Traffic Ops API V1.2
+
+.. toctree::
+ :maxdepth: 1
+
+ api_capability
+ asn
+ cache
+ cachegroup
+ cachegroup_parameter
+ cachegroup_fallbacks
+ cache_stats
+ capability
+ cdn
+ changelog
+ configfiles_ats
+ deliveryservice
+ deliveryservice_regex
+ deliveryservice_stats
+ division
+ federation
+ federation_deliveryservice
+ federation_federationresolver
+ federation_resolver
+ federation_user
+ hwinfo
+ iso
+ job
+ parameter
+ phys_location
+ profile
+ profile_parameter
+ influxdb
+ region
+ role
+ server
+ static_dns
+ status
+ steering_target
+ system
+ tenant
+ to_extension
+ type
+ user
+ topology
diff --git a/docs/latest/_sources/api/v12/influxdb.rst.txt b/docs/latest/_sources/api/v12/influxdb.rst.txt
new file mode 100644
index 0000000..ca82cf5
--- /dev/null
+++ b/docs/latest/_sources/api/v12/influxdb.rst.txt
@@ -0,0 +1,65 @@
+..
+..
+.. 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-v12-influxdb:
+
+InfluxDB
+==========
+
+.. Note:: The documentation needs a thorough review!
+
+**GET /api/1.2/traffic_monitor/stats.json**
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+**Response Properties**
+
++----------------------+--------+------------------------------------------------+
+| Parameter | Type | Description |
++======================+========+================================================+
+| ``aaData`` | array | |
++----------------------+--------+------------------------------------------------+
+
+**Response Example**
+::
+
+ {
+ "aaData": [
+ [
+ "0",
+ "ALL",
+ "ALL",
+ "ALL",
+ "true",
+ "ALL",
+ "142035",
+ "172365661.85"
+ ],
+ [
+ 1,
+ "EDGE1_TOP_421_PSPP",
+ "odol-atsec-atl-03",
+ "us-ga-atlanta",
+ "1",
+ "REPORTED",
+ "596",
+ "923510.04",
+ "69.241.82.126"
+ ]
+ ],
+ }
+
\ No newline at end of file
diff --git a/docs/latest/_sources/api/v12/iso.rst.txt b/docs/latest/_sources/api/v12/iso.rst.txt
new file mode 100644
index 0000000..feb534b
--- /dev/null
+++ b/docs/latest/_sources/api/v12/iso.rst.txt
@@ -0,0 +1,132 @@
+..
+..
+.. 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-v12-iso:
+
+ISO
+===
+
+.. _to-api-v12-iso-route:
+
+**GET /api/1.2/osversions**
+
+ Get all OS versions for ISO generation and the directory where the kickstarter files are found. The values are retrieved from osversions.cfg found in either /var/www/files or in the location defined by the kickstart.files.location parameter (if defined).
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------------------------------------------------------------------------+
+ | Parameter | Description |
+ +======================+==========================================================================+
+ |``OS version name`` | OS version name. For example, "CentOS 7.2 vda". |
+ +----------------------+--------------------------------------------------------------------------+
+ |``OS version dir`` | The directory where the kickstarter ISO files are found. For example, |
+ | | centos72-netinstall. |
+ +----------------------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":
+ {
+ "CentOS 7.2": "centos72-netinstall"
+ "CentOS 7.2 vda": "centos72-netinstall-vda"
+ }
+ }
+
+|
+
+**POST /api/1.2/isos**
+
+ Generate an ISO.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations
+
+ **Request Properties**
+
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | Parameter | Required | Description |
+ +===============================+==========+=================================================================================================+
+ | ``osversionDir`` | yes | The directory name where the kickstarter ISO files are found. |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``hostName`` | yes | |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``domainName`` | yes | |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``rootPass`` | yes | |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``dhcp`` | yes | Valid values are 'yes' or 'no'. If yes, other IP settings will be ignored. |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | yes | 1500 or 9000 |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | yes|no | Required if dhcp=no |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | yes|no | Required if dhcp=no |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | yes|no | Required if dhcp=no |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | no | /64 is assumed if prefix is omitted. |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | no | Ignored if an IPV4 gateway is specified. |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | no | Typical values are bond0, eth4, etc. If you enter bond0, a LACP bonding config will be written. |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+ | ``disk`` | no | Typical values are "sda" |
+ +-------------------------------+----------+-------------------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "osversionDir": "centos72-netinstall-vda",
+ "hostName": "foo-bar",
+ "domainName": "baz.com",
+ "rootPass": "password",
+ "dhcp": "no",
+ "interfaceMtu": 1500,
+ "ipAddress": "10.10.10.10",
+ "ipNetmask": "255.255.255.252",
+ "ipGateway": "10.10.10.10"
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------+--------+-------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+===============================================================================+
+ |``isoURL`` | string | The URL location of the ISO. ISO locations can be found in cnd.conf file. |
+ +-----------------+--------+-------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "isoURL": "https://traffic_ops.domain.net/iso/fqdn-centos72-netinstall.iso"
+ },
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Generate ISO was successful."
+ }
+ ]
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/job.rst.txt b/docs/latest/_sources/api/v12/job.rst.txt
new file mode 100644
index 0000000..be27309
--- /dev/null
+++ b/docs/latest/_sources/api/v12/job.rst.txt
@@ -0,0 +1,136 @@
+..
+..
+.. 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-v12-job:
+
+Jobs
+====
+
+.. _to-api-v12-job-route:
+
+/api/1.2/jobs
+++++++++++++++++++
+
+**GET /api/1.2/jobs**
+
+ Get all jobs (currently limited to invalidate content (PURGE) jobs) sorted by start time (descending).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations or Admin
+
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``dsId`` | no | Filter jobs by Delivery Service ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``userId`` | no | Filter jobs by User ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | int | Job id |
+ +----------------------+--------+-------------------------------------------------+
+ |``assetUrl`` | string | URL of the asset to invalidate. |
+ +----------------------+--------+-------------------------------------------------+
+ |``deliveryService`` | string | Unique identifier of the job's DS. |
+ +----------------------+--------+-------------------------------------------------+
+ |``keyword`` | string | Job keyword (PURGE) |
+ +----------------------+--------+-------------------------------------------------+
+ |``parameters`` | string | Parameters associated with the job. |
+ +----------------------+--------+-------------------------------------------------+
+ |``startTime`` | string | Start time of the job. |
+ +----------------------+--------+-------------------------------------------------+
+ |``createdBy`` | string | Username that initiated the job. |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 1
+ "assetUrl": "http:\/\/foo-bar.domain.net\/taco.html",
+ "deliveryService": "foo-bar",
+ "keyword": "PURGE",
+ "parameters": "TTL:48h",
+ "startTime": "2015-05-14 08:56:36-06",
+ "createdBy": "jdog24"
+ },
+ {
+ "id": 2
+ "assetUrl": "http:\/\/foo-bar.domain.net\/bell.html",
+ "deliveryService": "foo-bar",
+ "keyword": "PURGE",
+ "parameters": "TTL:72h",
+ "startTime": "2015-05-16 08:56:36-06",
+ "createdBy": "jdog24"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/jobs/:id**
+
+ Get a job by ID (currently limited to invalidate content (PURGE) jobs).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Operations or Admin
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | int | Job id |
+ +----------------------+--------+-------------------------------------------------+
+ |``assetUrl`` | string | URL of the asset to invalidate. |
+ +----------------------+--------+-------------------------------------------------+
+ |``deliveryService`` | string | Unique identifier of the job's DS. |
+ +----------------------+--------+-------------------------------------------------+
+ |``keyword`` | string | Job keyword (PURGE) |
+ +----------------------+--------+-------------------------------------------------+
+ |``parameters`` | string | Parameters associated with the job. |
+ +----------------------+--------+-------------------------------------------------+
+ |``startTime`` | string | Start time of the job. |
+ +----------------------+--------+-------------------------------------------------+
+ |``createdBy`` | string | Username that initiated the job. |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 1
+ "assetUrl": "http:\/\/foo-bar.domain.net\/taco.html",
+ "deliveryService": "foo-bar",
+ "keyword": "PURGE",
+ "parameters": "TTL:48h",
+ "startTime": "2015-05-14 08:56:36-06",
+ "createdBy": "jdog24"
+ }
+ ]
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/parameter.rst.txt b/docs/latest/_sources/api/v12/parameter.rst.txt
new file mode 100644
index 0000000..9c0f65b
--- /dev/null
+++ b/docs/latest/_sources/api/v12/parameter.rst.txt
@@ -0,0 +1,691 @@
+..
+..
+.. 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-v12-parameter:
+
+Parameter
+=========
+
+.. _to-api-v12-parameters-route:
+
+/api/1.2/parameters
++++++++++++++++++++
+
+**GET /api/1.2/parameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | no | Filter parameters by name. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``configFile`` | no | Filter parameters by config file. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``configFile`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``profiles`` | array | An array of profiles attached to this parameter. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "configFile": "FooConfig.xml",
+ "profiles": [ "EDGE-FOO, MID-FOO" ]
+ },
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "configFile": "storage.config",
+ "profiles": [ "EDGE-FOO, MID-FOO" ]
+
+ },
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "configFile": "records.config"
+ "profiles": [ ]
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/parameters/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: if secure of the parameter fetched is 1, require admin role, or any valid role can access.
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "id": "27",
+ "config_file": "FooConfig.xml",
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/parameters/:id/profiles**
+
+ Retrieves all profiles assigned to the parameter.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +---------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+====================================================+
+ | ``id`` | yes | Parameter ID. |
+ +---------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``type`` | string | The type for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net",
+ "type": "ATS_PROFILE"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/parameters/:id/unassigned_profiles**
+
+ Retrieves all profiles NOT assigned to the parameter.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +---------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+====================================================+
+ | ``id`` | yes | Parameter ID. |
+ +---------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/profiles/:id/parameters**
+
+ Retrieves all parameters assigned to the profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==================+==========+=======================+
+ | ``id`` | yes | Profile id |
+ +------------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/profiles/:id/unassigned_parameters**
+
+ Retrieves all parameters NOT assigned to the profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==================+==========+=======================+
+ | ``id`` | yes | Profile id |
+ +------------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/profiles/name/:name/parameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==================+==========+=======================+
+ | ``name`` | yes | Profile name |
+ +------------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/parameters**
+ Create parameters.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+ The request route parameters accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ parameters array format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+=========+======================================================================================+
+ | | array | parameters array |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>id`` | integer | The parameter id |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | string | parameter name |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | string | parameter config_file |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | string | parameter value |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+
+
+ **Request Example**
+
+ 1. single parameter format example: ::
+
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0
+ }
+
+ 2. array format example: ::
+
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1
+ }
+ ]
+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "value":"value1",
+ "secure":0,
+ "name":"param1",
+ "id":"1139",
+ "configFile":"configFile1"
+ },
+ {
+ "value":"value2",
+ "secure":1,
+ "name":"param2",
+ "id":"1140",
+ "configFile":"configFile2"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/parameters/{:id}**
+ Edit parameter.
+
+ Authentication Required: Yes
+
+ Role(s) Required: if the parameter's secure equals 1, only admin role can edit the parameter, or admin or oper role can access the API.
+
+ **Request Parameters**
+
+ +-----------+---------+------------------+
+ | Parameter | Type | Description |
+ +===========+=========+==================+
+ | ``id`` | integer | The parameter id |
+ +-----------+---------+------------------+
+
+ **Request Route Parameters**
+
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+=========+======================================================================================+
+ | ``name`` | no | string | parameter name |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | no | string | parameter config_file |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | no | string | parameter value |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | no | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter id |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":"0",
+ }
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "value":"value1",
+ "secure":"0",
+ "name":"param1",
+ "id":"1134",
+ "configFile":"configFile1"
+ }
+ }
+
+|
+
+**DELETE /api/1.2/parameters/{:id}**
+ delete parameter. If the parameter have profile associated, can not be deleted.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper role
+
+ **Request Parameters**
+
+ +-----------+---------+------------------+
+ | Parameter | Type | Description |
+ +===========+=========+==================+
+ | ``id`` | integer | The parameter id |
+ +-----------+---------+------------------+
+
+ **No Request Route Parameters**
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Parameter was successfully deleted."
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/parameters/validate**
+ Validate if the parameter exists.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+--------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+================================+
+ | ``name`` | yes | string | parameter name |
+ +----------------+----------+--------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +----------------+----------+--------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +----------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter id |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1"
+ }
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "value":"value1",
+ "secure":"0",
+ "name":"param1",
+ "id":"1134",
+ "configFile":"configFile1"
+ }
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v12/phys_location.rst.txt b/docs/latest/_sources/api/v12/phys_location.rst.txt
new file mode 100644
index 0000000..67359e5
--- /dev/null
+++ b/docs/latest/_sources/api/v12/phys_location.rst.txt
@@ -0,0 +1,456 @@
+..
+..
+.. 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-v12-phys-loc:
+
+Physical Location
+=================
+
+.. _to-api-v12-phys-loc-route:
+
+/api/1.2/phys_locations
++++++++++++++++++++++++
+
+**GET /api/1.2/phys_locations**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+=============================================+
+ | ``region`` | no | Filter by Region ID. |
+ +--------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ },
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/phys_locations/trimmed.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+=========+================================================+
+ |``name`` | string | |
+ +----------------------+---------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "Albuquerque"
+ },
+ {
+ "name": "Ashburn"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/phys_locations/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Physical location ID. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/phys_locations/:id**
+ Update a physical location
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Physical location id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+================================================+
+ | ``address`` | yes | Physical location address. |
+ +-------------------+----------+------------------------------------------------+
+ | ``city`` | yes | Physical location city. |
+ +-------------------+----------+------------------------------------------------+
+ | ``comments`` | no | Physical location comments. |
+ +-------------------+----------+------------------------------------------------+
+ | ``email`` | no | Physical location email. |
+ +-------------------+----------+------------------------------------------------+
+ | ``name`` | yes | Physical location name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``phone`` | no | Physical location phone. |
+ +-------------------+----------+------------------------------------------------+
+ | ``poc`` | no | Physical location point of contact. |
+ +-------------------+----------+------------------------------------------------+
+ | ``regionId`` | no | Physical location region ID. |
+ +-------------------+----------+------------------------------------------------+
+ | ``shortName`` | yes | Physical location short name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``state`` | yes | Physical location state. |
+ +-------------------+----------+------------------------------------------------+
+ | ``zip`` | yes | Physical location zip. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "regionId": "1",
+ "poc": "Jane Doesssss",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "address": "123 East 9rd St",
+ "shortName": "Albuquerque"
+ }
+
+|
+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Physical location update was successful."
+ }
+ ],
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.2/regions/:region_name/phys_locations**
+ Create physical location.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ region_name: the name of the region to create physical location into.
+
+ **Request Route Parameters**
+
+ +-----------------+----------+-----------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================+
+ | ``region_name`` | yes | The name of the physical location |
+ +-----------------+----------+-----------------------------------+
+
+ **Request Properties**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | yes | The name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``shortName`` | yes | The short name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``address`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``city`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``state`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``zip`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``phone`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``poc`` | no | Point of contact |
+ +-----------------+----------+---------------------------------------------------+
+ | ``email`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``comments`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name" : "my physical location1",
+ "shortName" : "myphylocation1",
+ "address" : "",
+ "city" : "Shanghai",
+ "state": "SH",
+ "zip": "200000",
+ "comments": "this is physical location1"
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+===================================================+
+ | ``id`` | string | The id of the physical location created. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``name`` | string | The name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``shortName`` | string | The short name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionName`` | string | The region name the physical location belongs to. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionId`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``address`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``city`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``state`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``zip`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``phone`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``poc`` | string | Point of contact |
+ +-----------------+--------+---------------------------------------------------+
+ | ``email`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``comments`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/profile.rst.txt b/docs/latest/_sources/api/v12/profile.rst.txt
new file mode 100644
index 0000000..73d8043
--- /dev/null
+++ b/docs/latest/_sources/api/v12/profile.rst.txt
@@ -0,0 +1,415 @@
+..
+..
+.. 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-v12-profile:
+
+
+Profiles
+========
+
+.. _to-api-v12-profiles-route:
+
+/api/1.2/profiles
++++++++++++++++++
+
+**GET /api/1.2/profiles**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +---------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+====================================================+
+ | ``param`` | no | Used to filter profiles by parameter ID. |
+ +---------------+----------+----------------------------------------------------+
+ | ``cdn`` | no | Used to filter profiles by CDN ID. |
+ +---------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+======================================================+
+ | ``id`` | string | Primary key |
+ +---------------------+--------+------------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +---------------------+--------+------------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +---------------------+--------+------------------------------------------------------+
+ | ``cdn`` | int | The CDN ID |
+ +---------------------+--------+------------------------------------------------------+
+ | ``cdnName`` | string | The CDN name |
+ +---------------------+--------+------------------------------------------------------+
+ | ``type`` | string | Profile type |
+ +---------------------+--------+------------------------------------------------------+
+ | ``routingDisabled`` | bool | Traffic router routing disabled - defaults to false. |
+ +---------------------+--------+------------------------------------------------------+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +---------------------+--------+------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "8",
+ "name": "EDGE_27_PROFILE",
+ "description": "A profile with all the Foo parameters"
+ "cdn": 1
+ "cdnName": "cdn1"
+ "type": "ATS_PROFILE"
+ "routingDisabled": false
+ "lastUpdated": "2012-10-08 19:34:45",
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/profiles/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "EDGE_27_PROFILE"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/profiles/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+------------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+============+================================================+
+ | ``id`` | yes | The ID of the profile. |
+ +-----------------+------------+------------------------------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``id`` | string | Primary key |
+ +---------------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +---------------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +---------------------+--------+----------------------------------------------------+
+ | ``cdn`` | int | The CDN ID |
+ +---------------------+--------+----------------------------------------------------+
+ | ``cdnName`` | string | The CDN name |
+ +---------------------+--------+----------------------------------------------------+
+ | ``type`` | string | Profile type |
+ +---------------------+--------+----------------------------------------------------+
+ | ``routingDisabled`` | bool | Traffic router routing disabled |
+ +---------------------+--------+----------------------------------------------------+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "8",
+ "name": "EDGE_27_PROFILE",
+ "description": "A profile with all the Foo parameters"
+ "cdn": 1
+ "cdnName": "cdn1"
+ "type": "ATS_PROFILE"
+ "routingDisabled": true
+ "lastUpdated": "2012-10-08 19:34:45",
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.2/profiles**
+ Create a new empty profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +-----------------------+--------+----------+-----------------------------------------+
+ | Parameter | Type | Required | Description |
+ +=======================+========+==========+=========================================+
+ | ``name`` | string | yes | Profile name |
+ +-----------------------+--------+----------+-----------------------------------------+
+ | ``description`` | string | yes | Profile description |
+ +-----------------------+--------+----------+-----------------------------------------+
+ | ``cdn`` | int | no | CDN ID |
+ +-----------------------+--------+----------+-----------------------------------------+
+ | ``type`` | string | yes | Profile type |
+ +-----------------------+--------+----------+-----------------------------------------+
+ | ``routingDisabled`` | bool | no | Traffic router routing disabled. |
+ | | | | Defaults to false. |
+ +-----------------------+--------+----------+-----------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "name": "EDGE_28_PROFILE",
+ "description": "EDGE_28_PROFILE description",
+ "cdn": 1,
+ "type": "ATS_PROFILE",
+ "routingDisabled": false
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+====================================================+
+ | ``id`` | string | Profile ID |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``name`` | string | Profile name |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``description`` | string | Profile description |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``cdn`` | int | CDN ID |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``type`` | string | Profile type |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``routingDisabled`` | bool | Traffic router routing disabled |
+ +-----------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "66",
+ "name": "EDGE_28_PROFILE",
+ "description": "EDGE_28_PROFILE description",
+ "cdn": 1,
+ "type": "ATS_PROFILE",
+ "routingDisabled": false
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/name/:profile_name/copy/:profile_copy_from**
+ Copy profile to a new profile. The new profile name must not exist.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------------+----------+-------------------------------+
+ | Name | Required | Description |
+ +=======================+==========+===============================+
+ | ``profile_name`` | yes | The name of profile to copy |
+ +-----------------------+----------+-------------------------------+
+ | ``profile_copy_from`` | yes | The name of profile copy from |
+ +-----------------------+----------+-------------------------------+
+
+
+ **Response Properties**
+
+ +-----------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+====================================================+
+ | ``id`` | string | Id of the new profile |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name of the new profile |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``profileCopyFrom`` | string | The name of profile to copy |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``idCopyFrom`` | string | The id of profile to copy |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``description`` | string | new profile's description (copied) |
+ +-----------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "66",
+ "name": "CCR_COPY",
+ "profileCopyFrom": "CCR1",
+ "description": "CCR_COPY description",
+ "idCopyFrom": "3"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/profiles/{:id}**
+
+ Allows user to edit a profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | profile id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------------------+--------+----------+--------------------------------------------+
+ | Parameter | Type | Required | Description |
+ +=======================+========+==========+============================================+
+ | ``name`` | string | yes | Profile name |
+ +-----------------------+--------+----------+--------------------------------------------+
+ | ``description`` | string | yes | Profile description |
+ +-----------------------+--------+----------+--------------------------------------------+
+ | ``cdn`` | int | no | CDN ID - must use the same ID as any |
+ | | | | servers assigned to the profile. |
+ +-----------------------+--------+----------+--------------------------------------------+
+ | ``type`` | string | yes | Profile type |
+ +-----------------------+--------+----------+--------------------------------------------+
+ | ``routingDisabled`` | bool | no | Traffic router routing disabled. |
+ | | | | When not present, value defaults to false. |
+ +-----------------------+--------+----------+--------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "EDGE_28_PROFILE",
+ "description": "EDGE_28_PROFILE description",
+ "cdn": 1,
+ "type": "ATS_PROFILE",
+ "routingDisabled": false
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+====================================================+
+ | ``id`` | string | Profile ID |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``name`` | string | Profile name |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``description`` | string | Profile description |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``cdn`` | int | CDN ID |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``type`` | string | Profile type |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``routingDisabled`` | bool | Traffic router routing disabled |
+ +-----------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": "219",
+ "name": "EDGE_28_PROFILE",
+ "description": "EDGE_28_PROFILE description"
+ "cdn": 1
+ "type": "ATS_PROFILE",
+ "routingDisabled": false
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile was updated: 219"
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/profiles/{:id}**
+
+ Allows user to delete a profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+----------------------------+
+ | Name | Required | Description |
+ +=================+==========+============================+
+ | ``id`` | yes | profile id. |
+ +-----------------+----------+----------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Profile was deleted."
+ }
+ ]
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v12/profile_parameter.rst.txt b/docs/latest/_sources/api/v12/profile_parameter.rst.txt
new file mode 100644
index 0000000..e8534d9
--- /dev/null
+++ b/docs/latest/_sources/api/v12/profile_parameter.rst.txt
@@ -0,0 +1,573 @@
+..
+..
+.. 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-v12-profileparameters:
+
+
+Profile parameters
+==================
+
+.. _to-api-v12-profileparameters-route:
+
+/api/1.2/profileparameters
+++++++++++++++++++++++++++
+
+**POST /api/1.2/profileparameters**
+
+ Associate parameter to profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+ This accept two formats: single profile-parameter, profile-parameter array.
+
+ Single profile-parameter format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | ``profileId`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ Profile-parameter array format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | | yes | profile-parameter array. |
+ +------------------+----------+----------------------------------------------------+
+ | ``>profileId`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``>parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ Single profile-parameter format:
+
+ {
+ "profileId": 2,
+ "parameterId": 6
+ }
+
+ Profile-parameter array format:
+
+ [
+ {
+ "profileId": 2,
+ "parameterId": 6
+ },
+ {
+ "profileId": 2,
+ "parameterId": 7
+ },
+ {
+ "profileId": 3,
+ "parameterId": 6
+ }
+ ]
+
+ **Response Properties**
+
+ +-------------------+---------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+=========+=====================================================+
+ | ``response`` | array | Profile-parameter associations. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>profileId`` | string | Profile id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>parameterId`` | string | Parameter id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+---------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":[
+ {
+ "profileId": "2",
+ "parameterId": "6"
+ },
+ {
+ "profileId": "2",
+ "parameterId": "7"
+ },
+ {
+ "profileId": "3",
+ "parameterId": "6"
+ }
+ ]
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile parameter associations were created."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/profileparameters/{:profile_id}/{:parameter_id}**
+
+ Delete a profile parameter association.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+====================================================+
+ | ``profile_id`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameter_id`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=====================================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+--------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile parameter association was deleted."
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/name/{:name}/parameters**
+
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+ If the profile does not exist, the API returns fail.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+
+ **Request Route Parameters**
+
+ +------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+====================================================+
+ | ``name`` | yes | profile name. |
+ +------------+----------+----------------------------------------------------+
+
+ **Request Properties**
+ The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ array parameters format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+
+ **Response Properties** ::
+
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | Name | Type | Description |
+ +==================+=========+======================================================================================+
+ | ``response`` | | Parameters associated with the profile. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileName`` | string | profile name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileId`` | integer | profile index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>parameters`` | array | parameters array |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>id`` | integer | parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>name`` | string | parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>configFile`` | string | parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>value`` | string | parameter value |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``version`` | string | |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/id/{:id}/parameters**
+
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+ If the profile does not exist, the API returns fail.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+
+ **Request Route Parameters**
+
+ +------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+====================================================+
+ | ``id`` | yes | profile name. |
+ +------------+----------+----------------------------------------------------+
+
+ **Request Properties**
+ The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ array parameters format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+
+ **Response Properties** ::
+
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | Name | Type | Description |
+ +==================+=========+======================================================================================+
+ | ``response`` | | Parameters associated with the profile. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileName`` | string | profile name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileId`` | integer | profile index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>parameters`` | array | parameters array |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>id`` | integer | parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>name`` | string | parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>configFile`` | string | parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>value`` | string | parameter value |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``version`` | string | |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profileparameter**
+
+ Create one or more profile / parameter assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``profileId`` | yes | The ID of the profile. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``paramIds`` | yes | An array of parameter IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing profile/param assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "profileId": 22,
+ "paramIds": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``profileId`` | int | The ID of the profile. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``paramIds`` | array | An array of parameter IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | bool | Existing profile/param assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "14 parameters where assigned to the foo profile."
+ }
+ ],
+ "response": {
+ "profileId" : 22,
+ "paramIds" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
+
+**POST /api/1.2/parameterprofile**
+
+ Create one or more parameter / profile assignments.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``paramId`` | yes | The ID of the parameter. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``profileIds`` | yes | An array of profile IDs. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``replace`` | no | Replace existing param/profile assignments? (true|false) |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "paramId": 22,
+ "profileIds": [ 2, 3, 4, 5, 6 ],
+ "replace": true
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``paramId`` | int | The ID of the parameter. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``profileIds`` | array | An array of profile IDs. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``replace`` | bool | Existing param/profile assignments replaced? (true|false). |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "14 profiles where assigned to the bar parameter."
+ }
+ ],
+ "response": {
+ "paramId" : 22,
+ "profileIds" : [ 2, 3, 4, 5, 6 ],
+ "replace" : true
+ }
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v12/region.rst.txt b/docs/latest/_sources/api/v12/region.rst.txt
new file mode 100644
index 0000000..74e6fbf
--- /dev/null
+++ b/docs/latest/_sources/api/v12/region.rst.txt
@@ -0,0 +1,244 @@
+..
+..
+.. 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-v12-region:
+
+Regions
+=======
+
+.. _to-api-v12-regions-route:
+
+/api/1.2/regions
+++++++++++++++++
+
+**GET /api/1.1/regions**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +---------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+=============================================+
+ | ``division`` | no | Filter regions by Division ID. |
+ +---------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
+ },
+ {
+ "id": "7",
+ "name": "Denver",
+ "division": "2",
+ "divisionName": "West"
+ },
+ ]
+ }
+
+
+**GET /api/1.1/regions/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Region id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
+ }
+ ]
+ }
+
+
+**PUT /api/1.2/regions/:id**
+ Update a region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Region id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +================+==========+==========================+
+ | ``name`` | yes | The name of the region |
+ +----------------+----------+--------------------------+
+ | ``division`` | yes | The division Id |
+ +----------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ "division": "4"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``division`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Region update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "myregion1",
+ "division": "4",
+ "divisionName": "mydivision1"
+ }
+ }
+
+|
+
+**POST /api/1.2/divisions/:division_name/regions**
+ Create Region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ division_name - The name of division to create new region into.
+
+ ** Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +===================+==========+================================================+
+ | ``division_name`` | yes | The name of division will create new region in |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+==========================================+
+ | ``name`` | yes | The name of the region |
+ +-------------------+----------+------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+===========================================+
+ | ``name`` | string | name of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``id`` | string | id of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionName`` | string | the division name the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionId`` | string | the id of division the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'divisionName': 'mydivision1',
+ 'divsionId': '4',
+ 'name': 'myregion1',
+ 'id': '19'
+ }
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/role.rst.txt b/docs/latest/_sources/api/v12/role.rst.txt
new file mode 100644
index 0000000..b993c97
--- /dev/null
+++ b/docs/latest/_sources/api/v12/role.rst.txt
@@ -0,0 +1,59 @@
+..
+..
+.. 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-v12-roles:
+
+Roles
+=====
+
+.. _to-api-v12-roles-route:
+
+/api/1.2/roles
+++++++++++++++
+
+**GET /api/1.2/roles.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``privLevel`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "read-only",
+ "id": "2",
+ "privLevel": "10",
+ "description": "read-only user"
+ }
+ ]
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/server.rst.txt b/docs/latest/_sources/api/v12/server.rst.txt
new file mode 100644
index 0000000..accc234
--- /dev/null
+++ b/docs/latest/_sources/api/v12/server.rst.txt
@@ -0,0 +1,1496 @@
+..
+..
+.. 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-v12-server:
+
+Server
+======
+
+.. _to-api-v12-servers-route:
+
+/api/1.2/servers
+++++++++++++++++
+
+**GET /api/1.2/servers**
+
+ Retrieves properties of CDN servers.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+=============================================+
+ | ``dsId`` | no | Used to filter servers by delivery service. |
+ +--------------------+----------+---------------------------------------------+
+ | ``status`` | no | Used to filter servers by status. |
+ +--------------------+----------+---------------------------------------------+
+ | ``type`` | no | Used to filter servers by type. |
+ +--------------------+----------+---------------------------------------------+
+ | ``profileId`` | no | Used to filter servers by profile ID. |
+ +--------------------+----------+---------------------------------------------+
+ | ``cdn`` | no | Used to filter servers by CDN ID. |
+ +--------------------+----------+---------------------------------------------+
+ | ``cachegroup`` | no | Used to filter servers by cache group ID. |
+ +--------------------+----------+---------------------------------------------+
+ | ``physLocation`` | no | Used to filter servers by phys location ID. |
+ +--------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/servers/:id**
+
+ Retrieves properties of a CDN server by server ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Server id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/servers/:id/deliveryservices**
+
+ Retrieves all delivery services assigned to the server. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | Server ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | List of header keys separated by ``__RETURN__``. Listed headers will be included in TR access log entries under the "rh=" token. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | List of header ``name:value`` pairs separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP responses. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "deepCachingType": "NEVER",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://foo.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "foo",
+ "signed": false,
+ "sslKeyVersion": "0",
+ "tenant": "root",
+ "tenantId": 1,
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/servers/totals**
+
+ Retrieves a count of CDN servers by type.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------+--------+------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===========+========+========================================================================+
+ | ``count`` | int | The number of servers of this type in this instance of Traffic Ops. |
+ +-----------+--------+------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of the server count (see :ref:`to-api-v12-type`). |
+ +-----------+--------+------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "count": 4,
+ "type": "CCR"
+ },
+ {
+ "count": 55,
+ "type": "EDGE"
+ },
+ {
+ "type": "MID",
+ "count": 18
+ },
+ {
+ "count": 0,
+ "type": "INFLUXDB"
+ },
+ {
+ "count": 4,
+ "type": "RASCAL"
+ }
+ }
+
+|
+
+**GET /api/1.2/servers/status**
+
+ Retrieves a count of CDN servers by status.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+=======================================================================================================================+
+ | ``ONLINE`` | int | The number of ONLINE servers. Traffic Monitor will not monitor the state of ONLINE servers. True health is unknown. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------+
+ | ``REPORTED`` | int | The number of REPORTED servers. Traffic Monitor monitors the state of REPORTED servers and removes them if unhealthy. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------+
+ | ``OFFLINE`` | int | The number of OFFLINE servers. Used for longer-term maintenance. These servers are excluded from CRConfig.json. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------+
+ | ``ADMIN_DOWN`` | int | The number of ADMIN_DOWN servers. Used for short-term maintenance. These servers are included in CRConfig.json. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------+
+ | ``CCR_IGNORE`` | int | The number of CCR_IGNORE servers. These servers are excluded from CRConfig.json. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------+
+ | ``PRE_PROD`` | int | The number of PRE_PROD servers. Used for servers to be deployed. These servers are excluded from CRConfig.json. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":
+ {
+ "ONLINE": 100,
+ "OFFLINE": 23,
+ "REPORTED": 45,
+ "ADMIN_DOWN": 4,
+ "CCR_IGNORE": 1,
+ "PRE_PROD": 0,
+ }
+ }
+
+|
+
+
+**GET /api/1.2/servers/hostname/:name/details**
+
+ Retrieves the details of a server.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+----------------------------------+
+ | Name | Required | Description |
+ +==========+==========+==================================+
+ | ``name`` | yes | The host name part of the cache. |
+ +----------+----------+----------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v12-cachegroup`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``deliveryservices`` | array | Array of strings with the delivery service ids assigned (see :ref:`to-api-v12-ds`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``hardwareInfo`` | hash | Hwinfo struct (see :ref:`to-api-v12-hwinfo`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time/Date of the last update for this server. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v12-phys-loc`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v12-profile`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v12-status`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The default HTTPS port on which the main application listens (443 for a cache in most cases). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v12-type`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``xmppId`` | string | Deprecated. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``xmppPasswd`` | string | Deprecated. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroup": "us-il-chicago",
+ "deliveryservices": [
+ "1",
+ "2",
+ "3",
+ "4"
+ ],
+ "domainName": "chi.kabletown.net",
+ "hardwareInfo": {
+ "Physical Disk 0:1:3": "D1S2",
+ "Physical Disk 0:1:2": "D1S2",
+ "Physical Disk 0:1:15": "D1S2",
+ "Power Supply.Slot.2": "04.07.15",
+ "Physical Disk 0:1:24": "YS08",
+ "Physical Disk 0:1:1": "D1S2",
+ "Model": "PowerEdge R720xd",
+ "Physical Disk 0:1:22": "D1S2",
+ "Physical Disk 0:1:18": "D1S2",
+ "Enterprise UEFI Diagnostics": "4217A5",
+ "Lifecycle Controller": "1.0.8.42",
+ "Physical Disk 0:1:8": "D1S2",
+ "Manufacturer": "Dell Inc.",
+ "Physical Disk 0:1:6": "D1S2",
+ "SysMemTotalSize": "196608",
+ "PopulatedDIMMSlots": "24",
+ "Physical Disk 0:1:20": "D1S2",
+ "Intel(R) Ethernet 10G 2P X520 Adapter": "13.5.7",
+ "Physical Disk 0:1:14": "D1S2",
+ "BACKPLANE FIRMWARE": "1.00",
+ "Dell OS Drivers Pack, 7.0.0.29, A00": "7.0.0.29",
+ "Integrated Dell Remote Access Controller": "1.57.57",
+ "Physical Disk 0:1:5": "D1S2",
+ "ServiceTag": "D6XPDV1",
+ "PowerState": "2",
+ "Physical Disk 0:1:23": "D1S2",
+ "Physical Disk 0:1:25": "D903",
+ "BIOS": "1.3.6",
+ "Physical Disk 0:1:12": "D1S2",
+ "System CPLD": "1.0.3",
+ "Physical Disk 0:1:4": "D1S2",
+ "Physical Disk 0:1:0": "D1S2",
+ "Power Supply.Slot.1": "04.07.15",
+ "PERC H710P Mini": "21.0.2-0001",
+ "PowerCap": "689",
+ "Physical Disk 0:1:16": "D1S2",
+ "Physical Disk 0:1:10": "D1S2",
+ "Physical Disk 0:1:11": "D1S2",
+ "Lifecycle Controller 2": "1.0.8.42",
+ "BP12G+EXP 0:1": "1.07",
+ "Physical Disk 0:1:9": "D1S2",
+ "Physical Disk 0:1:17": "D1S2",
+ "Broadcom Gigabit Ethernet BCM5720": "7.2.20",
+ "Physical Disk 0:1:21": "D1S2",
+ "Physical Disk 0:1:13": "D1S2",
+ "Physical Disk 0:1:7": "D1S2",
+ "Physical Disk 0:1:19": "D1S2"
+ },
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "physLocation": "plocation-chi-1",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "xmppId": "atsec-chi-00-dummyxmpp",
+ "xmppPasswd": "X"
+
+ }
+ }
+
+|
+
+**POST /api/1.2/servercheck**
+
+ Post a server check result to the serverchecks table.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------------------+----------+-------------+
+ | Name | Required | Description |
+ +============================+==========+=============+
+ | ``id`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``host_name`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``servercheck_short_name`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``value`` | yes | |
+ +----------------------------+----------+-------------+
+
+ **Request Example** ::
+
+ {
+ "id": "",
+ "host_name": "",
+ "servercheck_short_name": "",
+ "value": ""
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ Response Example:
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Server Check was successfully updated."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/servers**
+
+ Allow user to create a server.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +----------------+----------+-------------------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+=============================================================+
+ | hostName | yes | The host name part of the server. |
+ +----------------+----------+-------------------------------------------------------------+
+ | domainName | yes | The domain name part of the FQDN of the cache. |
+ +----------------+----------+-------------------------------------------------------------+
+ | cachegroupId | yes | Cache Group ID |
+ +----------------+----------+-------------------------------------------------------------+
+ | interfaceName | yes | The interface name (e.g. eth0, p2p1). |
+ +----------------+----------+-------------------------------------------------------------+
+ | ipAddress | yes | Must be unique per server profile. |
+ +----------------+----------+-------------------------------------------------------------+
+ | ipNetmask | yes | The IPv4 Netmask |
+ +----------------+----------+-------------------------------------------------------------+
+ | ipGateway | yes | The IPv4 Gateway. |
+ +----------------+----------+-------------------------------------------------------------+
+ | interfaceMtu | yes | 1500 or 9000 |
+ +----------------+----------+-------------------------------------------------------------+
+ | physLocationId | yes | The ID of the Physical Location. |
+ +----------------+----------+-------------------------------------------------------------+
+ | typeId | yes | The ID of the Server Type |
+ +----------------+----------+-------------------------------------------------------------+
+ | profileId | yes | Profile ID - Profile's CDN must match server's. |
+ +----------------+----------+-------------------------------------------------------------+
+ | cdnId | yes | CDN ID the server belongs to |
+ +----------------+----------+-------------------------------------------------------------+
+ | updPending | yes | Is there an update pending for this server. (true or false) |
+ +----------------+----------+-------------------------------------------------------------+
+ | statusId | yes | The Status ID of the server. |
+ +----------------+----------+-------------------------------------------------------------+
+ | tcpPort | no | Must be a valid TCP port if specified. |
+ +----------------+----------+-------------------------------------------------------------+
+ | httpsPort | no | Must be a valid TCP port if specified. |
+ +----------------+----------+-------------------------------------------------------------+
+ | xmppId | no | |
+ +----------------+----------+-------------------------------------------------------------+
+ | xmppPasswd | no | |
+ +----------------+----------+-------------------------------------------------------------+
+ | ip6Address | no | IPv6 address and prefix. Must be unique per server profile. |
+ +----------------+----------+-------------------------------------------------------------+
+ | ip6Gateway | no | IPv6 Gateway |
+ +----------------+----------+-------------------------------------------------------------+
+ | rack | no | The rack location in the Data Center. |
+ +----------------+----------+-------------------------------------------------------------+
+ | mgmtIpAddress | no | The IPv4 management address. |
+ +----------------+----------+-------------------------------------------------------------+
+ | mgmtIpNetmask | no | The IPv4 management netmask. |
+ +----------------+----------+-------------------------------------------------------------+
+ | mgmtIpGateway | no | The IPv4 management gateway. |
+ +----------------+----------+-------------------------------------------------------------+
+ | iloIpAddress | no | The IPv4 ILO address. |
+ +----------------+----------+-------------------------------------------------------------+
+ | iloIpNetmask | no | The IPv4 ILO netmask. |
+ +----------------+----------+-------------------------------------------------------------+
+ | iloIpGateway | no | The IPv4 ILO gateway. |
+ +----------------+----------+-------------------------------------------------------------+
+ | iloUsername | no | The ILO username. |
+ +----------------+----------+-------------------------------------------------------------+
+ | iloPassword | no | The ILO password. |
+ +----------------+----------+-------------------------------------------------------------+
+ | routerHostName | no | The hostname of the router the server is connected to. |
+ +----------------+----------+-------------------------------------------------------------+
+ | routerPortName | no | The portname in the router. |
+ +----------------+----------+-------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "hostName": "tc1_ats1",
+ "domainName": "cdn1.kabletown.test",
+ "cachegroupId": 1,
+ "cdnId": 1,
+ "interfaceName": "eth0",
+ "ipAddress": "10.74.27.188",
+ "ipNetmask": "255.255.255.0",
+ "ipGateway": "10.74.27.1",
+ "interfaceMtu": 1500,
+ "physLocationId": 1,
+ "typeId": 1,
+ "profileId": 1,
+ "updPending": true,
+ "statusId": 1
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------+--------+------------------------------------------------+
+ | Name | Type | Description |
+ +================+========+================================================+
+ | hostName | string | The host name part of the server. |
+ +----------------+--------+------------------------------------------------+
+ | Name | string | Description |
+ +----------------+--------+------------------------------------------------+
+ | domainName | string | The domain name part of the FQDN of the cache. |
+ +----------------+--------+------------------------------------------------+
+ | cachegroup | string | cache group name |
+ +----------------+--------+------------------------------------------------+
+ | interfaceName | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | interfaceMtu | string | 1500 or 9000 |
+ +----------------+--------+------------------------------------------------+
+ | physLocation | string | |
+ +----------------+--------+------------------------------------------------+
+ | type | string | server type |
+ +----------------+--------+------------------------------------------------+
+ | profile | string | |
+ +----------------+--------+------------------------------------------------+
+ | cdnName | string | cdn name the server belongs to |
+ +----------------+--------+------------------------------------------------+
+ | tcpPort | string | |
+ +----------------+--------+------------------------------------------------+
+ | httpsPort | string | |
+ +----------------+--------+------------------------------------------------+
+ | xmppId | string | |
+ +----------------+--------+------------------------------------------------+
+ | xmppPasswd | string | |
+ +----------------+--------+------------------------------------------------+
+ | ip6Address | string | |
+ +----------------+--------+------------------------------------------------+
+ | ip6Gateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | rack | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloUsername | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloPassword | string | |
+ +----------------+--------+------------------------------------------------+
+ | routerHostName | string | |
+ +----------------+--------+------------------------------------------------+
+ | routerPortName | string | |
+ +----------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ 'response' : {
+ 'profileId' : 1,
+ 'xmppPasswd' : '**********',
+ 'profile' : 'EDGE1_CDN1_421',
+ 'iloUsername' : 'username',
+ 'statusId' : 1,
+ 'status' : 'REPORTED',
+ 'ipAddress' : '10.74.27.188',
+ 'cdnId' : 1,
+ 'physLocation' : 'plocation-chi-1',
+ 'cachegroup' : 'cache_group_edge',
+ 'interfaceName' : 'eth0',
+ 'ip6Gateway' : null,
+ 'iloPassword' : null,
+ 'id' : 1003,
+ 'routerPortName' : null,
+ 'lastUpdated' : '2016-01-25 14:16:16',
+ 'ipNetmask' : '255.255.255.0',
+ 'ipGateway' : '10.74.27.1',
+ 'tcpPort' : 80,
+ 'httpsPort' : 443,
+ 'mgmtIpAddress' : null,
+ 'ip6Address' : null,
+ 'interfaceMtu' : 1500,
+ 'iloIpGateway' : null,
+ 'hostName' : 'tc1_ats1',
+ 'xmppId' : 'tc1_ats1',
+ 'rack' : null,
+ 'mgmtIpNetmask' : null,
+ 'iloIpAddress' : null,
+ 'mgmtIpGateway' : null,
+ 'type' : 'EDGE',
+ 'domainName' : 'cdn1.kabletown.test',
+ 'iloIpNetmask' : null,
+ 'routerHostName' : null,
+ 'updPending' : false,
+ 'guid' : null,
+ 'physLocationId' : 1,
+ 'offlineReason' : 'N\/A',
+ 'cachegroupId' : 1,
+ 'typeId' : 1,
+ 'cdnName' : 'cdn1',
+ 'profileDesc' : 'The profile description'
+ }
+ }
+
+|
+
+**PUT /api/1.2/servers/{:id}**
+
+ Allow user to edit server through api.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------+----------+-------------------------------+
+ | Name | Required | Description |
+ +======+==========+===============================+
+ | id | yes | The id of the server to edit. |
+ +------+----------+-------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+-------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+=================================================+
+ | hostName | yes | The host name part of the server. |
+ +----------------+----------+-------------------------------------------------+
+ | domainName | yes | The domain name part of the FQDN of the cache. |
+ +----------------+----------+-------------------------------------------------+
+ | cachegroup | yes | cache group name |
+ +----------------+----------+-------------------------------------------------+
+ | interfaceName | yes | |
+ +----------------+----------+-------------------------------------------------+
+ | ipAddress | yes | Must be unique per server profile. |
+ +----------------+----------+-------------------------------------------------+
+ | ipNetmask | yes | |
+ +----------------+----------+-------------------------------------------------+
+ | ipGateway | yes | |
+ +----------------+----------+-------------------------------------------------+
+ | interfaceMtu | no | 1500 or 9000 |
+ +----------------+----------+-------------------------------------------------+
+ | physLocation | yes | |
+ +----------------+----------+-------------------------------------------------+
+ | type | yes | server type |
+ +----------------+----------+-------------------------------------------------+
+ | profile | yes | Profile ID - Profile's CDN must match server's. |
+ +----------------+----------+-------------------------------------------------+
+ | cdnName | yes | cdn name the server belongs to |
+ +----------------+----------+-------------------------------------------------+
+ | tcpPort | no | |
+ +----------------+----------+-------------------------------------------------+
+ | httpsPort | no | |
+ +----------------+----------+-------------------------------------------------+
+ | xmppId | no | |
+ +----------------+----------+-------------------------------------------------+
+ | xmppPasswd | no | |
+ +----------------+----------+-------------------------------------------------+
+ | ip6Address | no | Must be unique per server profile. |
+ +----------------+----------+-------------------------------------------------+
+ | ip6Gateway | no | |
+ +----------------+----------+-------------------------------------------------+
+ | rack | no | |
+ +----------------+----------+-------------------------------------------------+
+ | mgmtIpAddress | no | |
+ +----------------+----------+-------------------------------------------------+
+ | mgmtIpNetmask | no | |
+ +----------------+----------+-------------------------------------------------+
+ | mgmtIpGateway | no | |
+ +----------------+----------+-------------------------------------------------+
+ | iloIpAddress | no | |
+ +----------------+----------+-------------------------------------------------+
+ | iloIpNetmask | no | |
+ +----------------+----------+-------------------------------------------------+
+ | iloIpGateway | no | |
+ +----------------+----------+-------------------------------------------------+
+ | iloUsername | no | |
+ +----------------+----------+-------------------------------------------------+
+ | iloPassword | no | |
+ +----------------+----------+-------------------------------------------------+
+ | routerHostName | no | |
+ +----------------+----------+-------------------------------------------------+
+ | routerPortName | no | |
+ +----------------+----------+-------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "hostName": "tc1_ats2",
+ "domainName": "my.test.com",
+ "cachegroup": "cache_group_edge",
+ "cdnName": "cdn_number_1",
+ "interfaceName": "eth0",
+ "ipAddress": "10.74.27.188",
+ "ipNetmask": "255.255.255.0",
+ "ipGateway": "10.74.27.1",
+ "interfaceMtu": "1500",
+ "physLocation": "plocation-chi-1",
+ "type": "EDGE",
+ "profile": "EDGE1_CDN1_421"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------+--------+------------------------------------------------+
+ | Name | Type | Description |
+ +================+========+================================================+
+ | hostName | string | The host name part of the server. |
+ +----------------+--------+------------------------------------------------+
+ | Name | string | Description |
+ +----------------+--------+------------------------------------------------+
+ | domainName | string | The domain name part of the FQDN of the cache. |
+ +----------------+--------+------------------------------------------------+
+ | cachegroup | string | cache group name |
+ +----------------+--------+------------------------------------------------+
+ | interfaceName | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | interfaceMtu | string | 1500 or 9000 |
+ +----------------+--------+------------------------------------------------+
+ | physLocation | string | |
+ +----------------+--------+------------------------------------------------+
+ | type | string | server type |
+ +----------------+--------+------------------------------------------------+
+ | profile | string | |
+ +----------------+--------+------------------------------------------------+
+ | cdnName | string | cdn name the server belongs to |
+ +----------------+--------+------------------------------------------------+
+ | tcpPort | string | |
+ +----------------+--------+------------------------------------------------+
+ | httpsPort | string | |
+ +----------------+--------+------------------------------------------------+
+ | xmppId | string | |
+ +----------------+--------+------------------------------------------------+
+ | xmppPasswd | string | |
+ +----------------+--------+------------------------------------------------+
+ | ip6Address | string | |
+ +----------------+--------+------------------------------------------------+
+ | ip6Gateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | rack | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloUsername | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloPassword | string | |
+ +----------------+--------+------------------------------------------------+
+ | routerHostName | string | |
+ +----------------+--------+------------------------------------------------+
+ | routerPortName | string | |
+ +----------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ 'response' : {
+ 'xmppPasswd' : '**********',
+ 'profile' : 'EDGE1_CDN1_421',
+ 'iloUsername' : null,
+ 'status' : 'REPORTED',
+ 'ipAddress' : '10.74.27.188',
+ 'cdnId' : '1',
+ 'physLocation' : 'plocation-chi-1',
+ 'cachegroup' : 'cache_group_edge',
+ 'interfaceName' : 'eth0',
+ 'ip6Gateway' : null,
+ 'iloPassword' : null,
+ 'id' : '1003',
+ 'routerPortName' : null,
+ 'lastUpdated' : '2016-01-25 14:16:16',
+ 'ipNetmask' : '255.255.255.0',
+ 'ipGateway' : '10.74.27.1',
+ 'tcpPort' : '80',
+ 'httpsPort' : '443',
+ 'mgmtIpAddress' : null,
+ 'ip6Address' : null,
+ 'interfaceMtu' : '1500',
+ 'iloIpGateway' : null,
+ 'hostName' : 'tc1_ats2',
+ 'xmppId' : 'tc1_ats1',
+ 'rack' : null,
+ 'mgmtIpNetmask' : null,
+ 'iloIpAddress' : null,
+ 'mgmtIpGateway' : null,
+ 'type' : 'EDGE',
+ 'domainName' : 'my.test.com',
+ 'iloIpNetmask' : null,
+ 'routerHostName' : null
+ }
+ }
+
+|
+
+**PUT /api/1.2/servers/{:id}/status**
+
+ Updates server status and queues updates on all child caches if server type is EDGE or MID. Also, captures offline reason if status is set to ADMIN_DOWN or OFFLINE and prepends offline reason with the user that initiated the status change.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Route Parameters**
+
+ +------+----------+-------------------------------+
+ | Name | Required | Description |
+ +======+==========+===============================+
+ | id | yes | The id of the server. |
+ +------+----------+-------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+-------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+=================================================+
+ | status | yes | Status ID or name. |
+ +----------------+----------+-------------------------------------------------+
+ | offlineReason | yes|no | Required if status is ADMIN_DOWN or OFFLINE. |
+ +----------------+----------+-------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "status": "ADMIN_DOWN",
+ "offlineReason": "Bad drives"
+ }
+
+|
+
+ **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": "Updated status [ ADMIN_DOWN ] for foo.bar.net [ user23: bad drives ] and queued updates on all child caches"
+ }
+ ],
+ }
+
+|
+
+**DELETE /api/1.2/servers/{:id}**
+
+ Allow user to delete server through api.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------+----------+---------------------------------+
+ | Name | Required | Description |
+ +======+==========+=================================+
+ | id | yes | The id of the server to delete. |
+ +------+----------+---------------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Server was deleted."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/servers/{:id}/queue_update**
+
+ Queue or dequeue updates for a specific server.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------+----------+------------------+
+ | Name | Required | Description |
+ +===========+==========+==================+
+ | id | yes | the server id. |
+ +-----------+----------+------------------+
+
+ **Request Properties**
+
+ +--------------+---------+-----------------------------------------------+
+ | Name | Type | Description |
+ +==============+=========+===============================================+
+ | action | string | queue or dequeue |
+ +--------------+---------+-----------------------------------------------+
+
+ **Response Properties**
+
+ +--------------+---------+-----------------------------------------------+
+ | Name | Type | Description |
+ +==============+=========+===============================================+
+ | action | string | The action processed, queue or dequeue. |
+ +--------------+---------+-----------------------------------------------+
+ | serverId | integer | server id |
+ +--------------+---------+-----------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "serverId": "1",
+ "action": "queue"
+ }
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v12/static_dns.rst.txt b/docs/latest/_sources/api/v12/static_dns.rst.txt
new file mode 100644
index 0000000..0e44cec
--- /dev/null
+++ b/docs/latest/_sources/api/v12/static_dns.rst.txt
@@ -0,0 +1,66 @@
+..
+..
+.. 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-v12-dns:
+
+Static DNS Entries
+==================
+
+.. _to-api-v12-static-dns-route:
+
+/api/1.2/staticdnsentries
++++++++++++++++++++++++++
+
+**GET /api/1.2/staticdnsentries.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +---------------------+-----------+------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+===========+============================================================+
+ | ``deliveryservice`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``ttl`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``type`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``address`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``cachegroup`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``host`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "deliveryservice": "foo-ds",
+ "ttl": "30",
+ "type": "CNAME_RECORD",
+ "address": "bar.foo.baz.tv.",
+ "cachegroup": "us-co-denver",
+ "host": "mm"
+ }
+ ]
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v12/status.rst.txt b/docs/latest/_sources/api/v12/status.rst.txt
new file mode 100644
index 0000000..a97a313
--- /dev/null
+++ b/docs/latest/_sources/api/v12/status.rst.txt
@@ -0,0 +1,127 @@
+..
+..
+.. 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-v12-status:
+
+Status
+======
+
+.. _to-api-v12-statuses-route:
+
+/api/1.2/statuses
++++++++++++++++++
+
+**GET /api/1.2/statuses**
+
+ Retrieves a list of the server status codes available.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "5",
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "1",
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "2",
+ "name": "ONLINE",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "3",
+ "name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
+**GET /api/1.2/statuses/:id**
+
+ Retrieves a server status by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Status id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
diff --git a/docs/latest/_sources/api/v12/steering_target.rst.txt b/docs/latest/_sources/api/v12/steering_target.rst.txt
new file mode 100644
index 0000000..0708240
--- /dev/null
+++ b/docs/latest/_sources/api/v12/steering_target.rst.txt
@@ -0,0 +1,333 @@
+..
+..
+.. 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-v12-steering-targets:
+
+Steering Targets
+================
+
+.. _to-api-v12-steering-target-route:
+
+**GET /api/1.2/steering/:dsId/targets**
+
+ Get all targets for a steering delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+=============================================+
+ | ``dsId`` | yes | DS ID. |
+ +-------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``deliveryServiceId`` | int | DS ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``deliveryService`` | string | DS XML ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``targetId`` | int | Target DS ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``target`` | string | Target DS XML ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``value`` | int | Value is weight or order depending on type |
+ +----------------------+--------+-------------------------------------------------+
+ |``typeId`` | int | Steering target type ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``type`` | string | Steering target type name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "deliveryServiceId": 1
+ "deliveryService": "steering-ds-one",
+ "targetId": 2,
+ "target": "steering-target-one",
+ "value": 1,
+ "typeId": 35,
+ "type": "STEERING_ORDER"
+ },
+ {
+ "deliveryServiceId": 1
+ "deliveryService": "steering-ds-one",
+ "targetId": 3,
+ "target": "steering-target-two",
+ "value": 2,
+ "typeId": 35,
+ "type": "STEERING_ORDER"
+ },
+ ]
+ }
+
+|
+
+**GET /api/1.2/steering/:dsId/targets/:targetId**
+
+ Get a steering target.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+=============================================+
+ | ``dsId`` | yes | DS ID. |
+ +-------------+----------+---------------------------------------------+
+ | ``targetId``| yes | DS Target ID. |
+ +-------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``deliveryServiceId`` | int | DS ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``deliveryService`` | string | DS XML ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``targetId`` | int | Target DS ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``target`` | string | Target DS XML ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``value`` | int | Value is weight or order depending on type |
+ +----------------------+--------+-------------------------------------------------+
+ |``typeId`` | int | Steering target type ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``type`` | string | Steering target type name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "deliveryServiceId": 1
+ "deliveryService": "steering-ds-one",
+ "targetId": 2,
+ "target": "steering-target-one",
+ "value": 1,
+ "typeId": 35,
+ "type": "STEERING_ORDER"
+ }
+ ]
+ }
+
+|
+
+
+**PUT /api/1.2/steering/:dsId/targets/:targetId**
+
+ Update a steering target.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Portal
+
+ **Request Route Parameters**
+
+ +-------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+=============================================+
+ | ``dsId`` | yes | DS ID. |
+ +-------------+----------+---------------------------------------------+
+ | ``targetId``| yes | DS Target ID. |
+ +-------------+----------+---------------------------------------------+
+
+ **Request Properties**
+
+ +------------------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +========================+==========+==========================+
+ | ``value`` | yes | Target value |
+ +------------------------+----------+--------------------------+
+ | ``typeId`` | yes | Target type ID |
+ +------------------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "value": 34,
+ "typeId": 46,
+ }
+
+|
+
+ **Response Properties**
+
+ +------------------------+----------+--------------------------+
+ | Parameter | Type | Description |
+ +========================+==========+==========================+
+ | ``deliveryServiceId`` | int | Steering DS ID |
+ +------------------------+----------+--------------------------+
+ | ``deliveryService`` | string | DS XML ID |
+ +------------------------+----------+--------------------------+
+ | ``targetId`` | int | Target DS ID |
+ +------------------------+----------+--------------------------+
+ | ``target`` | string | Target DS XML ID |
+ +------------------------+----------+--------------------------+
+ | ``value`` | string | Target value |
+ +------------------------+----------+--------------------------+
+ | ``typeId`` | int | Target type ID |
+ +------------------------+----------+--------------------------+
+ | ``type`` | string | Steering target type name|
+ +------------------------+----------+--------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "deliveryServiceId": 1,
+ "deliveryService": "steering-ds-one",
+ "targetId": 2,
+ "target": "steering-target-two",
+ "value": "34",
+ "typeId": 45,
+ "type": "STEERING_ORDER"
+ },
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Delivery service steering target update was successful."
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.2/steering/:dsId/targets**
+
+ Create a steering target.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Portal
+
+ **Request Route Parameters**
+
+ +-------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+=============================================+
+ | ``dsId`` | yes | DS ID. |
+ +-------------+----------+---------------------------------------------+
+
+ **Request Properties**
+
+ +------------------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +========================+==========+==========================+
+ | ``targetId`` | yes | Target DS ID |
+ +------------------------+----------+--------------------------+
+ | ``value`` | yes | Target value |
+ +------------------------+----------+--------------------------+
+ | ``typeId`` | yes | Target type ID |
+ +------------------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "targetId": 6,
+ "value": 22,
+ "typeId": 47,
+ }
+
+|
+
+ **Response Properties**
+
+ +------------------------+----------+--------------------------+
+ | Parameter | Type | Description |
+ +========================+==========+==========================+
+ | ``deliveryServiceId`` | int | Steering DS ID |
+ +------------------------+----------+--------------------------+
+ | ``deliveryService`` | string | DS XML ID |
+ +------------------------+----------+--------------------------+
+ | ``targetId`` | int | Target DS ID |
+ +------------------------+----------+--------------------------+
+ | ``target`` | string | Target DS XML ID |
+ +------------------------+----------+--------------------------+
+ | ``value`` | string | Target value |
+ +------------------------+----------+--------------------------+
+ | ``typeId`` | int | Target type ID |
+ +------------------------+----------+--------------------------+
+ | ``type`` | string | Steering target type name|
+ +------------------------+----------+--------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "deliveryServiceId": 1,
+ "deliveryService": "steering-ds-one",
+ "targetId": 6,
+ "target": "steering-target-six",
+ "value": "22",
+ "typeId": 47,
+ "type": "STEERING_ORDER"
+ },
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Delivery service target creation was successful."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/steering/:dsId/targets/:targetId**
+
+ Delete a steering target.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Portal
+
+ **Request Route Parameters**
+
+ +-------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+=============================================+
+ | ``dsId`` | yes | DS ID. |
+ +-------------+----------+---------------------------------------------+
+ | ``targetId``| yes | DS Target ID. |
+ +-------------+----------+---------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Delivery service target delete was successful."
+ }
+ ],
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v12/system.rst.txt b/docs/latest/_sources/api/v12/system.rst.txt
new file mode 100644
index 0000000..2740d22
--- /dev/null
+++ b/docs/latest/_sources/api/v12/system.rst.txt
@@ -0,0 +1,80 @@
+..
+..
+.. 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-v12-sys:
+
+System
+======
+
+.. _to-api-v12-sys-route:
+
+/api/1.1/system
++++++++++++++++
+
+**GET /api/1.2/system/info.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Key | Type | Description |
+ +============================+========+======================================================================================================================================+
+ | ``parameters`` | hash | This is a hash with the parameter names that describe the Traffic Ops installation as keys. |
+ | | | These are all the parameters in the ``GLOBAL`` profile. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.toolname`` | string | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated |
+ | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.instance_name`` | string | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>traffic_rtr_fwd_proxy`` | string | When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through. |
+ | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
+ | | | this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to |
+ | | | set this parameter on a production system. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.url`` | string | The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated |
+ | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>traffic_mon_fwd_proxy`` | string | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. |
+ | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
+ | | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to |
+ | | | set this parameter on a production system. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.logourl`` | string | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.infourl`` | string | This is the "for more information go here" URL, which is visible in the About page. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "parameters": {
+ "tm.toolname": "Traffic Ops",
+ "tm.infourl": "http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info",
+ "traffic_mon_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
+ "traffic_rtr_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
+ "tm.logourl": "\/images\/tc_logo.png",
+ "tm.url": "https:\/\/tm.kabletown.net\/",
+ "tm.instance_name": "Kabletown CDN"
+ }
+ },
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v12/tenant.rst.txt b/docs/latest/_sources/api/v12/tenant.rst.txt
new file mode 100644
index 0000000..f75868e
--- /dev/null
+++ b/docs/latest/_sources/api/v12/tenant.rst.txt
@@ -0,0 +1,255 @@
+..
+..
+.. 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-v12-tenant:
+
+Tenants
+=======
+
+.. _to-api-v12-tenant-route:
+
+/api/1.2/tenants
+++++++++++++++++++
+
+**GET /api/1.2/tenants**
+
+ Get all tenants.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | int | Tenant id |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Tenant name |
+ +----------------------+--------+-------------------------------------------------+
+ |``active`` | bool | Active or inactive |
+ +----------------------+--------+-------------------------------------------------+
+ |``parentId`` | int | Parent tenant ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``parentName`` | string | Parent tenant name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 1
+ "name": "root",
+ "active": true,
+ "parentId": null,
+ "parentName": null,
+ },
+ {
+ "id": 2
+ "name": "tenant-a",
+ "active": true,
+ "parentId": 1
+ "parentName": "root"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/tenants/:id**
+
+ Get a tenant by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | int | Tenant id |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Tenant name |
+ +----------------------+--------+-------------------------------------------------+
+ |``active`` | bool | Active or inactive |
+ +----------------------+--------+-------------------------------------------------+
+ |``parentId`` | int | Parent tenant ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``parentName`` | string | Parent tenant name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 2
+ "name": "tenant-a",
+ "active": true,
+ "parentId": 1,
+ "parentName": "root"
+ }
+ ]
+ }
+
+|
+
+
+**PUT /api/1.2/tenants/:id**
+
+ Update a tenant.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Tenant id |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+==========================+
+ | ``name`` | yes | The name of the tenant |
+ +-------------------+----------+--------------------------+
+ | ``active`` | yes | True or false |
+ +-------------------+----------+--------------------------+
+ | ``parentId`` | yes | Parent tenant |
+ +-------------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "my-tenant"
+ "active": true
+ "parentId": 1
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | int | Tenant id |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Tenant name |
+ +----------------------+--------+-------------------------------------------------+
+ |``active`` | bool | Active or inactive |
+ +----------------------+--------+-------------------------------------------------+
+ |``parentId`` | int | Parent tenant ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``parentName`` | string | Parent tenant name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "id": 2,
+ "name": "my-tenant",
+ "active": true,
+ "parentId": 1,
+ "parentName": "root",
+ "lastUpdated": "2014-03-18 08:57:39"
+ },
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Tenant update was successful."
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.2/tenants**
+
+ Create a tenant.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +-------------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+==========================+
+ | ``name`` | yes | The name of the tenant |
+ +-------------------+----------+--------------------------+
+ | ``active`` | no | Defaults to false |
+ +-------------------+----------+--------------------------+
+ | ``parentId`` | yes | Parent tenant |
+ +-------------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "your-tenant"
+ "parentId": 2
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | int | Tenant id |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Tenant name |
+ +----------------------+--------+-------------------------------------------------+
+ |``active`` | bool | Active or inactive |
+ +----------------------+--------+-------------------------------------------------+
+ |``parentId`` | int | Parent tenant ID |
+ +----------------------+--------+-------------------------------------------------+
+ |``parentName`` | string | Parent tenant name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "id": 2,
+ "name": "your-tenant",
+ "active": false,
+ "parentId": 2,
+ "parentName": "my-tenant",
+ "lastUpdated": "2014-03-18 08:57:39"
+ },
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Tenant create was successful."
+ }
+ ]
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/to_extension.rst.txt b/docs/latest/_sources/api/v12/to_extension.rst.txt
new file mode 100644
index 0000000..44c0246
--- /dev/null
+++ b/docs/latest/_sources/api/v12/to_extension.rst.txt
@@ -0,0 +1,206 @@
+..
+..
+.. 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-v12-ext:
+
+TO Extensions
+=============
+
+.. _to-api-v12-ext-route:
+
+/api/1.2/to_extensions
+++++++++++++++++++++++
+
+**GET /api/1.2/to_extensions.json**
+
+Retrieves the list of extensions.
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+**Response Properties**
+
++--------------------------+--------+--------------------------------------------+
+| 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.2/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.2/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
+ isactive: "1",
+ id: "2",
+ type: "CHECK_EXTENSION_BOOL",
+ servercheck_short_name: "10G"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/to_extensions**
+
+ Creates a Traffic Ops extension.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **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.2/servers.json", "match": { "type": "EDGE"}",
+ "description": null,
+ "servercheck_short_name": "ILO"
+ "type": "CHECK_EXTENSION_BOOL",
+ }
+
+|
+
+ **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."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/to_extensions/:id/delete**
+
+ Deletes a Traffic Ops extension.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +--------+----------+-----------------+
+ | Name | Required | Description |
+ +========+==========+=================+
+ | ``id`` | yes | TO extension id |
+ +--------+----------+-----------------+
+
+ **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."
+ }
+ ],
+ }
+
+
+|
diff --git a/docs/latest/_sources/api/v12/topology.rst.txt b/docs/latest/_sources/api/v12/topology.rst.txt
new file mode 100644
index 0000000..9b7cf9f
--- /dev/null
+++ b/docs/latest/_sources/api/v12/topology.rst.txt
@@ -0,0 +1,152 @@
+..
+..
+.. 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-v12-topology:
+
+Snapshot CRConfig
+=================
+
+.. _to-api-v12-topology-route:
+
+/api/1.2/snapshot/{:cdn_name}
++++++++++++++++++++++++++++++
+
+**GET /api/1.2/cdns/{:cdn_name}/snapshot**
+
+ Retrieves the CURRENT snapshot for a CDN which doesn't necessarily represent the current state of the CDN. The contents of this snapshot are currently used by Traffic Monitor and Traffic Router.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Route Parameters**
+
+ +----------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+=============================================+
+ | ``cdn_name`` | yes | CDN name. |
+ +----------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+==============================================================================+
+ | ``config`` | hash | General CDN configuration settings. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | ``contentRouters`` | hash | A list of Traffic Routers. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | ``contentServers`` | hash | A list of Traffic Servers and the delivery services associated with each. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | ``deliveryServices`` | hash | A list of delivery services. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | ``edgeLocations`` | hash | A list of cache groups. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | ``stats`` | hash | Snapshot properties. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "config": { ... },
+ "contentRouters": { ... },
+ "contentServers": { ... },
+ "deliveryServices": { ... },
+ "edgeLocations": { ... },
+ "stats": { ... },
+ },
+ }
+
+|
+
+**GET /api/1.2/cdns/{:cdn_name}/snapshot/new**
+
+ Retrieves a PENDING snapshot for a CDN which represents the current state of the CDN. The contents of this snapshot are NOT currently used by Traffic Monitor and Traffic Router. Once a snapshot is performed, this snapshot will become the CURRENT snapshot and will be used by Traffic Monitor and Traffic Router.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Route Parameters**
+
+ +----------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+=============================================+
+ | ``cdn_name`` | yes | CDN name. |
+ +----------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+==============================================================================+
+ | ``config`` | hash | General CDN configuration settings. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | ``contentRouters`` | hash | A list of Traffic Routers. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | ``contentServers`` | hash | A list of Traffic Servers and the delivery services associated with each. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | ``deliveryServices`` | hash | A list of delivery services. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | ``edgeLocations`` | hash | A list of cache groups. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+ | ``stats`` | hash | Snapshot properties. |
+ +-----------------------+--------+------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "config": { ... },
+ "contentRouters": { ... },
+ "contentServers": { ... },
+ "deliveryServices": { ... },
+ "edgeLocations": { ... },
+ "stats": { ... },
+ },
+ }
+
+|
+
+**PUT /api/1.2/snapshot/{:cdn_name}**
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------------------------------------+
+ | Name | Required | Description |
+ +==========+==========+===========================================+
+ | cdn_name | yes | The name of the cdn to snapshot configure |
+ +----------+----------+-------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |response | string | "SUCCESS" |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": "SUCCESS"
+ }
+
+|
diff --git a/docs/latest/_sources/api/v12/type.rst.txt b/docs/latest/_sources/api/v12/type.rst.txt
new file mode 100644
index 0000000..6d614c5
--- /dev/null
+++ b/docs/latest/_sources/api/v12/type.rst.txt
@@ -0,0 +1,151 @@
+..
+..
+.. 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-v12-type:
+
+Types
+=====
+
+.. _to-api-v12-types-route:
+
+/api/1.2/types
+++++++++++++++
+
+**GET /api/1.1/types**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``useInTable`` | no | Filter types by the table in which they apply |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
+
+**GET /api/1.1/types/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "AAAA_RECORD"
+ },
+ {
+ "name": "ACTIVE_DIRECTORY"
+ },
+ {
+ "name": "A_RECORD"
+ },
+ {
+ "name": "CCR"
+ }
+ ],
+ }
+
+**GET /api/1.1/types/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``id`` | yes | Type ID. |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
diff --git a/docs/latest/_sources/api/v12/user.rst.txt b/docs/latest/_sources/api/v12/user.rst.txt
new file mode 100644
index 0000000..8d22fc7
--- /dev/null
+++ b/docs/latest/_sources/api/v12/user.rst.txt
@@ -0,0 +1,1258 @@
+..
+..
+.. 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-v12-users:
+
+Users
+=====
+
+.. _to-api-v12-users-route:
+
+/api/1.2/users
+++++++++++++++
+
+**GET /api/1.2/users**
+
+ Retrieves all users.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``tenant`` | no | Filter users by tenant ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +----------------------+--------+------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "tenant": "root",
+ "tenantId": 1,
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/users/:id**
+
+ Retrieves user by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | User id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +----------------------+--------+------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "tenant": "root",
+ "tenantId": 1,
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**POST /api/1.2/users**
+
+ Create a user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +-------------------------+--------+----------+-------------------------------------------------+
+ | Parameter | Type | Required | Description |
+ +=========================+========+==========+=================================================+
+ |``addressLine1`` | string | no | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``addressLine2`` | string | no | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``city`` | string | no | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``confirmLocalPassword`` | string | yes | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``company`` | string | no | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``country`` | string | no | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``email`` | string | yes | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``fullName`` | string | yes | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``localPassword`` | string | yes | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``newUser`` | bool | no | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``phoneNumber`` | string | no | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``postalCode`` | string | no | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``publicSshKey`` | string | no | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``role`` | int | yes | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``stateOrProvince`` | string | no | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ | ``tenantId`` | int | no | Owning tenant ID |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``username`` | string | yes | |
+ +-------------------------+--------+----------+-------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "username": "tsimpson"
+ "tenantId": 1,
+ "fullName": "Tom Simpson"
+ "email": "email1@email.com"
+ "role": 6
+ "localPassword": "password"
+ "confirmLocalPassword": "password"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | int | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | int | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | bool | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | int | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | int | |
+ +----------------------+--------+------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {"alerts": [
+ {
+ "level":"success",
+ "text":"User creation was successful."
+ }
+ ],
+ "response: {
+ "addressLine1":"",
+ "addressLine2":"",
+ "city":"",
+ "company":"",
+ "country":"",
+ "email":"email1@email.com",
+ "fullName":"Tom Simpson",
+ "gid":0,
+ "id":2,
+ "lastUpdated":null,
+ "newUser":false,
+ "phoneNumber":"",
+ "postalCode":"",
+ "publicSshKey":"",
+ "registrationSent":false,
+ "role":6,
+ "roleName":"portal",
+ "stateOrProvince":"",
+ "tenantId": 1,
+ "uid":0,
+ "username":"tsimpson",
+ }
+ }
+
+|
+
+
+**POST /api/1.2/users/register**
+
+ Register a user and send registration email.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin or Operations
+
+ **Request Properties**
+
+ +-------------------------+--------+----------+-------------------------------------------------+
+ | Parameter | Type | Required | Description |
+ +=========================+========+==========+=================================================+
+ |``email`` | string | yes | Email address of the new user. |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``role`` | int | yes | Role ID of the new user. |
+ +-------------------------+--------+----------+-------------------------------------------------+
+ |``tenantId`` | int | yes | Tenant ID of the new user. |
+ +-------------------------+--------+----------+-------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "email": "foo@bar.com"
+ "role": 1,
+ "tenantId": "1"
+ }
+
+|
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level":"success",
+ "text":"Sent user registration to foo@bar.com with the following permissions [ role: admin | tenant: root ]"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/users/:id/deliveryservices**
+
+ Retrieves all delivery services assigned to the user. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | User ID. |
+ +-----------------+----------+---------------------------------------------------+
+
+
+ **Response Properties**
+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``deepCachingType`` | string | When to do Deep Caching for this Delivery Service: |
+ | | | |
+ | | | - NEVER (default) |
+ | | | - ALWAYS |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``routingName`` | string | The routing name of this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | List of header keys separated by ``__RETURN__``. Listed headers will be included in TR access log entries under the "rh=" token. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | List of header ``name:value`` pairs separated by ``__RETURN__``. Listed pairs will be included in all TR HTTP responses. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "deepCachingType": "NEVER",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://foo.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "routingName": "foo",
+ "signed": false,
+ "sslKeyVersion": "0",
+ "tenant": "root",
+ "tenantId": 1,
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/user/current**
+
+ Retrieves the profile for the authenticated user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+=========+================================================+
+ |``email`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``localUser`` | boolean | |
+ +----------------------+---------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``newUser`` | boolean | |
+ +----------------------+---------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``addressLine1`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ | ``tenant`` | string | Owning tenant name |
+ +----------------------+---------+------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+ +----------------------+---------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "email": "email@email.com",
+ "city": "",
+ "id": "50",
+ "phoneNumber": "",
+ "company": "",
+ "country": "",
+ "fullName": "Tom Callahan",
+ "localUser": true,
+ "uid": "0",
+ "stateOrProvince": "",
+ "username": "tommyboy",
+ "newUser": false,
+ "addressLine2": "",
+ "role": "6",
+ "addressLine1": "",
+ "gid": "0",
+ "postalCode": "",
+ "tenant": "root",
+ "tenantId": 1
+
+ },
+ }
+
+|
+
+**PUT /api/1.2/user/current**
+
+ Updates the date for the authenticated user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+=========+================================================+
+ |``email`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``localUser`` | boolean | |
+ +----------------------+---------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``newUser`` | boolean | |
+ +----------------------+---------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``addressLine1`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ | ``tenantId`` | int | Owning tenant ID |
+ +----------------------+---------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "user": {
+ "email": "",
+ "city": "",
+ "id": "",
+ "phoneNumber": "",
+ "company": "",
+ "country": "",
+ "fullName": "",
+ "localUser": true,
+ "uid": "0",
+ "stateOrProvince": "",
+ "username": "tommyboy",
+ "newUser": false,
+ "addressLine2": "",
+ "role": "6",
+ "addressLine1": "",
+ "gid": "0",
+ "postalCode": "",
+ "tenant": "root",
+ "tenantId": 1,
+
+ }
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "UserProfile was successfully updated."
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/user/current/jobs.json**
+
+ Retrieves the user's list of jobs.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+========================================+
+ | ``keyword`` | no | PURGE |
+ +--------------+----------+----------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``keyword`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``objectName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``assetUrl`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``assetType`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``status`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``dsId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``dsXmlId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``parameters`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``enteredTime`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``objectType`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``agent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``startTime`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example**
+ ::
+
+ {
+ "response": [
+ {
+ "id": "1",
+ "keyword": "PURGE",
+ "objectName": null,
+ "assetUrl": "",
+ "assetType": "file",
+ "status": "PENDING",
+ "dsId": "9999",
+ "dsXmlId": "ds-xml-id",
+ "username": "peewee",
+ "parameters": "TTL:56h",
+ "enteredTime": "2015-01-21 18:00:16",
+ "objectType": null,
+ "agent": "",
+ "startTime": "2015-01-21 10:45:38"
+ }
+ ],
+ }
+
+|
+
+**POST/api/1.2/user/current/jobs**
+
+Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
+
+.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.2 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``dsId`` | string | Unique Delivery Service ID |
+ +----------------------+--------+------------------------------------------------+
+ |``regex`` | string | Path Regex this should be a |
+ | | | `PCRE <http://www.pcre.org/>`_ compatible |
+ | | | regular expression for the path to match for |
+ | | | forcing the revalidation. Be careful to only |
+ | | | match on the content you need to remove - |
+ | | | revalidation is an expensive operation for |
+ | | | many origins, and a simple ``/.*`` can cause |
+ | | | an overload condition of the origin. |
+ +----------------------+--------+------------------------------------------------+
+ |``startTime`` | string | Start Time is the time when the revalidation |
+ | | | rule will be made active. Populate |
+ | | | with the current time to schedule ASAP. This |
+ | | | value cannot be more than 2 days before now. |
+ +----------------------+--------+------------------------------------------------+
+ |``ttl`` | int | Time To Live is how long the revalidation rule |
+ | | | will be active for in hours. It usually makes |
+ | | | sense to make this the same as the |
+ | | | ``Cache-Control`` header from the origin which |
+ | | | sets the object time to live in cache |
+ | | | (by ``max-age`` or ``Expires``). Entering a |
+ | | | longer TTL here will make the caches do |
+ | | | unnecessary work. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "dsId": "9999",
+ "regex": "/path/to/content.jpg",
+ "startTime": "2015-01-27 11:08:37",
+ "ttl": 54
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Successfully created purge job for: ."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.2/user/login**
+
+ Authentication of a user using username and password. Traffic Ops will send back a session cookie.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``u`` | string | username |
+ +----------------------+--------+------------------------------------------------+
+ |``p`` | string | password |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "u": "username",
+ "p": "password"
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Successfully logged in."
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/user/:id/deliveryservices/available**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``displayName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``xmlId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+
+ {
+ "response": [
+ {
+ "id": "90",
+ "displayName": "Foo Bar DS",
+ "xmlId": "foo-bar"
+ },
+ {
+ "id": "92",
+ "displayName": "Foo Baz DS",
+ "xmlId": "foo-baz"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/user/login/token**
+
+ Authentication of a user using a token.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``t`` | string | token-value |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "t": "token-value"
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=============+========+=============+
+ | ``alerts`` | array | |
+ +-------------+--------+-------------+
+ | ``>level`` | string | |
+ +-------------+--------+-------------+
+ | ``>text`` | string | |
+ +-------------+--------+-------------+
+ | ``version`` | string | |
+ +-------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "error",
+ "text": "Unauthorized, please log in."
+ }
+ ],
+ }
+
+
+|
+
+
+**POST /api/1.2/user/logout**
+
+ User logout. Invalidates the session cookie.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``alerts`` | array | |
+ +----------------------+--------+------------------------------------------------+
+ |* ``level`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |* ``text`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example**
+ ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "You are logged out."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.2/user/reset_password**
+
+ Reset user password.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``email`` | string | The email address of the user to initiate |
+ | | | password reset. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example**
+ ::
+
+ {
+ "email": "email@email.com"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``alerts`` | array | A collection of alert messages. |
+ +----------------------+--------+------------------------------------------------+
+ |* ``level`` | string | Success, info, warning or error. |
+ +----------------------+--------+------------------------------------------------+
+ |* ``text`` | string | Alert message. |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Successfully sent password reset to email 'email@email.com'"
+ }
+ ],
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v13/coordinate.rst.txt b/docs/latest/_sources/api/v13/coordinate.rst.txt
new file mode 100644
index 0000000..5a18e50
--- /dev/null
+++ b/docs/latest/_sources/api/v13/coordinate.rst.txt
@@ -0,0 +1,272 @@
+..
+..
+.. 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-v13-coordinate:
+
+Coordinate
+==========
+
+.. _to-api-v13-coordinates-route:
+
+/api/1.3/coordinates
+++++++++++++++++++++
+
+**GET /api/1.3/coordinates**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | no | Filter Coordinates by ID. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``name`` | no | Filter Coordinates by name. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | int | Local unique identifier for the Coordinate |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | float | Latitude of the Coordinate |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | float | Longitude of the Coordinate |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Coordinate |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": 21,
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": 0,
+ "longitude": 0,
+ "name": "dc-chicago"
+ },
+ {
+ "id": 22,
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": 0,
+ "longitude": 0,
+ "name": "dc-chicago-1"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.3/coordinates**
+
+ Create Coordinate.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``name`` | yes | The name of the Coordinate entry |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``latitude`` | no | Latitude of the Coordinate |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``longitude`` | no | Longitude of the Coordinate |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "my_coordinate",
+ "latitude": 1.2,
+ "longitude": 4.5
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``id`` | int | The id of the Coordinate |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``name`` | string | The name of the Coordinate |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``latitude`` | float | Latitude of the Coordinate |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``longitude`` | float | Longitude of the Coordinate |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "coordinate was created"
+ }
+ ],
+ "response": {
+ 'longitude' : 4.5,
+ 'lastUpdated' : '2016-01-25 13:55:30',
+ 'name' : 'my_coordinate',
+ 'latitude' : 1.2,
+ 'id' : 1
+ }
+ }
+
+|
+
+**PUT /api/1.3/coordinates**
+
+ Update coordinate.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Query Parameters**
+
+ +------+----------+------------------------------------+
+ | Name | Required | Description |
+ +======+==========+====================================+
+ | id | yes | The id of the coordinate to edit. |
+ +------+----------+------------------------------------+
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``id`` | yes | The id of the Coordinate |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``name`` | yes | The name of the Coordinate entry |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``latitude`` | no | Latitude of the Coordinate |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``longitude`` | no | Longitude of the Coordinate |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "id": 1,
+ "name": "my_coordinate",
+ "latitude": 12,
+ "longitude": 45
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``id`` | int | The id of the Coordinate |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``name`` | string | The name of the Coordinate |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``latitude`` | float | Latitude of the Coordinate |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``longitude`` | float | Longitude of the Coordinate |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "coordinate was updated"
+ }
+ ],
+ "response": {
+ 'longitude' : 45,
+ 'lastUpdated' : '2016-01-25 13:55:30',
+ 'name' : 'my_coordinate',
+ 'latitude' : 12,
+ 'id' : 1
+ }
+ }
+
+|
+
+**DELETE /api/1.3/coordinates**
+
+ Delete coordinate.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Query Parameters**
+
+ +------+----------+--------------------------------------+
+ | Name | Required | Description |
+ +======+==========+======================================+
+ | id | yes | The id of the coordinate to delete. |
+ +------+----------+--------------------------------------+
+
+ **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": "coordinate was deleted"
+ }
+ ]
+ }
+
+|
+
diff --git a/docs/latest/_sources/api/v13/index.rst.txt b/docs/latest/_sources/api/v13/index.rst.txt
new file mode 100644
index 0000000..6774909
--- /dev/null
+++ b/docs/latest/_sources/api/v13/index.rst.txt
@@ -0,0 +1,25 @@
+..
+..
+.. 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.
+..
+
+
+API 1.3 Reference
+*****************
+Traffic Ops API V1.3
+
+.. toctree::
+ :maxdepth: 1
+
+ coordinate
+ origin
diff --git a/docs/latest/_sources/api/v13/origin.rst.txt b/docs/latest/_sources/api/v13/origin.rst.txt
new file mode 100644
index 0000000..185f9ca
--- /dev/null
+++ b/docs/latest/_sources/api/v13/origin.rst.txt
@@ -0,0 +1,474 @@
+..
+..
+.. 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-v13-origin:
+
+Origin
+======
+
+.. _to-api-v13-origin-route:
+
+/api/1.3/origins
+++++++++++++++++
+
+**GET /api/1.3/origins**
+
+ Get Origins.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +-------------------------+-----------------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=========================+=================+===================================================+
+ | ``cachegroup`` | no | Filter Origins by cachegroup ID. |
+ +-------------------------+-----------------+---------------------------------------------------+
+ | ``coordinate`` | no | Filter Origins by coordinate ID. |
+ +-------------------------+-----------------+---------------------------------------------------+
+ | ``deliveryservice`` | no | Filter Origins by deliveryservice ID. |
+ +-------------------------+-----------------+---------------------------------------------------+
+ | ``id`` | no | Filter Origins by ID. |
+ +-------------------------+-----------------+---------------------------------------------------+
+ | ``name`` | no | Filter Origins by name. |
+ +-------------------------+-----------------+---------------------------------------------------+
+ | ``profileId`` | no | Filter Origins by profile ID. |
+ +-------------------------+-----------------+---------------------------------------------------+
+ | ``primary`` | no | Filter Origins by isPrimary. |
+ +-------------------------+-----------------+---------------------------------------------------+
+ | ``tenant`` | no | Filter Origins by tenant ID. |
+ +-------------------------+-----------------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+===================+==========================================================================+
+ | ``cachegroup`` | string | Name of the Origin's cachegroup |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``cachegroupId`` | int | ID of the Origin's cachegroup |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``coordinate`` | string | Name of the Origin's coordinate |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``coordinateID`` | int | ID of the Origin's coordinate |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``deliveryService`` | string | XML_ID of the Origin's delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``deliveryServiceId`` | int | ID of the Origin's delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``fqdn`` | string | The FQDN of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``id`` | int | Local unique identifier for the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``ip6Address`` | string | IPv6 address of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``ipAddress`` | string | IPv4 address of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``isPrimary`` | boolean | Whether or not this is the primary Origin for the delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``port`` | int | The TCP port on which the Origin listens |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``profile`` | string | The profile name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``profileId`` | int | The profile ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``protocol`` | string | The protocol of the Origin's URL (http or https) |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``tenant`` | string | The tenant name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``tenantId`` | int | The tenant ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "cg1",
+ "cachegroupId": 1,
+ "coordinate": "coordinate1",
+ "coordinateId": 1,
+ "deliveryService": "myds",
+ "deliveryServiceId": 1,
+ "fqdn": "example.com",
+ "id": 1,
+ "ip6Address": "cafe:dead:d0d0::42",
+ "ipAddress": "10.2.3.4",
+ "isPrimary": false,
+ "lastUpdated": "2018-05-08 19:33:18+00",
+ "name": "my-origin",
+ "port": 443,
+ "profile": "my-origins",
+ "profileId": 1,
+ "protocol": "https",
+ "tenant": "tenantA",
+ "tenantId": 3
+ },
+ {
+ "cachegroup": null,
+ "cachegroupId": null,
+ "coordinate": null,
+ "coordinateId": null,
+ "deliveryService": null,
+ "deliveryServiceId": null,
+ "fqdn": "foo.example.com",
+ "id": 2,
+ "ip6Address": null,
+ "ipAddress": null,
+ "isPrimary": false,
+ "lastUpdated": "2018-05-08 19:35:12+00",
+ "name": "origin2",
+ "port": null,
+ "profile": null,
+ "profileId": null,
+ "protocol": "http",
+ "tenant": null,
+ "tenantId": null
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.3/origins**
+
+ Create Origin.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===================================+===================+==========================================================================+
+ | ``cachegroupId`` | no | ID of the Origin's cachegroup |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``coordinateID`` | no | ID of the Origin's coordinate |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``deliveryServiceId`` | yes | ID of the Origin's delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``fqdn`` | yes | The FQDN of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``ip6Address`` | no | IPv6 address of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``ipAddress`` | no | IPv4 address of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``name`` | yes | The name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``port`` | no | The TCP port on which the Origin listens |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``profileId`` | no | The profile ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``protocol`` | yes | The protocol of the Origin's URL (http or https) |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``tenantId`` | no | The tenant ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "cachegroupId": 1,
+ "coordinateId": 1,
+ "deliveryServiceId": 1,
+ "fqdn": "foo.example.com",
+ "ip6Address": "cafe:dead:d0d0::42",
+ "ipAddress": "10.2.3.4",
+ "name": "origin1",
+ "port": 443,
+ "profileId": 1,
+ "protocol": "https",
+ "tenantId": 1
+ }
+
+ **Response Properties**
+
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+===================+==========================================================================+
+ | ``cachegroup`` | string | Name of the Origin's cachegroup |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``cachegroupId`` | int | ID of the Origin's cachegroup |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``coordinate`` | string | Name of the Origin's coordinate |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``coordinateID`` | int | ID of the Origin's coordinate |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``deliveryService`` | string | XML_ID of the Origin's delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``deliveryServiceId`` | int | ID of the Origin's delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``fqdn`` | string | The FQDN of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``id`` | int | Local unique identifier for the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``ip6Address`` | string | IPv6 address of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``ipAddress`` | string | IPv4 address of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``isPrimary`` | boolean | Whether or not this is the primary Origin for the delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``port`` | int | The TCP port on which the Origin listens |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``profile`` | string | The profile name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``profileId`` | int | The profile ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``protocol`` | string | The protocol of the Origin's URL (http or https) |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``tenant`` | string | The tenant name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``tenantId`` | int | The tenant ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "origin was created."
+ }
+ ],
+ "response": {
+ "cachegroup": null,
+ "cachegroupId": 1,
+ "coordinate": null,
+ "coordinateId": 1,
+ "deliveryService": null,
+ "deliveryServiceId": 1,
+ "fqdn": "foo.example.com",
+ "id": 1,
+ "ip6Address": "cafe:dead:d0d0::42",
+ "ipAddress": "10.2.3.4",
+ "isPrimary": false,
+ "lastUpdated": "2018-05-08 20:30:27+00",
+ "name": "origin1",
+ "port": 443,
+ "profile": null,
+ "profileId": 1,
+ "protocol": "https",
+ "tenant": null,
+ "tenantId": 1
+ }
+ }
+
+|
+
+**PUT /api/1.3/origins**
+
+ Update origin.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Query Parameters**
+
+ +------+----------+------------------------------------+
+ | Name | Required | Description |
+ +======+==========+====================================+
+ | id | yes | The id of the coordinate to edit. |
+ +------+----------+------------------------------------+
+
+ **Request Parameters**
+
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +===================================+===================+==========================================================================+
+ | ``cachegroupId`` | no | ID of the Origin's cachegroup |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``coordinateID`` | no | ID of the Origin's coordinate |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``deliveryServiceId`` | yes | ID of the Origin's delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``fqdn`` | yes | The FQDN of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``id`` | yes | The ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``ip6Address`` | no | IPv6 address of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``ipAddress`` | no | IPv4 address of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``name`` | yes | The name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``port`` | no | The TCP port on which the Origin listens |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``profileId`` | no | The profile ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``protocol`` | yes | The protocol of the Origin's URL (http or https) |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``tenantId`` | no | The tenant ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "cachegroupId": 1,
+ "coordinateId": 1,
+ "deliveryServiceId": 1,
+ "fqdn": "foo.example.com",
+ "id": 1,
+ "ip6Address": "cafe:dead:d0d0::42",
+ "ipAddress": "10.2.3.4",
+ "name": "origin1",
+ "port": 443,
+ "profileId": 1,
+ "protocol": "https",
+ "tenantId": 1
+ }
+
+ **Response Properties**
+
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+===================+==========================================================================+
+ | ``cachegroup`` | string | Name of the Origin's cachegroup |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``cachegroupId`` | int | ID of the Origin's cachegroup |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``coordinate`` | string | Name of the Origin's coordinate |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``coordinateID`` | int | ID of the Origin's coordinate |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``deliveryService`` | string | XML_ID of the Origin's delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``deliveryServiceId`` | int | ID of the Origin's delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``fqdn`` | string | The FQDN of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``id`` | int | Local unique identifier for the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``ip6Address`` | string | IPv6 address of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``ipAddress`` | string | IPv4 address of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``isPrimary`` | boolean | Whether or not this is the primary Origin for the delivery service |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``port`` | int | The TCP port on which the Origin listens |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``profile`` | string | The profile name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``profileId`` | int | The profile ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``protocol`` | string | The protocol of the Origin's URL (http or https) |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``tenant`` | string | The tenant name of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``tenantId`` | int | The tenant ID of the Origin |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-----------------------------------+-------------------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "origin was updated."
+ }
+ ],
+ "response": {
+ "cachegroup": null,
+ "cachegroupId": 1,
+ "coordinate": null,
+ "coordinateId": 1,
+ "deliveryService": null,
+ "deliveryServiceId": 1,
+ "fqdn": "foo.example.com",
+ "id": 1,
+ "ip6Address": "cafe:dead:d0d0::42",
+ "ipAddress": "10.2.3.4",
+ "isPrimary": false,
+ "lastUpdated": "2018-05-08 20:30:27+00",
+ "name": "origin1",
+ "port": 443,
+ "profile": null,
+ "profileId": 1,
+ "protocol": "https",
+ "tenant": null,
+ "tenantId": 1
+ }
+ }
+
+|
+
+**DELETE /api/1.3/origin**
+
+ Delete origin.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Query Parameters**
+
+ +------+----------+--------------------------------------+
+ | Name | Required | Description |
+ +======+==========+======================================+
+ | id | yes | The id of the origin to delete. |
+ +------+----------+--------------------------------------+
+
+ **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": "origin was deleted"
+ }
+ ]
+ }
+
+|
+
diff --git a/docs/latest/_sources/basics/cache_revalidation.rst.txt b/docs/latest/_sources/basics/cache_revalidation.rst.txt
new file mode 100644
index 0000000..dc57346
--- /dev/null
+++ b/docs/latest/_sources/basics/cache_revalidation.rst.txt
@@ -0,0 +1,71 @@
+..
+..
+.. 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.
+..
+
+.. index::
+ Cache Control Header
+ Revalidation
+ HTTP 304
+
+Cache Control Headers and Revalidation
+======================================
+The `HTTP/1.1 spec <https://www.ietf.org/rfc/rfc2616.txt>`_ allows for origin servers and clients to influence how caches treat their requests and responses. By default, the Traffic Control CDN will honor cache control headers. Most commonly, origin servers will tell the downstream caches how long a response can be cached::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Cache-Control: max-age=86400
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+ <html><body>This is a fun file</body></html>
+
+In the above response, the origin server tells downstream caching systems that the maximum time to cache this response for is 86400 seconds. The origin can also add a ``Expires:`` header, explicitly telling the cache the time this response is to be expired. When a response is expired it usually doesn't get deleted from the cache, but, when a request comes in that would have hit on this response if it was not expired, the cache *revalidates* the response. In stead of requesting the object again from the origin server, the cache will send a request to the origin indicating what version of the response it has, and asking if it has changed. If it changed, the server will send a ``200 OK`` response, with the new data. If it has not changed, the origin server will send back a ``304 Not Modified`` response indicating the response is still valid, and that the cache can reset the timer on the response expiration. To indicate what version the client (cache) has it will add an ``If-Not-Modified-Since:`` header, or an ``If-None-Match:`` header. For example, in the ``If-None-Match:`` case, the origin will send and ``ETag`` header that uniquely identifies the response. The client can use that in an revalidation request like::
+
+ GET /foo/bar/fun.html HTTP/1.1
+ If-None-Match: "1aa008f-2d-50a3559482cc0"
+ Host: www.origin.com
+
+If the content has changed (meaning, the new response would not have had the same ETag) it will respond with ``200 OK``, like::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 18 Dec 2014 3:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50aa00feadd"
+ Cache-Control: max-age=604800
+ Content-Length: 49
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+ <html><body>This is NOT a fun file</body></html>
+
+
+If the Content did not change (meaning, the response would have had the same ETag) it will respond with ``304 Not Modified``, like::
+
+ 304 Not Modified
+ Date: Sun, 18 Dec 2014 3:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Cache-Control: max-age=604800
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+Note that the 304 response only has headers, not the data.
+
\ No newline at end of file
diff --git a/docs/latest/_sources/basics/caching_proxies.rst.txt b/docs/latest/_sources/basics/caching_proxies.rst.txt
new file mode 100644
index 0000000..af93730
--- /dev/null
+++ b/docs/latest/_sources/basics/caching_proxies.rst.txt
@@ -0,0 +1,238 @@
+..
+..
+.. 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.
+..
+
+
+.. |arrow| image:: fwda.png
+
+.. _rl-caching_proxy:
+
+Caching Proxies
+===============
+The main function of a CDN is to proxy requests from clients to origin servers
+and cache the results.
+To proxy, in the CDN context, is to obtain content using HTTP from an origin
+server on behalf of a client. To cache is to store the results so they can be
+reused when other clients are requesting the same content. There are three
+types of proxies in use on the Internet today which are described below.
+
+.. index::
+ Reverse Proxy
+
+.. _rl-rev-proxy:
+
+|arrow| Reverse Proxy
+---------------------
+ A reverse proxy acts on behalf of the origin server. The client is mostly unaware it is communicating with a proxy and not the actual origin.
+ All EDGE caches in a Traffic Control CDN are reverse proxies.
+ To the end user a Traffic Control based CDN appears as a reverse proxy since
+ it retrieves content from the origin server, acting on behalf of that origin server. The client requests a URL that has
+ a hostname which resolves to the reverse proxy's IP address and, in compliance
+ with the HTTP 1.1 specification, the client sends a ``Host:`` header to the reverse
+ proxy that matches the hostname in the URL.
+ The proxy looks up this hostname in a
+ list of mappings to find the origin hostname; if the hostname of the Host header is not found in the list,
+ the proxy will send an error (``404 Not Found``) to the client.
+ If the supplied hostname is found in this list of mappings, the proxy checks the cache, and when the content is not already present, connects to the
+ origin the requested ``Host:`` maps to and requests the path of the original URL, providing the origin hostname in the ``Host`` header. The proxy then stores the URL in cache and serves the contents to the client. When there are subsequent requests for
+ the same URL, a caching proxy serves the content out of cache thereby reducing
+ latency and network traffic.
+
+.. seealso:: `ATS documentation on reverse proxy <https://docs.trafficserver.apache.org/en/latest/admin/reverse-proxy-http-redirects.en.html#http-reverse-proxy>`_.
+
+To insert a reverse proxy into the previous HTTP 1.1 example, the reverse proxy requires provisioning
+for ``www.origin.com``. By adding a remap rule to the cache, the reverse proxy then maps requests to
+this origin. The content owner must inform the clients, by updating the URL, to receive the content
+from the cache and not from the origin server directly. For this example, the remap rule on the
+cache is: ``http://www-origin-cache.cdn.com http://www.origin.com``.
+
+.. Note:: In the previous example minimal headers were shown on both the request and response. In the examples that follow, the origin server response is more realistic.
+
+::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+ <html><body>This is a fun file</body></html>
+
+The client is given the URL ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` (note the different hostname) and when attempting to obtain that URL, the following occurs:
+
+1. The client sends a request to the LDNS server to resolve the name ``www-origin-cache.cdn.com`` to an IPv4 address.
+
+2. Similar to the previous case, the LDNS server resolves the name ``www-origin-cache.cdn.com`` to an IPv4 address, in this example, this address is 55.44.33.22.
+
+3. The client opens a TCP connection from a random port locally, to port 80 (the HTTP default) on 55.44.33.22, and sends the following: ::
+
+ GET /foo/bar/fun.html HTTP/1.1
+ Host: www-origin-cache.cdn.com
+
+4. The reverse proxy looks up ``www-origin-cache.cdn.com`` in its remap rules, and finds the origin is ``www.origin.com``.
+
+5. The proxy checks its cache to see if the response for ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` is already in the cache.
+
+6a. If the response is not in the cache:
+
+ 1. The proxy uses DNS to get the IPv4 address for ``www.origin.com``, connect to it on port 80, and sends: ::
+
+ GET /foo/bar/fun.html HTTP/1.1
+ Host: www.origin.com
+
+ 2. The origin server responds with the headers and content as shown: ::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+ <html><body>This is a fun file</body></html>
+
+ 3. The proxy sends the origin response on to the client adding a ``Via:`` header (and maybe others): ::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+ Age: 0
+ Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+ Server: ATS/4.2.1
+
+ <html><body>This is a fun file</body></html>
+
+6b. If it *is* in the cache:
+
+ The proxy responds to the client with the previously retrieved result: ::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+ Age: 39711
+ Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+ Server: ATS/4.2.1
+
+ <html><body>This is a fun file</body></html>
+
+
+.. index::
+ Forward Proxy
+
+.. _rl-fwd-proxy:
+
+|arrow| Forward Proxy
+---------------------
+ A forward proxy acts on behalf of the client. The origin server is mostly
+ unaware of the proxy, the client requests the proxy to retrieve content from a
+ particular origin server. All MID caches in a Traffic Control based CDN are
+ forward proxies. In a forward proxy scenario, the client is explicitely configured to use the
+ the proxy's IP address and port as a forward proxy. The client always connects to the forward
+ proxy for content. The content provider does not have to change the URL the
+ client obtains, and is unaware of the proxy in the middle.
+
+.. seealso:: `ATS documentation on forward proxy <https://docs.trafficserver.apache.org/en/latest/admin/forward-proxy.en.html>`_.
+
+Below is an example of the client retrieving the URL ``http://www.origin.com/foo/bar/fun.html`` through a forward proxy:
+
+1. The client requires configuration to use the proxy, as opposed to the reverse proxy example. Assume the client configuration is through preferences entries or other to use the proxy IP address 99.88.77.66 and proxy port 8080.
+
+2. To retrieve ``http://www.origin.com/foo/bar/fun.html`` URL, the client connects to 99.88.77.66 on port 8080 and sends:
+
+ ::
+
+ GET http://www.origin.com/foo/bar/fun.html HTTP/1.1
+
+
+ .. Note:: In this case, the client places the entire URL after GET, including protocol and hostname (``http://www.origin.com``), but in the reverse proxy and direct-to-origin case it puts only the path portion of the URL (``/foo/bar/fun.html``) after the GET.
+
+3. The proxy verifies whether the response for ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` is already in the cache.
+
+4a. If it is not in the cache:
+
+ 1. The proxy uses DNS to obtain the IPv4 address for ``www.origin.com``, connects to it on port 80, and sends: ::
+
+
+ GET /foo/bar/fun.html HTTP/1.1
+ Host: www.origin.com
+
+
+ 2. The origin server responds with the headers and content as shown below: ::
+
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+ <html><body>This is a fun file</body></html>
+
+
+ 3. The proxy sends this on to the client adding a ``Via:`` header (and maybe others): ::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+ Age: 0
+ Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+ Server: ATS/4.2.1
+
+ <html><body>This is a fun file</body></html>
+
+
+4b. If it *is* in the cache:
+
+ The proxy responds to the client with the previously retrieved result: ::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+ Age: 99711
+ Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+ Server: ATS/4.2.1
+
+ <html><body>This is a fun file</body></html>
+
+.. index::
+ Transparent Proxy
+
+|arrow| Transparent Proxy
+-------------------------
+ Neither the origin nor the client are aware of the actions performed by the transparent proxies. A Traffic Control based CDN does not use transparent proxies. If you are interested you can learn more about transparent proxies on `wikipedia <http://en.wikipedia.org/wiki/Proxy_server#Transparent_proxy>`_.
+
diff --git a/docs/latest/_sources/basics/content_delivery_networks.rst.txt b/docs/latest/_sources/basics/content_delivery_networks.rst.txt
new file mode 100644
index 0000000..872018e
--- /dev/null
+++ b/docs/latest/_sources/basics/content_delivery_networks.rst.txt
@@ -0,0 +1,40 @@
+..
+..
+.. 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.
+..
+
+.. index::
+ Log File Analysis
+ CDN
+ Content Delivery Network
+
+Content Delivery Networks
+=========================
+The vast majority of today's Internet traffic is media files (often video or audio) being sent from a single source (the *Content Provider*) to many thousands or even millions of destinations (the *Content Consumers*). Content Delivery Networks are the technology that make that one-to-many distribution possible in an economical way. A Content Delivery Network (CDN) is a distributed system of servers for delivering content over HTTP. These servers are deployed in multiple locations with the goal of optimizing the delivery of content to the end users, while minimizing the traffic on the network. A CDN typically consists of the following:
+
+* **Caching Proxies**
+ The proxy (cache or caching proxy) is a server that both proxies the requests and caches the results for reusing.
+
+* **Content Router**
+ The Content Router ensures that the end user is connected to the optimal cache for the location of the end user and content availability.
+
+* **Health Protocol**
+ The Health Protocol monitors the usage of the caches and tenants in the CDN.
+
+* **Configuration Management System**
+ In many cases a CDN encompasses hundreds of servers across a large geographic area. The Configuration Management System allows an operator to manage these servers.
+
+* **Log File Analysis System**
+ Every transaction in the CDN gets logged. The Log File Analysis System aggregates all of the log entries from all of the servers to a central location for analysis and troubleshooting.
+
+
diff --git a/docs/latest/_sources/basics/http_11.rst.txt b/docs/latest/_sources/basics/http_11.rst.txt
new file mode 100644
index 0000000..65d6d71
--- /dev/null
+++ b/docs/latest/_sources/basics/http_11.rst.txt
@@ -0,0 +1,48 @@
+..
+..
+.. 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.
+..
+
+.. index::
+ http/1.1
+ HTTP
+
+HTTP 1.1
+========
+For a comprehensive look at Traffic Control, it is important to understand basic HTTP 1.1 protocol operations and how caches function. The example below illustrates the fulfillment of an HTTP 1.1 request in a situation without CDN or proxy, followed by viewing the changes after inserting different types of (caching) proxies. Several of the examples below are simplified for clarification of the essentials.
+
+For complete details on HTTP 1.1 see `RFC 2616 - Hypertext Transfer Protocol -- HTTP/1.1 <https://www.ietf.org/rfc/rfc2616.txt>`_.
+
+Below are the steps of a client retrieving the URL ``http://www.origin.com/foo/bar/fun.html`` using HTTP/1.1 without proxies:
+
+1. The client sends a request to the Local DNS (LDNS) server to resolve the name ``www.origin.com`` to an IPv4 address.
+
+2. If the LDNS does not have this name (IPv4 mapping cached), it sends DNS requests to the ., .com, and .origin.com authoritative servers until it receives a response with the address for ``www.origin.com``. Per the DNS SPEC, this response has a Time To Live (TTL), which indicates how long this mapping can be cached at the LDNS server. In the example, the IP address found by the LDNS server for www.origin.com is 44.33.22.11.
+
+ .. Note:: While longer DNS TTLs of a day (86400 seconds) or more are quite common in other use cases, in CDN use cases DNS TTLs are often below a minute.
+
+3. The client opens a TCP connection from a random port locally to port 80 (the HTTP default) on 44.33.22.11, and sends this (showing the minimum HTTP 1.1 request, typically there are additional headers): ::
+
+ GET /foo/bar/fun.html HTTP/1.1
+ Host: www.origin.com
+
+4. The server at ``www.origin.com`` looks up the Host: header to match that to a configuration section, usually referred to as a virtual host section. If the Host: header and configuration section match, the search continues for the content of the path ``/foo/bar/fun.html``, in the example, this is a file that contains ``<html><body>This is a fun file</body></html>``, so the server responds with the following: ::
+
+
+ HTTP/1.1 200 OK
+ Content-Type: text/html; charset=UTF-8
+ Content-Length: 45
+
+ <html><body>This is a fun file</body></html>
+
+ At this point, HTTP transaction is complete.
diff --git a/docs/latest/_sources/basics/index.rst.txt b/docs/latest/_sources/basics/index.rst.txt
new file mode 100644
index 0000000..23ee1da
--- /dev/null
+++ b/docs/latest/_sources/basics/index.rst.txt
@@ -0,0 +1,29 @@
+..
+..
+.. 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.
+..
+
+CDN Basics
+**********
+
+Traffic Control is a CDN control plane, see the topics below to familiarize yourself with the basic concepts of a CDN.
+
+.. toctree::
+ :maxdepth: 2
+
+ content_delivery_networks
+ http_11
+ caching_proxies
+ cache_revalidation
+
+
diff --git a/docs/latest/_sources/development/building.rst.txt b/docs/latest/_sources/development/building.rst.txt
new file mode 100644
index 0000000..87e68e9
--- /dev/null
+++ b/docs/latest/_sources/development/building.rst.txt
@@ -0,0 +1,94 @@
+..
+..
+.. 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.
+..
+
+.. _dev-building:
+
+Building Traffic Control
+========================
+
+
+Build using pkg
+---------------
+
+This is the easiest way to build all the components of Traffic Control;
+all requirements are automatically loaded into the image used to build
+each component.
+
+Requirements
+~~~~~~~~~~~~
+
+- ``docker`` (https://docs.docker.com/engine/installation/)
+- ``docker-compose`` (https://docs.docker.com/compose/install/)
+ (optional, but recommended)
+
+If ``docker-compose`` is not available, the ``pkg`` script will
+automatically download and run it in a container. This is noticeably
+slower than running it natively.
+
+Usage
+~~~~~
+
+::
+
+ $ ./pkg -?
+ Usage: ./pkg [options] [projects]
+ -q Quiet mode. Supresses output.
+ -v Verbose mode. Lists all build output.
+ -l List available projects.
+
+ If no projects are listed, all projects will be packaged.
+ Valid projects:
+ - traffic_portal_build
+ - traffic_router_build
+ - traffic_monitor_build
+ - source
+ - traffic_ops_build
+ - traffic_stats_build
+
+
+If any project names are provided on the command line, only those will be built.
+Otherwise, all projects are built.
+
+All artifacts (rpms, logs, source tar ball) are copied to ``dist`` at the top level of the
+``incubator-trafficcontrol`` directory.
+
+Example
+~~~~~~~
+
+::
+
+ $ ./pkg -v source traffic_ops_build
+ Building source.
+ Building traffic_ops_build.
+
+Build using docker-compose
+--------------------------
+
+If the ``pkg`` script fails, ``docker-compose`` can still be used directly.
+
+Usage
+~~~~~
+
+::
+
+ $ docker-compose -f ./infrastructure/docker/build/docker-compose.yml down -v
+ $ docker-compose -f ./infrastructure/docker/build/docker-compose.yml up --build source traffic_ops_build
+ $ ls -1 dist/
+ build-traffic_ops.log
+ traffic_ops-2.1.0-6396.07033d6d.el7.src.rpm
+ traffic_ops-2.1.0-6396.07033d6d.el7.x86_64.rpm
+ traffic_ops_ort-2.1.0-6396.07033d6d.el7.src.rpm
+ traffic_ops_ort-2.1.0-6396.07033d6d.el7.x86_64.rpm
+ trafficcontrol-incubating-2.1.0.tar.gz
diff --git a/docs/latest/_sources/development/index.rst.txt b/docs/latest/_sources/development/index.rst.txt
new file mode 100644
index 0000000..5c659fb
--- /dev/null
+++ b/docs/latest/_sources/development/index.rst.txt
@@ -0,0 +1,29 @@
+..
+..
+.. 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.
+..
+
+Developer's Guide
+*****************
+Use this guide to start developing applications that consume the Traffic Control APIs, to create extensions to Traffic Ops, or work on Traffic Control itself.
+
+.. toctree::
+ :maxdepth: 2
+
+ building
+ traffic_ops
+ traffic_portal
+ traffic_router
+ traffic_monitor
+ traffic_stats
+
diff --git a/docs/latest/_sources/development/traffic_monitor.rst.txt b/docs/latest/_sources/development/traffic_monitor.rst.txt
new file mode 100644
index 0000000..552500c
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_monitor.rst.txt
@@ -0,0 +1,301 @@
+..
+..
+.. 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.
+..
+
+Traffic Monitor Golang
+**********************
+Introduction
+============
+Traffic Monitor is an HTTP service application that monitors caches, provides health state information to Traffic Router, and collects statistics for use in tools such as Traffic Ops and Traffic Stats. The health state provided by Traffic Monitor is used by Traffic Router to control which caches are available on the CDN.
+
+Software Requirements
+=====================
+To work on Traffic Monitor you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+* Golang
+
+Project Tree Overview
+=====================================
+
+* ``traffic_control/traffic_monitor/`` - base directory for Traffic Monitor.
+
+* ``cache/`` - Handler for processing cache results.
+* ``config/`` - Application configuration; in-memory objects from ``traffic_monitor.cfg``.
+* ``crconfig/`` - struct for deserlializing the CRConfig from JSON.
+* ``deliveryservice/`` - aggregates delivery service data from cache results.
+* ``deliveryservicedata/`` - deliveryservice structs. This exists separate from ``deliveryservice`` to avoid circular dependencies.
+* ``enum/`` - enumerations and name alias types.
+* ``health/`` - functions for calculating cache health, and creating health event objects.
+* ``manager/`` - manager goroutines (microthreads).
+ * ``health.go`` - Health request manager. Processes health results, from the health poller -> fetcher -> manager. The health poll is the "heartbeat" containing a small amount of stats, primarily to determine whether a cache is reachable as quickly as possible. Data is aggregated and inserted into shared threadsafe objects.
+ * ``manager.go`` - Contains ``Start`` function to start all pollers, handlers, and managers.
+ * ``monitorconfig.go`` - Monitor config manager. Gets data from the monitor config poller, which polls Traffic Ops for changes to which caches are monitored and how.
+ * ``opsconfig.go`` - Ops config manager. Gets data from the ops config poller, which polls Traffic Ops for changes to monitoring settings.
+ * ``peer.go`` - Peer manager. Gets data from the peer poller -> fetcher -> handler and aggregates it into the shared threadsafe objects.
+ * ``stat.go`` - Stat request manager. Processes stat results, from the stat poller -> fetcher -> manager. The stat poll is the large statistics poll, containing all stats (such as HTTP codes, transactions, delivery service statistics, and more). Data is aggregated and inserted into shared threadsafe objects.
+ * ``statecombiner.go`` - Manager for combining local and peer states, into a single combined states threadsafe object, for serving the CrStates endpoint.
+* ``datareq/`` - HTTP routing, which has threadsafe health and stat objects populated by stat and health managers.
+* ``peer/`` - Manager for getting and populating peer data from other Traffic Monitors
+* ``srvhttp/`` - HTTP service. Given a map of endpoint functions, which are lambda closures containing aggregated data objects.
+* ``static/`` - Web GUI HTML and javascript files
+* ``threadsafe/`` - Threadsafe objects for storing aggregated data needed by multiple goroutines (typically the aggregator and HTTP server)
+* ``trafficopsdata/`` - Struct for fetching and storing Traffic Ops data needed from the CRConfig. This is primarily mappings, such as delivery service servers, and server types.
+* ``trafficopswrapper/`` - Threadsafe wrapper around the Traffic Ops client. The client used to not be threadsafe, however, it mostly (possibly entirely) is now. But, the wrapper also serves to overwrite the Traffic Ops ``monitoring.json`` values, which are live, with snapshotted CRConfig values.
+
+Architecture
+============
+At the highest level, Traffic Monitor polls caches, aggregates their data and availability, and serves it at HTTP JSON endpoints.
+
+In the code, the data flows thru microthread (goroutine) pipelines. All stages of the pipeline are independent running microthreads [#f1]_ . The pipelines are:
+
+* **stat poll** - polls caches for all statistics data. This should be a slower poll, which gets a lot of data.
+* **health poll** - polls caches for a tiny amount of data, typically system information. This poll is designed to be a heartbeat, determining quickly whether the cache is reachable. Since it's a small amount of data, it should poll more frequently.
+* **peer poll** - polls Traffic Monitor peers for their availability data, and aggregates it with its own availability results and that of all other peers.
+* **monitor config** - polls Traffic Ops for the list of Traffic Monitors and their info.
+* **ops config** - polls for changes to the ops config file ``traffic_ops.cfg``, and sends updates to other pollers when the config file has changed.
+
+ * The ops config manager also updates the shared Traffic Ops client, since it's the actor which becomes notified of config changes requiring a new client.
+
+ * The ops config manager also manages, creates, and recreates the HTTP server, since ops config changes necessitate restarting the HTTP server.
+
+All microthreads in the pipeline are started by ``manager/manager.go:Start()``.
+
+::
+
+ -------------------- -------------------- --------------------
+ | ops config poller |-->| ops config handler |-->| ops config manager |-->-restart HTTP server-------------------------
+ ------------------- -------------------- -------------------- | |
+ -->-ops config change subscriber------------- |
+ | | |
+ -->-Traffic Ops client change subscriber-- | |
+ | | |
+ ------------------------------------------------------------------------------------------------------------- | |
+ | | |
+ | ------------------------------------------------------------------------------------------------------------ |
+ | | |
+ \/ \/ |
+ ----------------------- ------------------------ |
+ | monitor config poller |-->| monitor config manager |-->-stat subscriber-------- -----------------------
+ ----------------------- ------------------------ | | |
+ |->-health subscriber--- | \/ _
+ | | | ------------- _( )._
+ -->-peer subscriber-- | | | HTTP server |->-HTTP request-> (____)_)
+ | | | -------------
+ ----------------------------------------------------------------------------- | | ^
+ | | | |
+ | ----------------------------------------------------------------------------- | ------------------------
+ | | | |
+ | | ----------------------------------------------------------------------------- |
+ | | | ^
+ | | | ------------- -------------- -------------- -------------- -----------------------
+ | | -->| stat poller |-->| stat fetcher |-->| stat handler |-->| stat manager |->--------set shared data->| shared data |
+ | | ------------- | -------------- -------------- | -------------- -----------------------
+ | | | -------------- -------------- | | events |
+ | | |->| stat fetcher |-->| stat handler |-| | toData |
+ | | | -------------- -------------- | | errorCount |
+ | | ... ... | healthIteration |
+ | | | fetchCount |
+ | | --------------- ---------------- ---------------- ---------------- | localStates |
+ | ---->| health poller |-->| health fetcher |-->| health handler |-->| health manager |->-set shared data->| toSession |
+ | --------------- | ---------------- ---------------- | ---------------- | peerStates |
+ | | ---------------- ---------------- | | monitorConfig |
+ | |->| health fetcher |-->| health handler |-| | combinedStates |
+ | | ---------------- ---------------- | | statInfoHistory |
+ | ... ... | statResultHistory |
+ | | statMaxKbpses |
+ | ------------- -------------- -------------- -------------- | lastKbpsStats |
+ ------>| peer poller |-->| peer fetcher |-->| peer handler |-->| peer manager |->----------set shared data->| dsStats |
+ ------------- | -------------- -------------- | -------------- | localCacheStatus |
+ | -------------- -------------- | | lastHealthDurations |
+ |->| peer fetcher |-->| peer handler |-| | healthHistory |
+ | -------------- -------------- | -----------------------
+ ... ...
+
+.. [#f1] Technically, some stages which are one-to-one simply call the next stage as a function. For example, the Fetcher calls the Handler as a function in the same microthread. But this isn't architecturally significant.
+
+
+Stat Pipeline
+-------------
+
+::
+
+ --------- --------- --------- ---------
+ | poller |-->| fetcher |-->| handler |-->| manager |
+ -------- | --------- --------- | ---------
+ | --------- --------- |
+ |->| fetcher |-->| handler |-|
+ | --------- --------- |
+ ... ...
+
+* **poller** - ``common/poller/poller.go:HttpPoller.Poll()``. Listens for config changes (from the ops config manager), and starts its own internal microthreads, one for each cache to poll. These internal microthreads call the Fetcher at each cache's poll interval.
+
+* **fetcher** - ``common/fetcher/fetcher.go:HttpFetcher.Fetch()``. Fetches the given URL, and passes the returned data to the Handler, along with any errors.
+
+
+* **handler** - ``traffic_monitor/cache/cache.go:Handler.Handle()``. Takes the given result and does all data computation possible with the single result. Currently, this computation primarily involves processing the denormalized ATS data into Go structs, and processing System data into OutBytes, Kbps, etc. Precomputed data is then passed to its result channel, which is picked up by the Manager.
+
+* **manager** - ``traffic_monitor/manager/stat.go:StartStatHistoryManager()``. Takes preprocessed results, and aggregates them. Aggregated results are then placed in shared data structures. The major data aggregated are delivery service statistics, and cache availability data. See :ref:`Aggregated Stat Data <agg-stat-data>` and :ref:`Aggregated Availability Data <agg-avail-data>`.
+
+
+Health Pipeline
+---------------
+
+::
+
+ --------- --------- --------- ---------
+ | poller |-->| fetcher |-->| handler |-->| manager |
+ -------- | --------- --------- | ---------
+ | --------- --------- |
+ |->| fetcher |-->| handler |-|
+ | --------- --------- |
+ ... ...
+
+* **poller** - ``common/poller/poller.go:HttpPoller.Poll()``. Same poller type as the Stat Poller pipeline, with a different handler object.
+
+* **fetcher** - ``common/fetcher/fetcher.go:HttpFetcher.Fetch()``. Same fetcher type as the Stat Poller pipeline, with a different handler object.
+
+* **handler** - ``traffic_monitor/cache/cache.go:Handler.Handle()``. Same handler type as the Stat Poller pipeline, but constructed with a flag to not precompute. The health endpoint is of the same form as the stat endpoint, but doesn't return all stat data. So, it doesn't precompute like the Stat Handler, but only processes the system data, and passes the processed result to its result channel, which is picked up by the Manager.
+
+* **manager** - ``traffic_monitor/manager/health.go:StartHealthResultManager()``. Takes preprocessed results, and aggregates them. For the Health pipeline, only health availability data is aggregated. Aggregated results are then placed in shared data structures (lastHealthDurationsThreadsafe, lastHealthEndTimes, etc). See :ref:`Aggregated Availability Data <agg-avail-data>`.
+
+
+Peer Pipeline
+-------------
+
+::
+
+ --------- --------- --------- ---------
+ | poller |-->| fetcher |-->| handler |-->| manager |
+ -------- | --------- --------- | ---------
+ | --------- --------- |
+ |->| fetcher |-->| handler |-|
+ | --------- --------- |
+ ... ...
+
+* **poller** - ``common/poller/poller.go:HttpPoller.Poll()``. Same poller type as the Stat and Health Poller pipelines, with a different handler object. Its config changes come from the Monitor Config Manager, and it starts an internal microthread for each peer to poll.
+
+* **fetcher** - ``common/fetcher/fetcher.go:HttpFetcher.Fetch()``. Same fetcher type as the Stat and Health Poller pipeline, with a different handler object.
+
+* **handler** - ``traffic_monitor/cache/peer.go:Handler.Handle()``. Decodes the JSON result into an object, and without further processing passes to its result channel, which is picked up by the Manager.
+
+* **manager** - ``traffic_monitor/manager/peer.go:StartPeerManager()``. Takes JSON peer Traffic Monitor results, and aggregates them. The availability of the Peer Traffic Monitor itself, as well as all cache availability from the given peer result, is stored in the shared ``peerStates`` object. Results are then aggregated via a call to the ``combineState()`` lambda, which signals the State Combiner microthread (which stores the combined availability in the shared object ``combinedStates``; See :ref:`State Combiner <state-combiner>`).
+
+
+Monitor Config Pipeline
+-----------------------
+
+::
+
+ --------- ---------
+ | poller |-->| manager |--> stat subscriber (Stat pipeline Poller)
+ -------- --------- |
+ |-> health subscriber (Health pipeline Poller)
+ |
+ --> peer subscriber (Peer pipeline Poller)
+
+* **poller** - ``common/poller/poller.go:MonitorConfigPoller.Poll()``. The Monitor Config poller, on its interval, polls Traffic Ops for the Monitor configuration, and writes the polled value to its result channel, which is read by the Manager.
+
+* **manager** - ``traffic_monitor/manager/monitorconfig.go:StartMonitorConfigManager()``. Listens for results from the poller, and processes them. Cache changes are written to channels read by the Health, Stat, and Peer pollers. In the Shared Data objects, this also sets the list of new delivery services and removes ones which no longer exist, and sets the list of peer Traffic Monitors.
+
+
+Ops Config Pipeline
+-------------------
+::
+
+ --------- --------- ---------
+ | poller |-->| handler |-->| manager |--> ops config change subscriber (Monitor Config Poller)
+ -------- --------- --------- |
+ --> Traffic ops client change subscriber (Monitor Config Poller)
+
+* **poller** - ``common/poller/poller.go:FilePoller.Poll()``. Polls for changes to the Traffic Ops config file ``traffic_ops.cfg``, and writes the changed config to its result channel, which is read by the Handler.
+
+* **handler** - ``common/handler/handler.go:OpsConfigFileHandler.Listen()``. Takes the given raw config, unmarshalls the JSON into an object, and writes the object to its channel, which is read by the Manager, along with any error.
+
+* **manager** - ``traffic_monitor/manager/monitorconfig.go:StartMonitorConfigManager()``. Listens for new configs, and processes them. When a new config is received, a new HTTP dispatch map is created via ``traffic_monitor/datareq/datareq.go:MakeDispatchMap()``, and the HTTP server is restarted with the new dispatch map. The Traffic Ops client is also recreated, and stored in its shared data object. The Ops Config change subscribers and Traffic Ops Client change subscribers (the Monitor Config poller) are also passed the new ops config and new Traffic Ops client.
+
+
+Events
+------
+The ``events`` shared data object is passed to each pipeline microthread which needs to signal events. Most of them do. Events are then logged, and visible in the UI as well as an HTTP JSON endpoint. Most events are caches becoming available or unavailable, but include other things such as peer availability changes.
+
+
+.. _state-combiner:
+
+State Combiner
+--------------
+The State Combiner is a microthread started in ``traffic_monitor/manager/manager.go:Start()`` via ``traffic_monitor/manager/statecombiner.go:StartStateCombiner()``, which listens for signals to combine states. It should be signaled by any pipeline which updates the local or peer availability shared data objects, ``localStates`` and ``peerStates``. It holds the threadsafe shared data objects for local states and peer states, so no data is passed or returned, only a signal.
+
+When a signal is received, it combines the local and peer states optimistically. That is, if a cache is marked available locally or by any peer, that cache is marked available in the combined states. There exists a variable to combine pessimistically, which may be set at compile time (it's unusual for a CDN to operate well with pessimistic cache availability). Combined data is stored in the threadsafe shared data object ``combinedStates``.
+
+
+.. _agg-stat-data:
+
+Aggregated Stat Data
+--------------------
+The Stat pipeline Manager is responsible for aggregating stats from all caches, into delivery services statistics. This is done via a call to ``traffic_monitor/deliveryservice/stat.go:CreateStats()``.
+
+
+.. _agg-avail-data:
+
+Aggregated Availability Data
+----------------------------
+Both the Stat and Health pipelines aggregate availability data received from caches. This is done via a call to ``traffic_monitor/deliveryservice/health.go:CalcAvailability()`` followed by a call to ``combineState()``. The ``CalcAvailability`` function calculates the availability of each cache from the result of polling it, that is, local availability. The ``combineState()`` function is a lambda passed to the Manager, which signals the State Combiner microthread, which will combine the local and peer Traffic Monitor availability data, and insert it into the shared data ``combinedStates`` object.
+
+
+HTTP Data Requests
+------------------
+Data is provided to HTTP requests via the threadsafe shared data objects (see :ref:`Shared Data <shared-data>`). These objects are closed in lambdas created via ``traffic_monitor/datareq/datareq.go:MakeDispatchMap()``. This is called by the Ops Config Manager when it recreates the HTTP server.
+
+Each HTTP endpoint is mapped to a function which closes around the shared data objects it needs, and takes the request data it needs (such as query parameters). Each endpoint function resides in its own file in ``traffic_monitor/datareq/``. Because each Go HTTP routing function must be a ``http.HandlerFunc``, wrapper functions take the endpoint functions and return ``http.HandlerFunc`` functions which call them, and which are stored in the dispatch map, to be registered with the HTTP server.
+
+
+.. _shared-data:
+
+Shared Data
+-----------
+Processed and aggregated data must be shared between the end of the stat and health processing pipelines, and HTTP requests. The CSP paradigm of idiomatic Go does not work efficiently with storing and sharing state. While not idiomatic Go, shared mutexed data structures are faster and simpler than CSP manager microthreads for each data object.
+
+Traffic Monitor has many threadsafe shared data types and objects. All shared data objects can be seen in ``manager/manager.go:Start()``, where they are created and passed to the various pipeline stage microthreads that need them. Their respective types all include the word ``Threadsafe``, and can be found in ``traffic_monitor/threadsafe/`` as well as, for dependency reasons, various appropriate directories.
+
+Currently, all Threadsafe shared data types use mutexes. In the future, these could be changed to lock-free or wait-free structures, if the performance needs outweighed the readability and correctness costs. They could also easily be changed to internally be manager microthreads and channels, if being idiomatic were deemed more important than readability or performance.
+
+
+
+Formatting Conventions
+======================
+Go code should be formatted with ``gofmt``. See also ``CONTRIBUTING.md``.
+
+Installing The Developer Environment
+====================================
+To install the Traffic Monitor Developer environment:
+
+1. Install `go` version 1.7 or greater, from https://golang.org/doc/install and https://golang.org/doc/code.html
+2. Clone the traffic_control repository using Git, into ``$GOPATH/src/github.com/apache/incubator-trafficcontrol``
+3. Change directories into ``$GOPATH/src/github.com/apache/incubator-trafficcontrol/traffic_monitor_golang/traffic_monitor``
+4. Run ``./build.sh``
+
+Test Cases
+==========
+Tests can be executed by running ``go test ./...`` at the root of the ``traffic_monitor_golang`` project.
+
+API
+===
+
+:ref:`reference-tm-api`
+
+.. toctree::
+ :hidden:
+ :maxdepth: 1
+
+ traffic_monitor/traffic_monitor_api
diff --git a/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.rst.txt b/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.rst.txt
new file mode 100644
index 0000000..0240fd4
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.rst.txt
@@ -0,0 +1,178 @@
+..
+..
+.. 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.
+..
+
+.. _reference-tm-api:
+
+Traffic Monitor APIs
+====================
+The Traffic Monitor URLs below allow certain query parameters for use in controlling the data returned. The optional query parameters are the *tabbed* in values under each URL, if they exist.
+
+|
+
+**/publish/EventLog**
+
+Log of recent events.
+
+|
+
+**/publish/CacheStats**
+
+Statistics gathered for each cache.
+
+**Query Parameters**
+
++--------------+---------+------------------------------------------------+
+| Parameter | Type | Description |
++==============+=========+================================================+
+| ``hc`` | int | The history count, number of items to display. |
++--------------+---------+------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++--------------+---------+------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++--------------+---------+------------------------------------------------+
+
+|
+
+**/publish/CacheStats/:cache**
+
+Statistics gathered for only this cache.
+
+**Query Parameters**
+
++--------------+---------+------------------------------------------------+
+| Parameter | Type | Description |
++==============+=========+================================================+
+| ``hc`` | int | The history count, number of items to display. |
++--------------+---------+------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++--------------+---------+------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++--------------+---------+------------------------------------------------+
+
+|
+
+**/publish/DsStats**
+
+Statistics gathered for delivery services.
+
+**Query Parameters**
+
++--------------+---------+------------------------------------------------+
+| Parameter | Type | Description |
++==============+=========+================================================+
+| ``hc`` | int | The history count, number of items to display. |
++--------------+---------+------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++--------------+---------+------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++--------------+---------+------------------------------------------------+
+
+|
+
+**/publish/DsStats/:deliveryService**
+
+Statistics gathered for this delivery service only.
+
+**Query Parameters**
+
++--------------+---------+------------------------------------------------+
+| Parameter | Type | Description |
++==============+=========+================================================+
+| ``hc`` | int | The history count, number of items to display. |
++--------------+---------+------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++--------------+---------+------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++--------------+---------+------------------------------------------------+
+
+|
+
+**/publish/CrStates**
+
+The current state of this CDN per the health protocol.
+
+|
+
+**raw**
+
+The current state of this CDN per this Traffic Monitor only.
+
+|
+
+**/publish/CrConfig**
+
+The CrConfig served to and consumed by Traffic Router.
+
+|
+
+**/publish/PeerStates**
+
+The health state information from all peer Traffic Monitors.
+
+**Query Parameters**
+
++--------------+---------+------------------------------------------------+
+| Parameter | Type | Description |
++==============+=========+================================================+
+| ``hc`` | int | The history count, number of items to display. |
++--------------+---------+------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++--------------+---------+------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++--------------+---------+------------------------------------------------+
+
+|
+
+**/publish/Stats**
+
+The general statistics about Traffic Monitor.
+
+|
+
+**/publish/StatSummary**
+
+The summary of cache statistics.
+
+**Query Parameters**
+
++---------------+---------+-----------------------------------------------------------+
+| Parameter | Type | Description |
++===============+=========+===========================================================+
+| ``startTime`` | number | Window start. The number of milliseconds since the epoch. |
++---------------+---------+-----------------------------------------------------------+
+| ``endTime`` | number | Window end. The number of milliseconds since the epoch. |
++---------------+---------+-----------------------------------------------------------+
+| ``hc`` | int | The history count, number of items to display. |
++---------------+---------+-----------------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++---------------+---------+-----------------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++---------------+---------+-----------------------------------------------------------+
+| ``cache`` | string | Summary statistics for just this cache. |
++---------------+---------+-----------------------------------------------------------+
+
+|
+
+**/publish/ConfigDoc**
+
+The overview of configuration options.
+
+
diff --git a/docs/latest/_sources/development/traffic_ops.rst.txt b/docs/latest/_sources/development/traffic_ops.rst.txt
new file mode 100644
index 0000000..cb43330
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops.rst.txt
@@ -0,0 +1,369 @@
+..
+..
+.. 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.
+..
+
+Traffic Ops
+***********
+
+Introduction
+============
+Traffic Ops uses a Postgres database to store the configuration information, and the `Mojolicious framework <http://mojolicio.us/>`_ to generate the user interface and REST APIs.
+
+Software Requirements
+=====================
+To work on Traffic Ops you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+* `Carton 1.0.12 <http://search.cpan.org/~miyagawa/Carton-v1.0.12/lib/Carton.pm>`_
+
+ * cpan JSON
+ * cpan JSON::PP
+
+* `Go 1.8.3 <http://golang.org/doc/install>`_
+* Perl 5.10.1
+* Git
+* Postgres 9.6.6
+* `Goose <https://bitbucket.org/liamstask/goose/>`_
+
+Addionally, the installation of the following RPMs (or equivalent) is required:
+
+* All RPMs listed in :ref:`rl-ps`
+
+Traffic Ops Project Tree Overview
+=======================================
+
+**/opt/traffic_ops/app**
+
+* bin/ - Directory for scripts, cronjobs, etc
+
+* conf/
+
+ * /development - Development (local) specific config files.
+ * /misc - Miscellaneous config files.
+ * /production - Production specific config files.
+ * /test - Test (unit test) specific config files.
+
+* db/ - Database related area.
+
+ * /migrations - Database Migration files.
+
+* lib/
+
+ * /API - Mojo Controllers for the /API area of the application.
+ * /Common - Common Code between both the API and UI areas.
+ * /Extensions
+ * Fixtures/ - Test Case fixture data for the 'to_test' database.
+ * /Integration - Integration Tests.
+ * /MojoPlugins - Mojolicious Plugins for Common Controller Code.
+ * Schema/ - Database Schema area.
+ * /Result - DBIx ORM related files.
+ * /Test - Common Test.
+ * /UI - Mojo Controllers for the Traffic Ops UI itself.
+ * Utils/
+ * /Helper - Common utilities for the Traffic Ops application.
+
+* log/ - Log directory where the development and test files are written by the app.
+
+* public/
+
+ * css/ - Stylesheets.
+ * images/ - Images.
+ * js/ - Javascripts
+
+* script/ - Mojo Bootstrap scripts.
+
+* t/ - Unit Tests for the UI.
+
+ * api/ - Unit Tests for the API.
+
+* t_integration/ - High level tests for Integration level testing.
+
+* templates/ - Mojo Embedded Perl (.ep) files for the UI.
+
+
+
+Perl Formatting Conventions
+===========================
+Perl tidy is for use in code formatting. See the following config file for formatting conventions.
+
+::
+
+
+ edit a file called $HOME/.perltidyrc
+
+ -l=156
+ -et=4
+ -t
+ -ci=4
+ -st
+ -se
+ -vt=0
+ -cti=0
+ -pt=1
+ -bt=1
+ -sbt=1
+ -bbt=1
+ -nsfs
+ -nolq
+ -otr
+ -aws
+ -wls="= + - / * ."
+ -wrs=\"= + - / * .\"
+ -wbb="% + - * / x != == >= <= =~ < > | & **= += *= &= <<= &&= -= /= |= + >>= ||= .= %= ^= x="
+
+
+Database Management
+===================
+.. Add db naming conventions
+
+The admin.pl script is for use in managing the Traffic Ops database tables. Below is an example of its usage.
+
+``$ db/admin.pl``
+
+Usage: db/admin.pl [--env (development|test|production)] [arguments]
+
+Example: ``db/admin.pl --env=test reset``
+
+Purpose: This script is used to manage the database. The environments are defined in the dbconf.yml, as well as the database names.
+
+* To use the ``admin.pl`` script, you may need to add ``traffic_ops/lib`` and ``traffic_ops/local/lib/perl5`` to your `PERL5LIB <http://modperlbook.org/html/3-9-2-2-Using-the-PERL5LIB-environment-variable.html>`_ environment variable.
+
++-----------+--------------------------------------------------------------------+
+| Arguments | Description |
++===========+====================================================================+
+| create | Execute db 'create' the database for the current environment. |
++-----------+--------------------------------------------------------------------+
+| down | Roll back a single migration from the current version. |
++-----------+--------------------------------------------------------------------+
+| drop | Execute db 'drop' on the database for the current environment. |
++-----------+--------------------------------------------------------------------+
+| redo | Roll back the most recently applied migration, then run it again. |
++-----------+--------------------------------------------------------------------+
+| reset | Execute db drop, create, load_schema, migrate on the database for |
+| | the current environment. |
++-----------+--------------------------------------------------------------------+
+| seed | Execute SQL from db/seeds.sql for loading static data. |
++-----------+--------------------------------------------------------------------+
+| setup | Execute db drop, create, load_schema, migrate, seed on the |
+| | database for the current environment. |
++-----------+--------------------------------------------------------------------+
+| status | Print the status of all migrations. |
++-----------+--------------------------------------------------------------------+
+| upgrade | Execute migrate then seed on the database for the current |
+| | environment. |
++-----------+--------------------------------------------------------------------+
+
+Installing The Developer Environment
+====================================
+To install the Traffic Ops Developer environment:
+
+1. Clone the traffic_control repository from `github.com <https://github.com/apache/incubator-trafficcontrol>`_.
+2. Install the local dependencies using Carton (cpanfile).
+
+ ::
+
+ $ cd traffic_ops/app
+ $ carton
+
+3. Set up a role (user) in Postgres
+
+ See Postgres instructions on initdb https://wiki.postgresql.org/wiki/First_steps
+
+
+4. Enter ``db/admin.pl --env=<enviroment name> setup`` to set up the traffic_ops database(s).
+
+ * Unit test database: ``$ db/admin.pl --env=test setup``
+ * Development database: ``$ db/admin.pl --env=development setup``
+ * Integration database: ``$ db/admin.pl --env=integration setup``
+
+ |
+
+ Running the the admin.pl script in setup mode should look like this: ::
+
+ master $ db/admin.pl --env=development setup
+ Using database.conf: conf/development/database.conf
+ Using database.conf: conf/development/database.conf
+ Using database.conf: conf/development/database.conf
+ Using database.conf: conf/development/database.conf
+ Using database.conf: conf/development/database.conf
+ Using database.conf: conf/development/database.conf
+ Executing 'drop database to_development'
+ Executing 'create database to_development'
+ Creating database tables...
+ Warning: Using a password on the command line interface can be insecure.
+ Migrating database...
+ goose: migrating db environment 'development', current version: 0, target: 20150210100000
+ OK 20141222103718_extension.sql
+ OK 20150108100000_add_job_deliveryservice.sql
+ OK 20150205100000_cg_location.sql
+ OK 20150209100000_cran_to_asn.sql
+ OK 20150210100000_ds_keyinfo.sql
+ Seeding database...
+ Warning: Using a password on the command line interface can be insecure.
+
+5. (Optional) To load temporary data into the tables: ``$ perl bin/db/setup_kabletown.pl``
+
+6. Run the postinstall script: ``traffic_ops/install/bin/postinstall``
+
+7. To start Traffic Ops, enter ``$ bin/start.pl``
+
+ The local Traffic Ops instance uses an open source framework called morbo, starting following the start command execution.
+
+ Start up success includes the following:
+
+ ::
+
+
+ [2015-02-24 10:44:34,991] [INFO] Listening at "http://*:3000".
+
+ Server available at http://127.0.0.1:3000.
+
+
+8. Using a browser, navigate to the given address: ``http://127.0.0.1:3000``
+9. For the initial log in:
+
+ * User name: admin
+ * Password: password
+
+10. Change the log in information.
+
+Test Cases
+==========
+Use prove to execute test cases. Execute after a carton install:
+
+* To run the Unit Tests: ``$ local/bin/prove -qrp t/``
+* To run the Integration Tests: ``$ local/bin/prove -qrp t_integration/``
+
+The KableTown CDN example
+-------------------------
+The integration tests will load an example CDN with most of the features of Traffic Control being used. This is mostly for testing purposes, but can also be used as an example of how to configure certain features. To load the KableTown CDN example and access it:
+
+1. Run the integration tests
+2. Start morbo against the integration database: ``export MOJO_MODE=integration; ./bin/start.pl``
+3. Using a browser, navigate to the given address: ``http://127.0.0.1:3000``
+4. For the initial log in:
+
+ * User name: admin
+ * Password: password
+
+
+Extensions
+==========
+Traffic Ops Extensions are a way to enhance the basic functionality of Traffic Ops in a custom manner. There are three types of extensions:
+
+1. Check Extensions
+
+ These allow you to add custom checks to the "Health->Server Checks" view.
+
+2. Configuration Extensions
+
+ These allow you to add custom configuration file generators.
+
+3. Data source Extensions
+
+ These allow you to add statistic sources for the graph views and APIs.
+
+Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see :ref:`admin-to-ext-script`.
+
+Check Extensions
+----------------
+
+In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the "Health->Server Checks" view and that usually run periodically out of cron.
+
+.. |checkmark| image:: ../../../traffic_ops/app/public/images/good.png
+
+.. |X| image:: ../../../traffic_ops/app/public/images/bad.png
+
+
+It is the responsibility of the check extension script to iterate over the servers it wants to check and post the results.
+
+An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops' ``/api/1.1/servers.json`` REST target. This list is walked, running a command to gather the stats from that cache. For some extensions, an HTTP GET request might be made to the ATS astats plugin, while for others the cache might be pinged, or a command run over SSH. The results are then compiled into a numeric or boolean result and the script POSTs tha result back to the Traffic Ops ``/api/1.1/servercheck/`` target.
+
+A check extension can have a column of |checkmark|'s and |X|'s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below: ::
+
+
+ Script here.
+
+Check Extension scripts are located in the $TO_HOME/bin/checks directory.
+
+Currently, the following Check Extensions are available and installed by default:
+
+**Cache Disk Usage Check - CDU**
+ This check shows how much of the available total cache disk is in use. A "warm" cache should show 100.00.
+
+**Cache Hit Ratio Check - CHR**
+ The cache hit ratio for the cache in the last 15 minutes (the interval is determined by the cron entry).
+
+**DiffServe CodePoint Check - DSCP**
+ Checks if the returning traffic from the cache has the correct DSCP value as assigned in the delivery service. (Some routers will overwrite DSCP)
+
+**Maximum Transmission Check - MTU**
+ Checks if the Traffic Ops host (if that is the one running the check) can send and receive 8192 size packets to the ``ip_address`` of the server in the server table.
+
+**Operational Readiness Check - ORT**
+ See :ref:`reference-traffic-ops-ort` for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.
+
+**Ping Check - 10G, ILO, 10G6, FQDN**
+ The bin/checks/ToPingCheck.pl is to check basic IP connectivity, and in the default setup it checks IP connectivity to the following:
+
+ 10G
+ Is the ``ip_address`` (the main IPv4 address) from the server table pingable?
+ ILO
+ Is the ``ilo_ip_address`` (the lights-out-mangement IPv4 address) from the server table pingable?
+ 10G6
+ Is the ``ip6_address`` (the main IPv6 address) from the server table pingable?
+ FQDN
+ Is the Fully Qualified Domain name (the concatenation of ``host_name`` and ``.`` and ``domain_name`` from the server table) pingable?
+
+**Traffic Router Check - RTR**
+ Checks the state of each cache as perceived by all Traffic Monitors (via Traffic Router). This extension asks each Traffic Router for the state of the cache. A check failure is indicated if one or more monitors report an error for a cache. A cache is only marked as good if all reports are positive. (This is a pessimistic approach, opposite of how TM marks a cache as up, "the optimistic approach")
+
+
+Configuration Extensions
+------------------------
+NOTE: Config Extensions are Beta at this time.
+
+
+Data Source Extensions
+----------------------
+Traffic Ops has the ability to load custom code at runtime that allow any CDN user to build custom APIs for any requirement that Traffic Ops does not fulfill. There are two classes of Data Source Extensions, private and public. Private extensions are Traffic Ops extensions that are not publicly available, and should be kept in the /opt/traffic_ops_extensions/private/lib. Public extensions are Traffic Ops extensions that are Open Source in nature and free to enhance or contribute back to the Traffic Ops Open Source project and should be kept in /opt/traffic_ops/app/lib/Extensions.
+
+
+Extensions at Runtime
+---------------------
+The search path for extensions depends on the configuration of the PERL5LIB, which is preconfigured in the Traffic Ops start scripts. The following directory structure is where Traffic Ops will look for Extensions in this order.
+
+Extension Directories
+---------------------
+PERL5LIB Example Configuration: ::
+
+ export PERL5LIB=/opt/traffic_ops_extensions/private/lib/Extensions:/opt/traffic_ops/app/lib/Extensions/TrafficStats
+
+Perl Package Naming Convention
+------------------------------
+To prevent Extension namespace collisions within Traffic Ops all Extensions should follow the package naming convention below:
+
+Extensions::<ExtensionName>
+
+Data Source Extension Perl package name example
+Extensions::TrafficStats
+Extensions::YourCustomExtension
+
+TrafficOpsRoutes.pm
+-------------------
+Traffic Ops accesses each extension through the addition of a URL route as a custom hook. These routes will be defined in a file called TrafficOpsRoutes.pm that should live in the top directory of your Extension. The routes that are defined should follow the Mojolicious route conventions.
+
+
+Development Configuration
+--------------------------
+To incorporate any custom Extensions during development set your PERL5LIB with any number of directories with the understanding that the PERL5LIB search order will come into play, so keep in mind that top-down is how your code will be located. Once Perl locates your custom route or Perl package/class it 'pins' on that class or Mojo Route and doesn't look any further, which allows for the developer to *override* Traffic Ops functionality.
diff --git a/docs/latest/_sources/development/traffic_portal.rst.txt b/docs/latest/_sources/development/traffic_portal.rst.txt
new file mode 100644
index 0000000..b043e8a
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_portal.rst.txt
@@ -0,0 +1,51 @@
+..
+..
+.. 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.
+..
+
+Traffic Portal
+**************
+
+Introduction
+============
+Traffic Portal is an `AngularJS 1.x <https://angularjs.org/>`_ client served from a `Node.js <https://nodejs.org/en/>`_ web server designed to consume the Traffic Ops 1.x API. The Traffic Portal replaces the Traffic Ops UI.
+
+Software Requirements
+=====================
+To work on Traffic Portal you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+ * `Ruby Devel 2.0.x or above <https://www.rpmfind.net/linux/rpm2html/search.php?query=ruby-devel>`_
+ * `Compass 1.0.x or above <http://compass-style.org/>`_
+ * `Node.js 6.0.x or above <https://nodejs.org/en/>`_
+ * `Bower 1.7.9 or above <https://nodejs.org/en/>`_
+ * `Grunt CLI 1.2.0 or above <https://github.com/gruntjs/grunt-cli>`_
+ * Access to a working instance of Traffic Ops
+
+Traffic Portal Project Tree Overview
+=====================================
+ * **traffic_control/traffic_portal/app/src** - contains HTML, JavaScript and Sass source files.
+
+Installing The Traffic Portal Developer Environment
+===================================================
+
+ - Clone the traffic_control repository
+ - Navigate to the traffic_control/traffic_portal of your cloned repository.
+ - Run ``npm install`` to install application dependencies into traffic_portal/node_modules. Only needs to be done the first time unless traffic_portal/package.json changes.
+ - Run ``bower install`` to install client-side dependencies into traffic_portal/app/bower_components. Only needs to be done the first time unless traffic_portal/bower.json changes.
+ - Run ``grunt`` to package the application into traffic_portal/app/dist, start a local https server (Express), and start a file watcher.
+ - Navigate to https://localhost:8443
+
+Notes
+=====
+
+- The Traffic Portal consumes the Traffic Ops API. By default, Traffic Portal assumes Traffic Ops is running on https://localhost:8444. Temporarily modify traffic_portal/conf/config.js if you need to change the location of Traffic Ops.
diff --git a/docs/latest/_sources/development/traffic_router.rst.txt b/docs/latest/_sources/development/traffic_router.rst.txt
new file mode 100644
index 0000000..046c5a4
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_router.rst.txt
@@ -0,0 +1,145 @@
+..
+..
+.. 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.
+..
+
+Traffic Router
+**************
+Introduction
+============
+Traffic Router is a Java Tomcat application that routes clients to the closest available cache on the CDN using both HTTP and DNS. Cache availability is determined by Traffic Monitor; consequently Traffic Router polls Traffic Monitor for its configuration and cache health state information, and uses this data to make routing decisions. HTTP routing is performed by localizing the client based on the request's source IP address (IPv4 or IPv6), and issues an HTTP 302 redirect to the nearest cache. HTTP routing utilizes consistent hashing on request URLs to optimize cache performance and request distribution. DNS routing is performed by localizing clients, resolvers in most cases, requesting ``A`` and ``AAAA`` records for a configurable name such as ``foo.deliveryservice.somecdn.net``. Traffic Router is comprised of seven separate Maven modules:
+
+* shared - A reusable utility JAR for defining Delivery Service Certificates
+* configuration - A resuable JAR defining the ConfigurationListener interface
+* connector - A JAR that overrides Tomcat's standard Http11Protocol Connector class and allows Traffic Router to delay opening listen sockets until it is in a state suitable for routing traffic
+* geolocation - Submodule for defining geolocation services
+* neustar - A Jar that provides a bean "neustarGeolocationService" that implements the GeolocationService interface defined in the geolocation maven submodule, which can optionally be added to the build of Traffic Router
+* core - Services DNS and HTTP requests, performs localization on routing requests, and is deployed as a WAR to a Service (read: connector/listen port) within Tomcat which is separate from api
+* build - A simple Maven project which gathers the artifacts from the modules and builds an RPM
+
+Software Requirements
+=====================
+To work on Traffic Router you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+* Eclipse >= Kepler SR2 (or another Java IDE)
+* Maven >= 3.3.1
+* JDK >= 8.0
+
+Traffic Router Project Tree Overview
+====================================
+* ``traffic_control/traffic_traffic_router/`` - base directory for Traffic Router
+
+ * ``connector/`` - Source code for Traffic Router Connector;
+
+ * ``src/main/java`` - Java source directory for Traffic Router Connector
+
+ * ``core/`` - Source code for Traffic Router Core, which is built as its own deployable WAR file and communicates with Traffic Router API using JMX
+
+ * ``src/main`` - Main source directory for Traffic Router Core
+
+ * ``etc/init.d`` - Init script for Tomcat
+ * ``conf/`` - Minimum required configuration files
+ * ``java/`` - Java source code for Traffic Router Core
+ * ``opt/tomcat/conf`` - Contains Tomcat configuration file(s) pulled in during an RPM build
+ * ``resources/`` - Resources pulled in during an RPM build
+ * ``scripts/`` - Scripts used by the RPM build process
+ * ``webapp/`` - Java webapp resources
+
+ * ``src/test`` - Test source directory for Traffic Router Core
+
+ * ``conf/`` - Minimal Configuration files that make it possible to run junit tests
+ * ``db/`` - Files downloaded by unit tests
+ * ``java/`` - JUnit based unit tests for Traffic Router Core
+ * ``resources/`` - Example data files used by junit tests
+
+ * ``var/auto-zones`` - BIND formatted zone files generated by Traffic Router Core during unit testing
+
+Java Formatting Conventions
+===========================
+None at this time. The codebase will eventually be formatted per Java standards.
+
+Installing The Developer Environment
+====================================
+To install the Traffic Router Developer environment:
+
+1. Clone the traffic_control repository using Git.
+2. Change directories into ``traffic_control/traffic_router``.
+3. Follow the instructions in "README.DNSSEC" for DNSSEC support.
+4. Set the environment variable TRAFFIC_MONITOR_HOSTS to be a semicolon delimited list of Traffic Monitors that can be accessed during integration tests
+5. Additional configuration is set using the below files:
+
+ * core/src/test/conf/dns.properties - copy from core/src/main/conf
+ * core/src/test/conf/http.properties - copy from core/src/main/conf
+ * core/src/test/conf/log4j.properties - copy from core/src/main/conf
+ * core/src/test/conf/traffic_monitor.properties - copy from core/src/main/conf
+ * core/src/test/conf/traffic_ops.properties file holds the credentials for accessing Traffic Ops. - copy from core/src/main/conf
+ * Default configuration values now reside in core/src/main/webapp/WEB-INF/applicationContext.xml
+ * The above values may be overridden by creating and/or modifying the property files listed in core/src/main/resources/applicationProperties.xml
+ * Pre-existing properties files are still honored by Traffic Router. For example traffic_monitor.properties:
+
+ +-------------------------------------+------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Value |
+ +=====================================+==================================================================================================================+
+ | ``traffic_monitor.bootstrap.hosts`` | FQDN and port of the Traffic Monitor instance(s), separated by semicolons as necessary (do not include http://). |
+ +-------------------------------------+------------------------------------------------------------------------------------------------------------------+
+
+
+6. Import the existing git repo into Eclipse:
+
+ a. File -> Import -> Git -> Projects from Git; Next
+ b. Existing local repository; Next
+ c. Add -> browse to find ``traffic_control``; Open
+ d. Select ``traffic_control``; Next
+ e. Ensure "Import existing projects" is selected, expand ``traffic_control``, select ``traffic_router``; Next
+ f. Ensure ``traffic_router_api``, ``traffic_router_connector``, and ``traffic_router_core`` are checked; Finish (this step can take several minutes to complete)
+ g. Ensure ``traffic_router_api``, ``traffic_router_connector``, and ``traffic_router_core`` have been opened by Eclipse after importing
+
+7. From the terminal, run ``mvn clean verify`` from the ``traffic_router`` directory
+
+8. Start the embedded Tomcat instance for Core from within your IDE by following these steps:
+
+ a. In the package explorer, expand ``traffic_router_core``
+ b. Expand ``src/test/java``
+ c. Expand the package ``com.comcast.cdn.traffic_control.traffic_router.core``
+ d. Open and run ``TrafficRouterStart.java``
+
+ .. Note:: If an error is displayed in the Console, run ``mvn clean verify`` from the ``traffic_router`` directory
+
+9. Traffic Router Core should now be running; the Traffic Router API is available at http://localhost:3333, the HTTP routing interface is available on http://localhost:8888 and HTTPS is available on http://localhost:8443.
+The DNS server and routing interface is available on localhost:1053 via TCP and UDP.
+
+Manual Testing
+==============
+Look up the URL for your test 'http' Delivery Service in Traffic Ops and then:
+
+curl -vs -H “Host: <Delivery Service URL>” http://localhost:8888/x
+
+Test Cases
+==========
+* Unit tests can be executed using Maven by running ``mvn test`` at the root of the ``traffic_router`` project.
+* Unit and Integration tests can be executed using Maven by running ``mvn verify`` at the root of the ``traffic_router`` project.
+
+RPM Packaging
+=============
+Running ``mvn package`` on a Linux based distribution will trigger the build process to create the Traffic Router rpm.
+
+API
+===
+
+:ref:`reference-tr-api`
+
+.. toctree::
+ :hidden:
+ :maxdepth: 1
+
+ traffic_router/traffic_router_api
diff --git a/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt b/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt
new file mode 100644
index 0000000..f56ca2e
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt
@@ -0,0 +1,91 @@
+..
+..
+.. 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.
+..
+
+.. _reference-tr-api:
+
+
+Traffic Router API
+==================
+
+**/crs/stats**
+
+General stats.
+
+|
+
+**/crs/stats/ip/<ipaddress>**
+
+Geolocation information for an IPv4 or IPv6 address.
+
+|
+
+**/crs/locations**
+
+A list of configured cache groups.
+
+|
+
+**/crs/locations/caches**
+
+A mapping of caches to cache groups and their current health state.
+
+|
+
+**/crs/locations/<location>/caches**
+
+A list of caches for this cache group only.
+
+|
+
+**/crs/consistenthash/cache/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
+
+The resulting cache of the consistent hash using coverage zone file for a given client IP, delivery service, and request path.
+
+|
+
+**/crs/consistenthash/cache/deep/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
+
+The resulting cache of the consistent hash using deep coverage zone file (deep caching) for a given client IP, delivery service, and request path.
+
+|
+
+**/crs/consistenthash/cache/geolocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
+
+The resulting cache of the consistent hash using geolocation for a given client IP, delivery service, and request path.
+
+|
+
+**/crs/consistenthash/deliveryservice/?deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath>**
+
+The resulting delivery service of the consistent hash for a given delivery service and request path -- used to test steering delivery services.
+
+|
+
+**/crs/coveragezone/caches/?deliveryServiceId=<deliveryServiceId>&cacheLocationId=<cacheLocationId>**
+
+A list of caches for a given delivery service and cache location.
+
+|
+
+**/crs/coveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>**
+
+The resulting cache location for a given client IP and delivery service.
+
+|
+
+**/crs/deepcoveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>**
+
+The resulting cache location using deep coverage zone file (deep caching) for a given client IP and delivery service.
+
diff --git a/docs/latest/_sources/development/traffic_stats.rst.txt b/docs/latest/_sources/development/traffic_stats.rst.txt
new file mode 100644
index 0000000..02317f7
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_stats.rst.txt
@@ -0,0 +1,58 @@
+..
+..
+.. 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.
+..
+
+Traffic Stats
+*************
+
+Introduction
+============
+Traffic Stats is a utility written in `Go <http.golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by `Grafana <http://grafana.org>`_ which are linked from Traffic Ops. Traffic Stats also calculates daily statistics from InfluxDb and stores them in the Traffic Ops database.
+
+Software Requirements
+=====================
+To work on Traffic Stats you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+ * `Go 1.7.x or above <https://golang.org/doc/install>`_
+ * Access to a working instance of Traffic Ops
+ * Access to a working instance of Traffic Monitor
+ * `InfluxDb version 1.0.0 or greater <https://influxdb.com/download/index.html>`_
+
+Traffic Stats Project Tree Overview
+=====================================
+ * **traffic_control/traffic_stats** - contains Go source files and Files used to create the Traffic Stats rpm.
+ * **traffic_control/traffic_stats/grafana/** - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.
+ * **traffic_control/traffic_stats/influxdb_tools/** - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.
+
+
+Go Formatting Conventions
+============================
+In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code. It is also recommended to use `Go lint <https://github.com/golang/lint>`_.
+
+Installing The Developer Environment
+====================================
+To install the Traffic Ops Developer environment:
+
+ - Clone the traffic_control repository using Git into a location accessible by your $GOPATH
+ - Navigate to the traffic_ops/client directory of your cloned repository. (This is the directory containing Traffic Ops client code used by Traffic Stats)
+ - From the traffic_ops/client directory run ``go test`` to test the client code. This will run all unit tests for the client and return the results. If there are missing dependencies you will need to run ``go get <dependency name>`` to get the dependency
+ - Once the tests pass, run ``go install`` to build and install the Traffic Ops client package. This makes it accessible to Traffic Stats.
+ - Navigate to your cloned repo under Traffic Stats
+ - Run ``go build traffic_stats.go`` to build traffic_stats. You will need to run ``go get`` for any missing dependencies.
+
+
+Test Cases
+==========
+ Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!
+
diff --git a/docs/latest/_sources/faq/administration.rst.txt b/docs/latest/_sources/faq/administration.rst.txt
new file mode 100644
index 0000000..e9060f4
--- /dev/null
+++ b/docs/latest/_sources/faq/administration.rst.txt
@@ -0,0 +1,95 @@
+..
+..
+.. 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.
+..
+
+Running a Traffic Control CDN
+*****************************
+
+.. _rl-cachegroup:
+
+Cache Group
+-------------------
+ A cache group is a logical group of caches that Traffic Router tries to use as a combined cache. Traffic Router treats all servers in a cache group as though they are in the same physical location, though they are in fact only in the same region (network). A cache group has one single set of geographical coordinates even if the caches that make up the cache group are in different physical locations. The caches in a cache group are not aware of the other caches in the group - there is no clustering software or communications between caches in a cache group.
+
+ There are two types of cache groups: EDGE and MID. Traffic Control is a two tier system, where the clients get directed to the EDGE cache group. On cache miss, the cache in the EDGE cache group obtains content from a MID cache group, rather than the origin, which is shared with multiple EDGEs. EDGE cache groups are configured to have one single parent cache group.
+
+ .. Note:: Often the EDGE to MID relationship is based on network distance, and does not necessarily match the geographic distance.
+
+ A cache group serves a particular part of the network as defined in the coverage zone file. See :ref:`rl-asn-czf`.
+
+ Consider the example CDN below:
+
+ .. image:: cache_groups_1.png
+ :align: center
+
+ There are two MID tier cache groups, each assigned with three EDGEs. The lax, den and chi EDGE locations are configured with the West MID as their parent, and the nyc, phl, and hou EDGEs, are configured with the East MID as their parent. On a cache miss, the EDGEs use their assigned parent.
+
+All caches (and other servers) are assigned a Profile in Traffic Ops.
+
+
+.. _rl-profile:
+
+Profile
+---------------
+ A Profile is a set of configuration settings and parameters, applied to a server or deliveryservice. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings, and bundled into groups using Profiles. Traffic Ops allows for duplication, comparison, import and export of Profiles.
+
+
+
+Why is my CRConfig.json rejected?
+=================================
+ Especially in version 1.1.0, there's a number of manual steps that need to be done after the initial install. Make sure that after the initial install, you perform these steps in order:
+
+ .. Note:: Even though Traffic Ops allows you to enter the servers with no IPv6 address information, the CRConfig will not be accepted by Traffic Router without IPv6 address information for at least Traffic Router and Traffic Monitor. Traffic Control assumes in a lot of places that all servers have at least an IPv4 and an IPv6 address. If you are not using IPv6, it is best to enter dummy addresses for all server types, and turn IPv6 off in all delivery services. (https://github.com/Comcast/traffic_control/issues/44).
+
+
+ * Add users
+ Not necessarily needed for getting your CRConfig accepted, but always a good idea.
+
+ * Add Divisions
+ You will need at least one.
+
+ * Add Regions
+ You will need at least one.
+
+ * Add Physical Locations
+ You will need at least one.
+
+ * Add Mid tier Cache Groups
+ You will need at least one.
+
+ * Add Edge tier Cache Groups
+ You will need at least one.
+
+ * Add Traffic Monitors
+ You will need to enter at least one Traffic Monitor - make sure to change the server status to *ONLINE*.
+
+ * Add Traffic Routers
+ You will need to enter at least one Traffic Router - make sure to change the server status to *ONLINE*.
+
+ * Add Edges
+ You will need at least one edge cache to make Traffic Router accept the CRConfig.
+
+ * Add Mid
+ Technically you don't need a mid tier, but if you have one, best to enter the info before continuing.
+
+ * Change the ``polling.url`` parameters to reflect your CDN
+ Set where to get the coverage zone map, and the geo IP database.
+
+ * Create at least one delivery service, and assign at least one edge cache in REPORTED state to it.
+ Even if it is a dummy DS, without a single DS, the CRConfig will not be accepted by Traffic Router.
+
+ * Snapshot CRConfig
+ **Tools > Snapshot CRConfig** diff, and write.
+
+ Now you are ready to install the sw on Traffic Monitor and then Traffic Router.
diff --git a/docs/latest/_sources/faq/development.rst.txt b/docs/latest/_sources/faq/development.rst.txt
new file mode 100644
index 0000000..8518eeb
--- /dev/null
+++ b/docs/latest/_sources/faq/development.rst.txt
@@ -0,0 +1,21 @@
+..
+..
+.. 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.
+..
+
+Development
+***********
+
+How can I become involved?
+==========================
+ See our `CONTRIBUTING <https://github.com/apache/incubator-trafficcontrol/blob/master/CONTRIBUTING.md>`_ page.
diff --git a/docs/latest/_sources/faq/general.rst.txt b/docs/latest/_sources/faq/general.rst.txt
new file mode 100644
index 0000000..fe77e3a
--- /dev/null
+++ b/docs/latest/_sources/faq/general.rst.txt
@@ -0,0 +1,55 @@
+..
+..
+.. 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.
+..
+
+General
+*******
+
+Who is using Traffic Control?
+=============================
+ `Comcast Cable <http://www.comcast.com/>`_
+ Comcast is the original developer of Traffic Control and is using it for all it's IP video delivery, delivering images and software to it's X1 platform, and for `delivering third party content <https://www.comcastwholesale.com/products-services/content-delivery-network>`_ to it's footprint.
+
+ `Cox Communications <http://www.cox.com/>`_
+
+ `Cisco <http://www.cisco.com/>`_
+ Cisco has a product called `Open Media Distribution <http://www.cisco.com/c/en/us/products/video/open-media-distribution/index.html>`_ that is based on Traffic Control.
+
+ `Concurrent <https://www.ccur.com/>`_
+ Concurrent has a product that uses Traffic Control, see their `github page <https://github.com/concurrentlabs/laguna>`_ for more info.
+
+ `Augere Pakistan / QUBEE <http://www.qubee.com.pk>`_
+
+ `Qwilt <https://www.qwilt.com/>`_
+ Qwilt has a product called `Open Edge CDN <https://qwilt.com/solutions/edge-cloud-cdn/>`_ that is based on Traffic Control.
+
+How do I get help with Traffic Control?
+=======================================
+ Hop on to our Slack Channel by filling out `this form <https://goo.gl/Suzakj>`_, or send a question to our mailing list `here <mailto:users@trafficcontrol.incubator.apache.org>`_.
+
+What is Rascal?
+===============
+ Rascal was the original name for Traffic Monitor. You will sometimes still see this name in the source, or in older documents.
+
+What is the CCR?
+================
+ Comcast Content Router was the original name for Traffic Router. You will sometimes still see this name in the source, or in older documents.
+
+What is Twelve Monkeys?
+=======================
+ Twelve Monkeys was the the original internal name for Traffic Ops. You will sometimes still see this name in the source, or in older documents. It's also a good movie.
+
+What license is Traffic Control released under?
+===============================================
+ See the `LICENSE file <https://github.com/apache/incubator-trafficcontrol/blob/master/LICENSE>`_
diff --git a/docs/latest/_sources/faq/index.rst.txt b/docs/latest/_sources/faq/index.rst.txt
new file mode 100644
index 0000000..82ea912
--- /dev/null
+++ b/docs/latest/_sources/faq/index.rst.txt
@@ -0,0 +1,26 @@
+..
+..
+.. 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.
+..
+
+FAQ
+***
+
+Table of Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ general
+ development
+ administration
diff --git a/docs/latest/_sources/glossary.rst.txt b/docs/latest/_sources/glossary.rst.txt
new file mode 100644
index 0000000..a932579
--- /dev/null
+++ b/docs/latest/_sources/glossary.rst.txt
@@ -0,0 +1,81 @@
+..
+..
+.. 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.
+..
+
+.. _glossary:
+
+Glossary
+========
+
+.. glossary::
+
+ 302 content routing
+ :ref:`rl-http-cr`.
+
+ astats (stats_over_http)
+ An ATS plugin that allows you to monitor vitals of the ATS server. See :ref:`rl-astats`.
+
+ cache
+ A caching proxy server. See :ref:`rl-caching_proxy`.
+
+ cachegroup
+ A group of caches that together create a combined larger cache using consistent hashing. See :ref:`rl-cachegroup`.
+
+ consistent hashing
+ See `the Wikipedia article <http://en.wikipedia.org/wiki/Consistent_hashing>`_; Traffic Control uses consistent hashing when using :ref:`rl-http-cr` for the edge tier and when selecting parents in the mid tier.
+
+ content routing
+ Directing clients (or client systems) to a particular location or device in a location for optimal delivery of content See also :ref:`rl-http-cr` and :ref:`rl-dns-cr`.
+
+ coverage zone map
+ The coverage zone map (czm) or coverage zone file (zcf) is a file that maps network prefixes to cachegroups. See :ref:`rl-localization`.
+
+ delivery service
+ A grouping of content in the CDN, usually a determined by the URL hostname. See :ref:`rl-ds`.
+
+ edge (tier or cache)
+ Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a :ref:`rl-rev-proxy`. See also :ref:`rl-cachegroup`.
+
+ (traffic ops) extension
+ Using *extensions*, Traffic Ops be extended to use proprietary checks or monitoring sources. See :ref:`rl-trops-ext`.
+
+ forward proxy
+ A proxy that works that acts like it is the client to the origin. See :ref:`rl-fwd-proxy`.
+
+ geo localization or geo routing
+ Localizing clients to the nearest caches using a geo database like the one from Maxmind.
+
+ health protocol
+ The protocol to monitor the health of all the caches. See :ref:`rl-health-proto`.
+
+ localization
+ Finding location on the network, or on planet earth. See :ref:`rl-localization`.
+
+ mid (tier or cache)
+ The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a :ref:`rl-fwd-proxy`. See also :ref:`rl-cachegroup`.
+
+ origin
+ The source of content for the CDN. Usually a redundant HTTP/1.1 webserver.
+
+ parent (cache or cachegroup)
+ The (group of) cache(s) in the higher tier. See :ref:`rl-cachegroup`.
+
+ profile
+ A group of settings (parameters) that will be applied to a server. See :ref:`rl-profile`.
+
+ reverse proxy
+ A proxy that acts like it is the origin to the client. See :ref:`rl-rev-proxy`.
+
+
+
diff --git a/docs/latest/_sources/index.rst.txt b/docs/latest/_sources/index.rst.txt
new file mode 100644
index 0000000..4f97825
--- /dev/null
+++ b/docs/latest/_sources/index.rst.txt
@@ -0,0 +1,88 @@
+..
+..
+.. 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.
+..
+
+%%%%%%%%%%%%%%%
+Traffic Control
+%%%%%%%%%%%%%%%
+
+The vast majority of today's Internet traffic is media files being sent from a single source to many thousands or even millions of destinations. Content Delivery Networks make that one-to-many distribution possible in an economical way.
+
+Traffic Control is an Open Source implementation of a Content Delivery Network.
+
+The following documentation sections are available:
+
+CDN Basics
+==========
+A review of the basic functionality of a Content Delivery Network.
+
+.. toctree::
+ :maxdepth: 2
+
+ basics/index
+
+
+Traffic Control Overview
+========================
+An introduction to the Traffic Control architecture, components, and their integration.
+
+.. toctree::
+ :maxdepth: 0
+
+ overview/index
+
+Administrator's Guide
+=====================
+How to deploy and manage a Traffic Control CDN.
+
+.. toctree::
+ :maxdepth: 3
+
+ admin/index
+
+Developer's Guide
+==================
+A guide to the various internal and external APIs, and an introduction for the Traffic Control developer.
+
+.. toctree::
+ :maxdepth: 3
+
+ development/index
+
+APIs
+====
+A guide to external RESTful APIs for Traffic Ops
+
+.. toctree::
+ :maxdepth: 3
+
+ api/index
+
+FAQ
+===
+
+.. toctree::
+ :maxdepth: 3
+
+ faq/index
+
+Indices and Tables
+==================
+
+.. toctree::
+ :maxdepth: 3
+
+ glossary.rst
+
+
diff --git a/docs/latest/_sources/overview/index.rst.txt b/docs/latest/_sources/overview/index.rst.txt
new file mode 100644
index 0000000..865d344
--- /dev/null
+++ b/docs/latest/_sources/overview/index.rst.txt
@@ -0,0 +1,29 @@
+..
+..
+.. 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.
+..
+
+Traffic Control Overview
+************************
+Introduces the Traffic Control architecture, components, and their integration.
+
+.. toctree::
+ :maxdepth: 2
+
+ introduction.rst
+ traffic_ops
+ traffic_portal
+ traffic_router
+ traffic_monitor
+ traffic_stats
+ traffic_vault
diff --git a/docs/latest/_sources/overview/introduction.rst.txt b/docs/latest/_sources/overview/introduction.rst.txt
new file mode 100644
index 0000000..2789b46
--- /dev/null
+++ b/docs/latest/_sources/overview/introduction.rst.txt
@@ -0,0 +1,49 @@
+..
+..
+.. 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.
+..
+
+Introduction
+============
+Traffic Control is a caching server control plane application which is used to aggregate caching servers into a Content Delivery Network (CDN). The CDN caching software chosen for Traffic Control is `Apache Traffic Server <http://trafficserver.apache.org/>`_ (ATS). Although the current release only supports ATS as a cache, this may change with future releases.
+
+Traffic Control was first developed at Comcast for internal use and released to Open Source in April of 2015. Traffic Control moved into the Apache Incubator in August of 2016.
+
+Traffic Control implements the elements illustrated in green in the diagram below.
+
+
+.. image:: traffic_control_overview_3.png
+ :align: center
+
+
+**Traffic Ops**
+ * `Traffic Ops <http://trafficcontrol.apache.org/docs/latest/overview/traffic_ops.html/>`_ is used to configure caching servers and CDN delivery services. It also contains APIs used to access CDN data.
+
+**Traffic Router**
+ * `Traffic Router <http://trafficcontrol.apache.org/docs/latest/overview/traffic_router.html/>`_ is used to route clients requests to the closest healthy cache by analyzing the health, capacity, and state of the caching servers and relative distance from each cache group to the location of the client.
+
+**Traffic Monitor**
+ * `Traffic Monitor <http://trafficcontrol.apache.org/docs/latest/overview/traffic_monitor.html/>`_ does health polling of the caching servers on a very short interval to keep track of which servers should be kept in rotation.
+
+**Traffic Stats**
+ * `Traffic Stats <http://trafficcontrol.apache.org/docs/latest/overview/traffic_stats.html/>`_ collects real time traffic statistics aggregated from each of the caching servers. This data is used by the Traffic Router to assess the available capacity of each caching server which it uses to balance traffic load and prevent overload.
+
+**Traffic Portal**
+ * `Traffic Portal <http://trafficcontrol.apache.org/docs/latest/overview/traffic_portal.html/>`_ is a web application which leverages the Traffic Ops APIs to present CDN data through a web interface.
+
+**Traffic Logs**
+ * Traffic Logs is currently under construction and is intended to aggregate Traffic Server request/response logs as well as other server logs. Logs will be parsed and indexed for search.
+
+
+In the next sections each of these components will be explained further.
+
diff --git a/docs/latest/_sources/overview/traffic_monitor.rst.txt b/docs/latest/_sources/overview/traffic_monitor.rst.txt
new file mode 100644
index 0000000..d97bddd
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_monitor.rst.txt
@@ -0,0 +1,66 @@
+..
+..
+.. 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.
+..
+
+.. _reference-label-tc-tm:
+
+.. index::
+ Traffic Monitor - Overview
+
+.. |arrow| image:: fwda.png
+
+Traffic Monitor
+===============
+Traffic Monitor is an HTTP service that monitors the caches in a CDN for a variety of metrics. These metrics are for use in determining the overall health of a given cache and the related delivery services. A given CDN can operate a number of Traffic Monitors, from a number of geographically diverse locations, to prevent false positives caused by network problems at a given site.
+
+Traffic Monitors operate independently, but use the state of other Traffic Monitors in conjunction with their own state, to provide a consistent view of CDN cache health to upstream applications such as Traffic Router. Health Protocol governs the cache and Delivery Service availability.
+
+Traffic Monitor provides a view into CDN health using several RESTful JSON endpoints, which are consumed by other Traffic Monitors and upstream components such as Traffic Router. Traffic Monitor is also responsible for serving the overall CDN configuration to Traffic Router, which ensures that the configuration of these two critical components remain synchronized as operational and health related changes propagate through the CDN.
+
+
+.. _rl-astats:
+
+|arrow| Cache Monitoring
+-------------------------
+ Traffic Monitor polls all caches configured with a status of ``REPORTED`` or ``ADMIN_DOWN`` at an interval specified as a configuration parameter in Traffic Ops. If the cache is set to ``ADMIN_DOWN`` it is marked as unavailable but still polled for availability and statistics. If the cache is explicitly configured with a status of ``ONLINE`` or ``OFFLINE``, it is not polled by Traffic Monitor and presented to Traffic Router as configured, regardless of actual availability.
+
+ Traffic Monitor makes HTTP requests at regular intervals to a special URL on each EDGE cache and consumes the JSON output. The special URL is a plugin running on the Apache Traffic Server (ATS) caches called astats, which is restricted to Traffic Monitor only. The astats plugin provides insight into application and system performance, such as:
+
+ - Throughput (e.g. bytes in, bytes out, etc).
+ - Transactions (e.g. number of 2xx, 3xx, 4xx responses, etc).
+ - Connections (e.g. from clients, to parents, origins, etc).
+ - Cache performance (e.g.: hits, misses, refreshes, etc).
+ - Storage performance (e.g.: writes, reads, frags, directories, etc).
+ - System performance (e.g: load average, network interface throughput, etc).
+
+ Many of the application level statistics are available at the global or aggregate level, some at the Delivery Service (remap rule) level. Traffic Monitor uses the system level performance to determine the overall health of the cache by evaluating network throughput and load against values configured in Traffic Ops. Traffic Monitor also uses throughput and transaction statistics at the remap rule level to determine Delivery Service health.
+
+If astats is unavailable due to a network related issue or the system statistics have exceeded the configured thresholds, Traffic Monitor will mark the cache as unavailable. If the delivery service statistics exceed the configured thresholds, the delivery service is marked as unavailable, and Traffic Router will start sending clients to the overflow destinations for that delivery service, but the cache remains available to serve other content,
+
+.. seealso:: For more information on ATS Statistics, see the `ATS documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_
+
+.. _rl-health-proto:
+
+|arrow| Health Protocol
+-----------------------
+ Redundant Traffic Monitor servers operate independently from each other but take the state of other Traffic Monitors into account when asked for health state information. In the above overview of cache monitoring, the behavior of Traffic Monitor pertains only to how an individual instance detects and handles failures. The Health Protocol adds another dimension to the health state of the CDN by merging the states of all Traffic Monitors into one, and then taking the *optimistic* approach when dealing with a cache or Delivery Service that might have been marked as unavailable by this particular instance or a peer instance of Traffic Monitor.
+
+ Upon startup or configuration change in Traffic Ops, in addition to caches, Traffic Monitor begins polling its peer Traffic Monitors whose state is set to ``ONLINE``. Each ``ONLINE`` Traffic Monitor polls all of its peers at a configurable interval and saves the peer's state for later use. When polling its peers, Traffic Monitor asks for the raw health state from each respective peer, which is strictly that instance's view of the CDN's health. When any ``ONLINE`` Traffic Monitor is asked for CDN health by an upstream component, such as Traffic Router, the component gets the health protocol influenced version of CDN health (non-raw view).
+
+ In operation of the health protocol, Traffic Monitor takes all health states from all peers, including the locally known health state, and serves an optimistic outlook to the requesting client. This means that, for example, if three of the four Traffic Monitors see a given cache or Delivery Service as exceeding its thresholds and unavailable, it is still considered available. Only if all Traffic Monitors agree that the given object is unavailable is that state propagated to upstream components. This optimistic approach to the Health Protocol is counter to the "fail fast" philosophy, but serves well for large networks with complicated geography and or routing. The optimistic Health Protocol allows network failures or latency to occur without affecting overall traffic routing, as Traffic Monitors can and do have a different view of the network when deployed in geographically diverse locations. Short polling intervals of both the caches and Traffic Monitor peers help to reduce customer impact of outages.
+
+It is not uncommon for a cache to be marked unavailable by Traffic Monitor - in fact, it is business as usual for many CDNs. A hot video asset may cause a single cache (say cache-03) to get close to it's interface capacity, the health protocol "kicks in", and Traffic Monitor marks cache-03 as unavailable. New clients want to see the same asset, and now, Traffic Router will send these customers to another cache (say cache-01) in the same cachegroup. The load is now shared between cache-01 and cache-03. As clients finish watching the asset on cache-03, it will drop below the threshold and gets marked available again, and new clients will now go back to cache-03 again.
+
+It is less common for a delivery service to be marked unavailable by Traffic Monitor, the delivery service thresholds are usually used for overflow situations at extreme peaks to protect other delivery services in the CDN from getting impacted.
+
diff --git a/docs/latest/_sources/overview/traffic_ops.rst.txt b/docs/latest/_sources/overview/traffic_ops.rst.txt
new file mode 100644
index 0000000..b6ede6e
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_ops.rst.txt
@@ -0,0 +1,41 @@
+..
+..
+.. 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.
+..
+
+.. |arrow| image:: fwda.png
+
+Traffic Ops
+===========
+Traffic Ops is the tool for administration (configuration and monitoring) of all components in a Traffic Control CDN. The CDN administrator uses Traffic Ops to manage servers, cache groups, delivery services, etc. In many cases, a configuration change requires propagation to several, or even all, caches and only explicitly after or before the same change propagates to Traffic Router. Traffic Ops takes care of this required consistency between the different components and their configuration. Traffic Ops exposes its data through a series of HTTP APIs and has a user interface that is interactive and viewable using a standard web browser.
+
+Traffic Ops uses a PostgreSQL database to store the configuration information, and the `Mojolicious framework <http://mojolicio.us/>`_ and `Go <https://golang.org/>`_ to generate APIs used by the Traffic Portal. Not all configuration data is in this database however; for sensitive data like SSL private keys or token based authentication shared secrets, a separate key-value store is used, allowing the operator to harden the server that runs this key-value store better from a security perspective (i.e only allow Traffic Ops access it with a cert). The Traffic Ops server, by design, needs to be accessible from all the other servers in the Traffic Control CDN.
+
+Traffic Ops generates all the application specific configuration files for the caches and other servers. The caches and other servers check in with Traffic Ops at a regular interval (default 15 minutes) to see if updated configuration files require application.
+
+Traffic Ops also runs a collection of periodic checks to determine the operational readiness of the caches. These periodic checks are customizable by the Traffic Ops admin using extensions.
+
+Traffic Ops is in the process of migrating from Perl to Go, and currently runs as two applications. The Go application serves all endpoints which have been rewritten in the Go language, and transparently proxies all other requests to the old Perl application. Both applications are installed by the RPM, and both run as a single service. When the project has fully migrated to Go, the Perl application will be removed, and the RPM and service will consist solely of the Go application.
+
+|
+
+.. _rl-trops-ext:
+
+|arrow| Traffic Ops Extension
+-----------------------------
+ Traffic Ops Extensions are a way to enhance the basic functionality of Traffic Ops in a custom manner. There are three types of extensions:
+
+ * Check Extensions - Allows you to add custom checks to the "Health->Server Checks" view.
+ * Configuration Extension - Allows you to add custom configuration file generators.
+ * Data source Extensions - Allows you to add data sources for the graph views and usage APIs.
+
diff --git a/docs/latest/_sources/overview/traffic_portal.rst.txt b/docs/latest/_sources/overview/traffic_portal.rst.txt
new file mode 100644
index 0000000..ae455b6
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_portal.rst.txt
@@ -0,0 +1,33 @@
+..
+..
+.. 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.
+..
+
+.. index::
+ Traffic Portal - Overview
+
+Traffic Portal
+==============
+Traffic Portal is an `AngularJS 1.x <https://angularjs.org/>`_ client served from a `Node.js <https://nodejs.org/en/>`_ web server designed to consume the Traffic Ops API. It is the official replacement for the legacy Traffic Ops UI.
+
+Features include:
+
+ - CDN Monitoring
+ - CDN Administration
+ - Delivery Service Configuration
+ - Cache Maintenance
+
+See :ref:`usingtrafficportal`
+
+
+
diff --git a/docs/latest/_sources/overview/traffic_router.rst.txt b/docs/latest/_sources/overview/traffic_router.rst.txt
new file mode 100644
index 0000000..e85ad32
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_router.rst.txt
@@ -0,0 +1,109 @@
+..
+..
+.. 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.
+..
+
+.. _reference-label-tc-tr:
+
+.. |arrow| image:: fwda.png
+
+.. index::
+ Traffic Router - Overview
+
+Traffic Router
+==============
+Traffic Router's function is to send clients to the most optimal cache. Optimal in this case is based on a number of factors:
+
+* Distance between the cache and the client (not necessarily measured in meters, but quite often in layer 3 network hops). Less network distance between the client and cache yields better performance, and lower network load. Traffic Router helps clients connect to the best performing cache for their location at the lowest network cost.
+
+* Availability of caches and health / load on the caches. A common issue in Internet and television distribution scenarios is having many clients attempting to retrieve the same content at the same time. Traffic Router helps clients route around overloaded or down caches.
+
+* Availability of content on a particular cache. Reusing of content through cache HITs is the most important performance gain a CDN can offer. Traffic Router sends clients to the cache that is most likely to already have the desired content.
+
+Traffic routing options are often configured at the Delivery Service level.
+
+|
+
+
+.. _rl-ds:
+
+|arrow| Delivery Service
+------------------------
+ As discussed in the basic concepts section, the EDGE caches are configured as reverse proxies, and the Traffic Control CDN looks from the outside as a very large reverse proxy. Delivery Services are often referred to a reverse proxy remap rule. In most cases, a Delivery Service is a one to one mapping to a FQDN that is used as a hostname to deliver the content. Many options and settings regarding how to optimize the content delivery, which is configurable on a Delivery Service basis. Some examples of these Delivery Service settings are:
+
+ * Cache in RAM, cache on disk, or do not cache at all.
+ * Use DNS or HTTP Content routing (see below).
+ * Limits on transactions per second and bandwidth.
+ * Protocol (http or https).
+ * Token based authentication settings.
+ * Header rewrite rules.
+
+ Since Traffic Control version 2.1 deliveryservices can optionally be linked to a :ref:`rl-profile`, and have parameters associated with them. The first feature that uses deliveryservice parameters is the :ref:`rl-multi-site-origin` configuration.
+ Delivery Services are also for use in allowing multi-tenants to coexist in the Traffic Control CDN without interfering with each other, and to keep information about their content separated.
+
+|
+
+.. _rl-localization:
+
+|arrow| Localization
+--------------------
+ Traffic Router uses a JSON input file called the *coverage zone map* to determine what *cachegroup* is closest to the client. If the client IP address is not in this coverage zone map, it falls back to *geo*, using the maxmind database to find the client's location, and the geo coordinates from Traffic Ops for the cachegroup.
+
+|
+
+Traffic Router is inserted into the HTTP retrieval process by making it DNS authoritative for the domain of the CDN delivery service. In the example of the reverse proxy, the client was given the ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` url. In a Traffic Control CDN, URLs start with a routing name, which is configurable per-Delivery Service, e.g. ``http://foo.mydeliveryservice.cdn.com/fun/example.html`` with the chosen routing name ``foo``.
+
+|
+
+.. index::
+ Content Routing
+
+.. _rl-dns-cr:
+
+|arrow| DNS Content Routing
+---------------------------
+ For a DNS delivery service the client might receive a URL such as ``http://foo.dsname.cdn.com/fun/example.html``. When the LDNS server is resolving this ``foo.dsname.cdn.com`` hostname to an IP address, it ends at Traffic Router because it is the authoritative DNS server for ``cdn.com`` and the domains below it, and subsequently responds with a list of IP addresses from the eligible caches based on the location of the LDNS server. When responding, Traffic Router does not know the actual client IP address or the path that the client is going to request. The decision on what cache IP address (or list of cache IP addresses) to return is solely based on the location of the LDNS server and the health of the caches. The client then connects to port 80 on the cache, and sends the ``Host: foo.dsname.cdn.com`` header. The configuration of the cache includes the remap rule ``http://foo.dsname.cdn.com http://origin.dsname.com`` to map the routed name to an origin hostname.
+
+|
+
+.. _rl-http-cr:
+
+|arrow| HTTP Content Routing
+----------------------------
+ For an HTTP delivery service the client might receive a URL such as ``http://bar.dsname.cdn.com/fun/example.html``. The LDNS server resolves this ``bar.dsname.cdn.com`` to an IP address, but in this case Traffic Router returns its own IP address. The client opens a connection to port 80 on the Traffic Router's IP address, and sends: ::
+
+ GET /fun/example.html HTTP/1.1
+ Host: bar.dsname.cdn.com
+
+ Traffic Router uses an HTTP 302 to redirect the client to the best cache. For example: ::
+
+ HTTP/1.1 302 Moved Temporarily
+ Server: Apache-Coyote/1.1
+ Location: http://atsec-nyc-02.dsname.cdn.com/fun/example.html
+ Content-Length: 0
+ Date: Tue, 13 Jan 2015 20:01:41 GMT
+
+ The information Traffic Router can consider when selecting a cache in this case is much better:
+
+ * The client's IP address (the other side of the socket).
+ * The URL path the client is requesting, excluding query string.
+ * All HTTP 1.1 headers.
+
+ The client follows the redirect and performs a DNS request for the IP address for ``atsec-nyc-02.dsname.cdn.com``, and normal HTTP steps follow, except the sending of the Host: header when connected to the cache is ``Host: atsec-nyc-02.dsname.cdn``, and the configuration of the cache includes the remap rule (e.g.``http://atsec-nyc-02.dsname.cdn http://origin.dsname.com``).
+
+ Traffic Router sends all requests for the same path in a delivery service to the same cache in a cache group using consistent hashing, in this case all caches in a cache group are not carrying the same content, and there is a much larger combined cache in the cache group.
+
+In many cases DNS content routing is the best possible option, especially in cases where the client is receiving small objects from the CDN like images and web pages.
+
+Traffic Router is redundant and horizontally scalable by adding more instances into the DNS hierarchy using NS records.
+
diff --git a/docs/latest/_sources/overview/traffic_stats.rst.txt b/docs/latest/_sources/overview/traffic_stats.rst.txt
new file mode 100644
index 0000000..10981de
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_stats.rst.txt
@@ -0,0 +1,35 @@
+..
+..
+.. 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.
+..
+
+.. _reference-label-tc-ts:
+.. |arrow| image:: fwda.png
+
+
+Traffic Stats
+=============
+Traffic Stats is a program written in `Golang <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less). The data from InfluxDb is then used to drive graphs created by `Grafana <http://grafana.org>`_ - which are linked to from Traffic Ops - as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.
+
+Stat data is stored in three different databases:
+
+ - cache_stats: The cache_stats database is used to store data gathered from edge caches. The `measurements <https://influxdb.com/docs/v0.9/concepts/glossary.html#measurement>`_ stored by cache are: bandwidth, maxKbps, and client_connections (ats.proxy.process.http.current_client_connections). Cache Data is stored with `tags <https://influxdb.com/docs/v0.9/concepts/glossary.html#tag>`_ for hostname, cachegroup, and CDN. Data can be queried using tags.
+
+
+ - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id.
+
+ - daily_stats: The daily_stats database is used to store summary data for daily activities. The stats that are currently summarized are Max Bandwidth and Bytes Served and they are stored by CDN.
+
+------------
+
+Traffic Stats does not influence overall CDN operation, but is required in order to display charts in Traffic Ops and Traffic Portal.
diff --git a/docs/latest/_sources/overview/traffic_vault.rst.txt b/docs/latest/_sources/overview/traffic_vault.rst.txt
new file mode 100644
index 0000000..933b86b
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_vault.rst.txt
@@ -0,0 +1,36 @@
+..
+..
+.. 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.
+..
+
+Traffic Vault
+=============
+
+Traffic Vault is a keystore used for storing the following types of information:
+
+* SSL Certificates
+ - Private Key
+ - CRT
+ - CSR
+* DNSSEC Keys
+ - Key Signing Key
+ - private key
+ - public key
+ - Zone Signing Key
+ - private key
+ - public key
+* URL Signing Keys
+
+As the name suggests, Traffic Vault is meant to be a "vault" of private keys that only certain users are allowed to access. In order to create, add, and retrieve keys a user must have admin privileges. Keys can be created via the Traffic Ops UI, but they can only be retrieved via the Traffic Ops API. The keystore used by Traffic Vault is `Riak <http://basho.com/riak/>`_. Traffic ops accesses Riak via https on port 8088. Traffic ops uses Riak's rest API with username/password authentication. Information on the API can be found `here <http://docs.basho.com/riak/latest/dev/references/http/>`_.
+
+
diff --git a/docs/latest/_static/basic.css b/docs/latest/_static/basic.css
index 2b513f0..19ced10 100644
--- a/docs/latest/_static/basic.css
+++ b/docs/latest/_static/basic.css
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -82,9 +82,21 @@
}
div.sphinxsidebar #searchbox input[type="text"] {
- width: 170px;
+ float: left;
+ width: 80%;
+ padding: 0.25em;
+ box-sizing: border-box;
}
+div.sphinxsidebar #searchbox input[type="submit"] {
+ float: left;
+ width: 20%;
+ border-left: none;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+
img {
border: 0;
max-width: 100%;
@@ -122,6 +134,8 @@
table.contentstable {
width: 90%;
+ margin-left: auto;
+ margin-right: auto;
}
table.contentstable p.biglink {
@@ -149,9 +163,14 @@
vertical-align: top;
}
-table.indextable dl, table.indextable dd {
+table.indextable ul {
margin-top: 0;
margin-bottom: 0;
+ list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+ padding-left: 0em;
}
table.indextable tr.pcap {
@@ -183,8 +202,20 @@
padding: 0.4em;
}
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+ padding: 2px;
+ border-collapse: collapse;
+}
+
/* -- general body styles --------------------------------------------------- */
+div.body {
+ min-width: 450px;
+ max-width: 800px;
+}
+
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
@@ -217,10 +248,6 @@
text-align: left;
}
-.field-list ul {
- padding-left: 1em;
-}
-
.first {
margin-top: 0 !important;
}
@@ -322,6 +349,11 @@
border-collapse: collapse;
}
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
table caption span.caption-number {
font-style: italic;
}
@@ -337,10 +369,6 @@
border-bottom: 1px solid #aaa;
}
-table.field-list td, table.field-list th {
- border: 0 !important;
-}
-
table.footnote td, table.footnote th {
border: 0 !important;
}
@@ -377,6 +405,27 @@
div.figure p.caption span.caption-text {
}
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
/* -- other body styles ----------------------------------------------------- */
@@ -418,24 +467,19 @@
margin-left: 30px;
}
-dt:target, .highlighted {
+dt:target, span.highlighted {
background-color: #fbe54e;
}
+rect.highlighted {
+ fill: #fbe54e;
+}
+
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
-.field-list ul {
- margin: 0;
- padding-left: 1em;
-}
-
-.field-list p {
- margin: 0;
-}
-
.optional {
font-size: 1.3em;
}
@@ -494,6 +538,13 @@
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
+span.pre {
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ -webkit-hyphens: none;
+ hyphens: none;
+}
+
td.linenos pre {
padding: 5px 0px;
border: 0;
@@ -585,6 +636,16 @@
float: right;
}
+span.eqno a.headerlink {
+ position: relative;
+ left: 0px;
+ z-index: 1;
+}
+
+div.math:hover a.headerlink {
+ visibility: visible;
+}
+
/* -- printout stylesheet --------------------------------------------------- */
@media print {
diff --git a/docs/latest/_static/comment-bright.png b/docs/latest/_static/comment-bright.png
index 551517b..15e27ed 100644
--- a/docs/latest/_static/comment-bright.png
+++ b/docs/latest/_static/comment-bright.png
Binary files differ
diff --git a/docs/latest/_static/comment-close.png b/docs/latest/_static/comment-close.png
index 09b54be..4d91bcf 100644
--- a/docs/latest/_static/comment-close.png
+++ b/docs/latest/_static/comment-close.png
Binary files differ
diff --git a/docs/latest/_static/comment.png b/docs/latest/_static/comment.png
index 92feb52..dfbc0cb 100644
--- a/docs/latest/_static/comment.png
+++ b/docs/latest/_static/comment.png
Binary files differ
diff --git a/docs/latest/_static/doctools.js b/docs/latest/_static/doctools.js
index 8163495..d892892 100644
--- a/docs/latest/_static/doctools.js
+++ b/docs/latest/_static/doctools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -45,7 +45,7 @@
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
- if (typeof s == 'undefined')
+ if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
@@ -66,29 +66,55 @@
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
- function highlight(node) {
- if (node.nodeType == 3) {
+ function highlight(node, addItems) {
+ if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
- if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
- var span = document.createElement("span");
- span.className = className;
+ if (pos >= 0 &&
+ !jQuery(node.parentNode).hasClass(className) &&
+ !jQuery(node.parentNode).hasClass("nohighlight")) {
+ var span;
+ var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.className = className;
+ }
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
+ if (isInSVG) {
+ var bbox = span.getBBox();
+ var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute('class', className);
+ var parentOfText = node.parentNode.parentNode;
+ addItems.push({
+ "parent": node.parentNode,
+ "target": rect});
+ }
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
- highlight(this);
+ highlight(this, addItems);
});
}
}
- return this.each(function() {
- highlight(this);
+ var addItems = [];
+ var result = this.each(function() {
+ highlight(this, addItems);
});
+ for (var i = 0; i < addItems.length; ++i) {
+ jQuery(addItems[i].parent).before(addItems[i].target);
+ }
+ return result;
};
/*
@@ -131,21 +157,21 @@
* i18n support
*/
TRANSLATIONS : {},
- PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
+ PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
- if (typeof translated == 'undefined')
+ if (typeof translated === 'undefined')
return string;
- return (typeof translated == 'string') ? translated : translated[0];
+ return (typeof translated === 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
- if (typeof translated == 'undefined')
+ if (typeof translated === 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
@@ -180,7 +206,7 @@
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
- if (document.location.hash)
+ if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
@@ -216,7 +242,7 @@
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
$('tr.cg-' + idnum).toggle();
- if (src.substr(-9) == 'minus.png')
+ if (src.substr(-9) === 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
@@ -248,7 +274,7 @@
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
- if (this == '..')
+ if (this === '..')
parts.pop();
});
var url = parts.join('/');
diff --git a/docs/latest/_static/documentation_options.js b/docs/latest/_static/documentation_options.js
new file mode 100644
index 0000000..9bb317f
--- /dev/null
+++ b/docs/latest/_static/documentation_options.js
@@ -0,0 +1,9 @@
+var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+ VERSION: '2.2-dev',
+ LANGUAGE: 'None',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+};
\ No newline at end of file
diff --git a/docs/latest/_static/down-pressed.png b/docs/latest/_static/down-pressed.png
index 7c30d00..5756c8c 100644
--- a/docs/latest/_static/down-pressed.png
+++ b/docs/latest/_static/down-pressed.png
Binary files differ
diff --git a/docs/latest/_static/down.png b/docs/latest/_static/down.png
index f48098a..1b3bdad 100644
--- a/docs/latest/_static/down.png
+++ b/docs/latest/_static/down.png
Binary files differ
diff --git a/docs/latest/_static/favicon.ico b/docs/latest/_static/favicon.ico
index b0a7633..a2e49cc 100644
--- a/docs/latest/_static/favicon.ico
+++ b/docs/latest/_static/favicon.ico
Binary files differ
diff --git a/docs/latest/_static/file.png b/docs/latest/_static/file.png
index 254c60b..a858a41 100644
--- a/docs/latest/_static/file.png
+++ b/docs/latest/_static/file.png
Binary files differ
diff --git a/docs/latest/_static/jquery-3.2.1.js b/docs/latest/_static/jquery-3.2.1.js
new file mode 100644
index 0000000..d2d8ca4
--- /dev/null
+++ b/docs/latest/_static/jquery-3.2.1.js
@@ -0,0 +1,10253 @@
+/*!
+ * jQuery JavaScript Library v3.2.1
+ * https://jquery.com/
+ *
+ * Includes Sizzle.js
+ * https://sizzlejs.com/
+ *
+ * Copyright JS Foundation and other contributors
+ * Released under the MIT license
+ * https://jquery.org/license
+ *
+ * Date: 2017-03-20T18:59Z
+ */
+( function( global, factory ) {
+
+ "use strict";
+
+ if ( typeof module === "object" && typeof module.exports === "object" ) {
+
+ // For CommonJS and CommonJS-like environments where a proper `window`
+ // is present, execute the factory and get jQuery.
+ // For environments that do not have a `window` with a `document`
+ // (such as Node.js), expose a factory as module.exports.
+ // This accentuates the need for the creation of a real `window`.
+ // e.g. var jQuery = require("jquery")(window);
+ // See ticket #14549 for more info.
+ module.exports = global.document ?
+ factory( global, true ) :
+ function( w ) {
+ if ( !w.document ) {
+ throw new Error( "jQuery requires a window with a document" );
+ }
+ return factory( w );
+ };
+ } else {
+ factory( global );
+ }
+
+// Pass this if window is not defined yet
+} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) {
+
+// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1
+// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode
+// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common
+// enough that all such attempts are guarded in a try block.
+"use strict";
+
+var arr = [];
+
+var document = window.document;
+
+var getProto = Object.getPrototypeOf;
+
+var slice = arr.slice;
+
+var concat = arr.concat;
+
+var push = arr.push;
+
+var indexOf = arr.indexOf;
+
+var class2type = {};
+
+var toString = class2type.toString;
+
+var hasOwn = class2type.hasOwnProperty;
+
+var fnToString = hasOwn.toString;
+
+var ObjectFunctionString = fnToString.call( Object );
+
+var support = {};
+
+
+
+ function DOMEval( code, doc ) {
+ doc = doc || document;
+
+ var script = doc.createElement( "script" );
+
+ script.text = code;
+ doc.head.appendChild( script ).parentNode.removeChild( script );
+ }
+/* global Symbol */
+// Defining this global in .eslintrc.json would create a danger of using the global
+// unguarded in another place, it seems safer to define global only for this module
+
+
+
+var
+ version = "3.2.1",
+
+ // Define a local copy of jQuery
+ jQuery = function( selector, context ) {
+
+ // The jQuery object is actually just the init constructor 'enhanced'
+ // Need init if jQuery is called (just allow error to be thrown if not included)
+ return new jQuery.fn.init( selector, context );
+ },
+
+ // Support: Android <=4.0 only
+ // Make sure we trim BOM and NBSP
+ rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,
+
+ // Matches dashed string for camelizing
+ rmsPrefix = /^-ms-/,
+ rdashAlpha = /-([a-z])/g,
+
+ // Used by jQuery.camelCase as callback to replace()
+ fcamelCase = function( all, letter ) {
+ return letter.toUpperCase();
+ };
+
+jQuery.fn = jQuery.prototype = {
+
+ // The current version of jQuery being used
+ jquery: version,
+
+ constructor: jQuery,
+
+ // The default length of a jQuery object is 0
+ length: 0,
+
+ toArray: function() {
+ return slice.call( this );
+ },
+
+ // Get the Nth element in the matched element set OR
+ // Get the whole matched element set as a clean array
+ get: function( num ) {
+
+ // Return all the elements in a clean array
+ if ( num == null ) {
+ return slice.call( this );
+ }
+
+ // Return just the one element from the set
+ return num < 0 ? this[ num + this.length ] : this[ num ];
+ },
+
+ // Take an array of elements and push it onto the stack
+ // (returning the new matched element set)
+ pushStack: function( elems ) {
+
+ // Build a new jQuery matched element set
+ var ret = jQuery.merge( this.constructor(), elems );
+
+ // Add the old object onto the stack (as a reference)
+ ret.prevObject = this;
+
+ // Return the newly-formed element set
+ return ret;
+ },
+
+ // Execute a callback for every element in the matched set.
+ each: function( callback ) {
+ return jQuery.each( this, callback );
+ },
+
+ map: function( callback ) {
+ return this.pushStack( jQuery.map( this, function( elem, i ) {
+ return callback.call( elem, i, elem );
+ } ) );
+ },
+
+ slice: function() {
+ return this.pushStack( slice.apply( this, arguments ) );
+ },
+
+ first: function() {
+ return this.eq( 0 );
+ },
+
+ last: function() {
+ return this.eq( -1 );
+ },
+
+ eq: function( i ) {
+ var len = this.length,
+ j = +i + ( i < 0 ? len : 0 );
+ return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] );
+ },
+
+ end: function() {
+ return this.prevObject || this.constructor();
+ },
+
+ // For internal use only.
+ // Behaves like an Array's method, not like a jQuery method.
+ push: push,
+ sort: arr.sort,
+ splice: arr.splice
+};
+
+jQuery.extend = jQuery.fn.extend = function() {
+ var options, name, src, copy, copyIsArray, clone,
+ target = arguments[ 0 ] || {},
+ i = 1,
+ length = arguments.length,
+ deep = false;
+
+ // Handle a deep copy situation
+ if ( typeof target === "boolean" ) {
+ deep = target;
+
+ // Skip the boolean and the target
+ target = arguments[ i ] || {};
+ i++;
+ }
+
+ // Handle case when target is a string or something (possible in deep copy)
+ if ( typeof target !== "object" && !jQuery.isFunction( target ) ) {
+ target = {};
+ }
+
+ // Extend jQuery itself if only one argument is passed
+ if ( i === length ) {
+ target = this;
+ i--;
+ }
+
+ for ( ; i < length; i++ ) {
+
+ // Only deal with non-null/undefined values
+ if ( ( options = arguments[ i ] ) != null ) {
+
+ // Extend the base object
+ for ( name in options ) {
+ src = target[ name ];
+ copy = options[ name ];
+
+ // Prevent never-ending loop
+ if ( target === copy ) {
+ continue;
+ }
+
+ // Recurse if we're merging plain objects or arrays
+ if ( deep && copy && ( jQuery.isPlainObject( copy ) ||
+ ( copyIsArray = Array.isArray( copy ) ) ) ) {
+
+ if ( copyIsArray ) {
+ copyIsArray = false;
+ clone = src && Array.isArray( src ) ? src : [];
+
+ } else {
+ clone = src && jQuery.isPlainObject( src ) ? src : {};
+ }
+
+ // Never move original objects, clone them
+ target[ name ] = jQuery.extend( deep, clone, copy );
+
+ // Don't bring in undefined values
+ } else if ( copy !== undefined ) {
+ target[ name ] = copy;
+ }
+ }
+ }
+ }
+
+ // Return the modified object
+ return target;
+};
+
+jQuery.extend( {
+
+ // Unique for each copy of jQuery on the page
+ expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ),
+
+ // Assume jQuery is ready without the ready module
+ isReady: true,
+
+ error: function( msg ) {
+ throw new Error( msg );
+ },
+
+ noop: function() {},
+
+ isFunction: function( obj ) {
+ return jQuery.type( obj ) === "function";
+ },
+
+ isWindow: function( obj ) {
+ return obj != null && obj === obj.window;
+ },
+
+ isNumeric: function( obj ) {
+
+ // As of jQuery 3.0, isNumeric is limited to
+ // strings and numbers (primitives or objects)
+ // that can be coerced to finite numbers (gh-2662)
+ var type = jQuery.type( obj );
+ return ( type === "number" || type === "string" ) &&
+
+ // parseFloat NaNs numeric-cast false positives ("")
+ // ...but misinterprets leading-number strings, particularly hex literals ("0x...")
+ // subtraction forces infinities to NaN
+ !isNaN( obj - parseFloat( obj ) );
+ },
+
+ isPlainObject: function( obj ) {
+ var proto, Ctor;
+
+ // Detect obvious negatives
+ // Use toString instead of jQuery.type to catch host objects
+ if ( !obj || toString.call( obj ) !== "[object Object]" ) {
+ return false;
+ }
+
+ proto = getProto( obj );
+
+ // Objects with no prototype (e.g., `Object.create( null )`) are plain
+ if ( !proto ) {
+ return true;
+ }
+
+ // Objects with prototype are plain iff they were constructed by a global Object function
+ Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor;
+ return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString;
+ },
+
+ isEmptyObject: function( obj ) {
+
+ /* eslint-disable no-unused-vars */
+ // See https://github.com/eslint/eslint/issues/6125
+ var name;
+
+ for ( name in obj ) {
+ return false;
+ }
+ return true;
+ },
+
+ type: function( obj ) {
+ if ( obj == null ) {
+ return obj + "";
+ }
+
+ // Support: Android <=2.3 only (functionish RegExp)
+ return typeof obj === "object" || typeof obj === "function" ?
+ class2type[ toString.call( obj ) ] || "object" :
+ typeof obj;
+ },
+
+ // Evaluates a script in a global context
+ globalEval: function( code ) {
+ DOMEval( code );
+ },
+
+ // Convert dashed to camelCase; used by the css and data modules
+ // Support: IE <=9 - 11, Edge 12 - 13
+ // Microsoft forgot to hump their vendor prefix (#9572)
+ camelCase: function( string ) {
+ return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase );
+ },
+
+ each: function( obj, callback ) {
+ var length, i = 0;
+
+ if ( isArrayLike( obj ) ) {
+ length = obj.length;
+ for ( ; i < length; i++ ) {
+ if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
+ break;
+ }
+ }
+ } else {
+ for ( i in obj ) {
+ if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
+ break;
+ }
+ }
+ }
+
+ return obj;
+ },
+
+ // Support: Android <=4.0 only
+ trim: function( text ) {
+ return text == null ?
+ "" :
+ ( text + "" ).replace( rtrim, "" );
+ },
+
+ // results is for internal usage only
+ makeArray: function( arr, results ) {
+ var ret = results || [];
+
+ if ( arr != null ) {
+ if ( isArrayLike( Object( arr ) ) ) {
+ jQuery.merge( ret,
+ typeof arr === "string" ?
+ [ arr ] : arr
+ );
+ } else {
+ push.call( ret, arr );
+ }
+ }
+
+ return ret;
+ },
+
+ inArray: function( elem, arr, i ) {
+ return arr == null ? -1 : indexOf.call( arr, elem, i );
+ },
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ merge: function( first, second ) {
+ var len = +second.length,
+ j = 0,
+ i = first.length;
+
+ for ( ; j < len; j++ ) {
+ first[ i++ ] = second[ j ];
+ }
+
+ first.length = i;
+
+ return first;
+ },
+
+ grep: function( elems, callback, invert ) {
+ var callbackInverse,
+ matches = [],
+ i = 0,
+ length = elems.length,
+ callbackExpect = !invert;
+
+ // Go through the array, only saving the items
+ // that pass the validator function
+ for ( ; i < length; i++ ) {
+ callbackInverse = !callback( elems[ i ], i );
+ if ( callbackInverse !== callbackExpect ) {
+ matches.push( elems[ i ] );
+ }
+ }
+
+ return matches;
+ },
+
+ // arg is for internal usage only
+ map: function( elems, callback, arg ) {
+ var length, value,
+ i = 0,
+ ret = [];
+
+ // Go through the array, translating each of the items to their new values
+ if ( isArrayLike( elems ) ) {
+ length = elems.length;
+ for ( ; i < length; i++ ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+
+ // Go through every key on the object,
+ } else {
+ for ( i in elems ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+ }
+
+ // Flatten any nested arrays
+ return concat.apply( [], ret );
+ },
+
+ // A global GUID counter for objects
+ guid: 1,
+
+ // Bind a function to a context, optionally partially applying any
+ // arguments.
+ proxy: function( fn, context ) {
+ var tmp, args, proxy;
+
+ if ( typeof context === "string" ) {
+ tmp = fn[ context ];
+ context = fn;
+ fn = tmp;
+ }
+
+ // Quick check to determine if target is callable, in the spec
+ // this throws a TypeError, but we will just return undefined.
+ if ( !jQuery.isFunction( fn ) ) {
+ return undefined;
+ }
+
+ // Simulated bind
+ args = slice.call( arguments, 2 );
+ proxy = function() {
+ return fn.apply( context || this, args.concat( slice.call( arguments ) ) );
+ };
+
+ // Set the guid of unique handler to the same of original handler, so it can be removed
+ proxy.guid = fn.guid = fn.guid || jQuery.guid++;
+
+ return proxy;
+ },
+
+ now: Date.now,
+
+ // jQuery.support is not used in Core but other projects attach their
+ // properties to it so it needs to exist.
+ support: support
+} );
+
+if ( typeof Symbol === "function" ) {
+ jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ];
+}
+
+// Populate the class2type map
+jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ),
+function( i, name ) {
+ class2type[ "[object " + name + "]" ] = name.toLowerCase();
+} );
+
+function isArrayLike( obj ) {
+
+ // Support: real iOS 8.2 only (not reproducible in simulator)
+ // `in` check used to prevent JIT error (gh-2145)
+ // hasOwn isn't used here due to false negatives
+ // regarding Nodelist length in IE
+ var length = !!obj && "length" in obj && obj.length,
+ type = jQuery.type( obj );
+
+ if ( type === "function" || jQuery.isWindow( obj ) ) {
+ return false;
+ }
+
+ return type === "array" || length === 0 ||
+ typeof length === "number" && length > 0 && ( length - 1 ) in obj;
+}
+var Sizzle =
+/*!
+ * Sizzle CSS Selector Engine v2.3.3
+ * https://sizzlejs.com/
+ *
+ * Copyright jQuery Foundation and other contributors
+ * Released under the MIT license
+ * http://jquery.org/license
+ *
+ * Date: 2016-08-08
+ */
+(function( window ) {
+
+var i,
+ support,
+ Expr,
+ getText,
+ isXML,
+ tokenize,
+ compile,
+ select,
+ outermostContext,
+ sortInput,
+ hasDuplicate,
+
+ // Local document vars
+ setDocument,
+ document,
+ docElem,
+ documentIsHTML,
+ rbuggyQSA,
+ rbuggyMatches,
+ matches,
+ contains,
+
+ // Instance-specific data
+ expando = "sizzle" + 1 * new Date(),
+ preferredDoc = window.document,
+ dirruns = 0,
+ done = 0,
+ classCache = createCache(),
+ tokenCache = createCache(),
+ compilerCache = createCache(),
+ sortOrder = function( a, b ) {
+ if ( a === b ) {
+ hasDuplicate = true;
+ }
+ return 0;
+ },
+
+ // Instance methods
+ hasOwn = ({}).hasOwnProperty,
+ arr = [],
+ pop = arr.pop,
+ push_native = arr.push,
+ push = arr.push,
+ slice = arr.slice,
+ // Use a stripped-down indexOf as it's faster than native
+ // https://jsperf.com/thor-indexof-vs-for/5
+ indexOf = function( list, elem ) {
+ var i = 0,
+ len = list.length;
+ for ( ; i < len; i++ ) {
+ if ( list[i] === elem ) {
+ return i;
+ }
+ }
+ return -1;
+ },
+
+ booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",
+
+ // Regular expressions
+
+ // http://www.w3.org/TR/css3-selectors/#whitespace
+ whitespace = "[\\x20\\t\\r\\n\\f]",
+
+ // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier
+ identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+",
+
+ // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors
+ attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace +
+ // Operator (capture 2)
+ "*([*^$|!~]?=)" + whitespace +
+ // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]"
+ "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace +
+ "*\\]",
+
+ pseudos = ":(" + identifier + ")(?:\\((" +
+ // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments:
+ // 1. quoted (capture 3; capture 4 or capture 5)
+ "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" +
+ // 2. simple (capture 6)
+ "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" +
+ // 3. anything else (capture 2)
+ ".*" +
+ ")\\)|)",
+
+ // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter
+ rwhitespace = new RegExp( whitespace + "+", "g" ),
+ rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ),
+
+ rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ),
+ rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ),
+
+ rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ),
+
+ rpseudo = new RegExp( pseudos ),
+ ridentifier = new RegExp( "^" + identifier + "$" ),
+
+ matchExpr = {
+ "ID": new RegExp( "^#(" + identifier + ")" ),
+ "CLASS": new RegExp( "^\\.(" + identifier + ")" ),
+ "TAG": new RegExp( "^(" + identifier + "|[*])" ),
+ "ATTR": new RegExp( "^" + attributes ),
+ "PSEUDO": new RegExp( "^" + pseudos ),
+ "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace +
+ "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace +
+ "*(\\d+)|))" + whitespace + "*\\)|)", "i" ),
+ "bool": new RegExp( "^(?:" + booleans + ")$", "i" ),
+ // For use in libraries implementing .is()
+ // We use this for POS matching in `select`
+ "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" +
+ whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" )
+ },
+
+ rinputs = /^(?:input|select|textarea|button)$/i,
+ rheader = /^h\d$/i,
+
+ rnative = /^[^{]+\{\s*\[native \w/,
+
+ // Easily-parseable/retrievable ID or TAG or CLASS selectors
+ rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,
+
+ rsibling = /[+~]/,
+
+ // CSS escapes
+ // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters
+ runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ),
+ funescape = function( _, escaped, escapedWhitespace ) {
+ var high = "0x" + escaped - 0x10000;
+ // NaN means non-codepoint
+ // Support: Firefox<24
+ // Workaround erroneous numeric interpretation of +"0x"
+ return high !== high || escapedWhitespace ?
+ escaped :
+ high < 0 ?
+ // BMP codepoint
+ String.fromCharCode( high + 0x10000 ) :
+ // Supplemental Plane codepoint (surrogate pair)
+ String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 );
+ },
+
+ // CSS string/identifier serialization
+ // https://drafts.csswg.org/cssom/#common-serializing-idioms
+ rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,
+ fcssescape = function( ch, asCodePoint ) {
+ if ( asCodePoint ) {
+
+ // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER
+ if ( ch === "\0" ) {
+ return "\uFFFD";
+ }
+
+ // Control characters and (dependent upon position) numbers get escaped as code points
+ return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " ";
+ }
+
+ // Other potentially-special ASCII characters get backslash-escaped
+ return "\\" + ch;
+ },
+
+ // Used for iframes
+ // See setDocument()
+ // Removing the function wrapper causes a "Permission Denied"
+ // error in IE
+ unloadHandler = function() {
+ setDocument();
+ },
+
+ disabledAncestor = addCombinator(
+ function( elem ) {
+ return elem.disabled === true && ("form" in elem || "label" in elem);
+ },
+ { dir: "parentNode", next: "legend" }
+ );
+
+// Optimize for push.apply( _, NodeList )
+try {
+ push.apply(
+ (arr = slice.call( preferredDoc.childNodes )),
+ preferredDoc.childNodes
+ );
+ // Support: Android<4.0
+ // Detect silently failing push.apply
+ arr[ preferredDoc.childNodes.length ].nodeType;
+} catch ( e ) {
+ push = { apply: arr.length ?
+
+ // Leverage slice if possible
+ function( target, els ) {
+ push_native.apply( target, slice.call(els) );
+ } :
+
+ // Support: IE<9
+ // Otherwise append directly
+ function( target, els ) {
+ var j = target.length,
+ i = 0;
+ // Can't trust NodeList.length
+ while ( (target[j++] = els[i++]) ) {}
+ target.length = j - 1;
+ }
+ };
+}
+
+function Sizzle( selector, context, results, seed ) {
+ var m, i, elem, nid, match, groups, newSelector,
+ newContext = context && context.ownerDocument,
+
+ // nodeType defaults to 9, since context defaults to document
+ nodeType = context ? context.nodeType : 9;
+
+ results = results || [];
+
+ // Return early from calls with invalid selector or context
+ if ( typeof selector !== "string" || !selector ||
+ nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) {
+
+ return results;
+ }
+
+ // Try to shortcut find operations (as opposed to filters) in HTML documents
+ if ( !seed ) {
+
+ if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) {
+ setDocument( context );
+ }
+ context = context || document;
+
+ if ( documentIsHTML ) {
+
+ // If the selector is sufficiently simple, try using a "get*By*" DOM method
+ // (excepting DocumentFragment context, where the methods don't exist)
+ if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) {
+
+ // ID selector
+ if ( (m = match[1]) ) {
+
+ // Document context
+ if ( nodeType === 9 ) {
+ if ( (elem = context.getElementById( m )) ) {
+
+ // Support: IE, Opera, Webkit
+ // TODO: identify versions
+ // getElementById can match elements by name instead of ID
+ if ( elem.id === m ) {
+ results.push( elem );
+ return results;
+ }
+ } else {
+ return results;
+ }
+
+ // Element context
+ } else {
+
+ // Support: IE, Opera, Webkit
+ // TODO: identify versions
+ // getElementById can match elements by name instead of ID
+ if ( newContext && (elem = newContext.getElementById( m )) &&
+ contains( context, elem ) &&
+ elem.id === m ) {
+
+ results.push( elem );
+ return results;
+ }
+ }
+
+ // Type selector
+ } else if ( match[2] ) {
+ push.apply( results, context.getElementsByTagName( selector ) );
+ return results;
+
+ // Class selector
+ } else if ( (m = match[3]) && support.getElementsByClassName &&
+ context.getElementsByClassName ) {
+
+ push.apply( results, context.getElementsByClassName( m ) );
+ return results;
+ }
+ }
+
+ // Take advantage of querySelectorAll
+ if ( support.qsa &&
+ !compilerCache[ selector + " " ] &&
+ (!rbuggyQSA || !rbuggyQSA.test( selector )) ) {
+
+ if ( nodeType !== 1 ) {
+ newContext = context;
+ newSelector = selector;
+
+ // qSA looks outside Element context, which is not what we want
+ // Thanks to Andrew Dupont for this workaround technique
+ // Support: IE <=8
+ // Exclude object elements
+ } else if ( context.nodeName.toLowerCase() !== "object" ) {
+
+ // Capture the context ID, setting it first if necessary
+ if ( (nid = context.getAttribute( "id" )) ) {
+ nid = nid.replace( rcssescape, fcssescape );
+ } else {
+ context.setAttribute( "id", (nid = expando) );
+ }
+
+ // Prefix every selector in the list
+ groups = tokenize( selector );
+ i = groups.length;
+ while ( i-- ) {
+ groups[i] = "#" + nid + " " + toSelector( groups[i] );
+ }
+ newSelector = groups.join( "," );
+
+ // Expand context for sibling selectors
+ newContext = rsibling.test( selector ) && testContext( context.parentNode ) ||
+ context;
+ }
+
+ if ( newSelector ) {
+ try {
+ push.apply( results,
+ newContext.querySelectorAll( newSelector )
+ );
+ return results;
+ } catch ( qsaError ) {
+ } finally {
+ if ( nid === expando ) {
+ context.removeAttribute( "id" );
+ }
+ }
+ }
+ }
+ }
+ }
+
+ // All others
+ return select( selector.replace( rtrim, "$1" ), context, results, seed );
+}
+
+/**
+ * Create key-value caches of limited size
+ * @returns {function(string, object)} Returns the Object data after storing it on itself with
+ * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength)
+ * deleting the oldest entry
+ */
+function createCache() {
+ var keys = [];
+
+ function cache( key, value ) {
+ // Use (key + " ") to avoid collision with native prototype properties (see Issue #157)
+ if ( keys.push( key + " " ) > Expr.cacheLength ) {
+ // Only keep the most recent entries
+ delete cache[ keys.shift() ];
+ }
+ return (cache[ key + " " ] = value);
+ }
+ return cache;
+}
+
+/**
+ * Mark a function for special use by Sizzle
+ * @param {Function} fn The function to mark
+ */
+function markFunction( fn ) {
+ fn[ expando ] = true;
+ return fn;
+}
+
+/**
+ * Support testing using an element
+ * @param {Function} fn Passed the created element and returns a boolean result
+ */
+function assert( fn ) {
+ var el = document.createElement("fieldset");
+
+ try {
+ return !!fn( el );
+ } catch (e) {
+ return false;
+ } finally {
+ // Remove from its parent by default
+ if ( el.parentNode ) {
+ el.parentNode.removeChild( el );
+ }
+ // release memory in IE
+ el = null;
+ }
+}
+
+/**
+ * Adds the same handler for all of the specified attrs
+ * @param {String} attrs Pipe-separated list of attributes
+ * @param {Function} handler The method that will be applied
+ */
+function addHandle( attrs, handler ) {
+ var arr = attrs.split("|"),
+ i = arr.length;
+
+ while ( i-- ) {
+ Expr.attrHandle[ arr[i] ] = handler;
+ }
+}
+
+/**
+ * Checks document order of two siblings
+ * @param {Element} a
+ * @param {Element} b
+ * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b
+ */
+function siblingCheck( a, b ) {
+ var cur = b && a,
+ diff = cur && a.nodeType === 1 && b.nodeType === 1 &&
+ a.sourceIndex - b.sourceIndex;
+
+ // Use IE sourceIndex if available on both nodes
+ if ( diff ) {
+ return diff;
+ }
+
+ // Check if b follows a
+ if ( cur ) {
+ while ( (cur = cur.nextSibling) ) {
+ if ( cur === b ) {
+ return -1;
+ }
+ }
+ }
+
+ return a ? 1 : -1;
+}
+
+/**
+ * Returns a function to use in pseudos for input types
+ * @param {String} type
+ */
+function createInputPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for buttons
+ * @param {String} type
+ */
+function createButtonPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return (name === "input" || name === "button") && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for :enabled/:disabled
+ * @param {Boolean} disabled true for :disabled; false for :enabled
+ */
+function createDisabledPseudo( disabled ) {
+
+ // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable
+ return function( elem ) {
+
+ // Only certain elements can match :enabled or :disabled
+ // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled
+ // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled
+ if ( "form" in elem ) {
+
+ // Check for inherited disabledness on relevant non-disabled elements:
+ // * listed form-associated elements in a disabled fieldset
+ // https://html.spec.whatwg.org/multipage/forms.html#category-listed
+ // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled
+ // * option elements in a disabled optgroup
+ // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled
+ // All such elements have a "form" property.
+ if ( elem.parentNode && elem.disabled === false ) {
+
+ // Option elements defer to a parent optgroup if present
+ if ( "label" in elem ) {
+ if ( "label" in elem.parentNode ) {
+ return elem.parentNode.disabled === disabled;
+ } else {
+ return elem.disabled === disabled;
+ }
+ }
+
+ // Support: IE 6 - 11
+ // Use the isDisabled shortcut property to check for disabled fieldset ancestors
+ return elem.isDisabled === disabled ||
+
+ // Where there is no isDisabled, check manually
+ /* jshint -W018 */
+ elem.isDisabled !== !disabled &&
+ disabledAncestor( elem ) === disabled;
+ }
+
+ return elem.disabled === disabled;
+
+ // Try to winnow out elements that can't be disabled before trusting the disabled property.
+ // Some victims get caught in our net (label, legend, menu, track), but it shouldn't
+ // even exist on them, let alone have a boolean value.
+ } else if ( "label" in elem ) {
+ return elem.disabled === disabled;
+ }
+
+ // Remaining elements are neither :enabled nor :disabled
+ return false;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for positionals
+ * @param {Function} fn
+ */
+function createPositionalPseudo( fn ) {
+ return markFunction(function( argument ) {
+ argument = +argument;
+ return markFunction(function( seed, matches ) {
+ var j,
+ matchIndexes = fn( [], seed.length, argument ),
+ i = matchIndexes.length;
+
+ // Match elements found at the specified indexes
+ while ( i-- ) {
+ if ( seed[ (j = matchIndexes[i]) ] ) {
+ seed[j] = !(matches[j] = seed[j]);
+ }
+ }
+ });
+ });
+}
+
+/**
+ * Checks a node for validity as a Sizzle context
+ * @param {Element|Object=} context
+ * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value
+ */
+function testContext( context ) {
+ return context && typeof context.getElementsByTagName !== "undefined" && context;
+}
+
+// Expose support vars for convenience
+support = Sizzle.support = {};
+
+/**
+ * Detects XML nodes
+ * @param {Element|Object} elem An element or a document
+ * @returns {Boolean} True iff elem is a non-HTML XML node
+ */
+isXML = Sizzle.isXML = function( elem ) {
+ // documentElement is verified for cases where it doesn't yet exist
+ // (such as loading iframes in IE - #4833)
+ var documentElement = elem && (elem.ownerDocument || elem).documentElement;
+ return documentElement ? documentElement.nodeName !== "HTML" : false;
+};
+
+/**
+ * Sets document-related variables once based on the current document
+ * @param {Element|Object} [doc] An element or document object to use to set the document
+ * @returns {Object} Returns the current document
+ */
+setDocument = Sizzle.setDocument = function( node ) {
+ var hasCompare, subWindow,
+ doc = node ? node.ownerDocument || node : preferredDoc;
+
+ // Return early if doc is invalid or already selected
+ if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) {
+ return document;
+ }
+
+ // Update global variables
+ document = doc;
+ docElem = document.documentElement;
+ documentIsHTML = !isXML( document );
+
+ // Support: IE 9-11, Edge
+ // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936)
+ if ( preferredDoc !== document &&
+ (subWindow = document.defaultView) && subWindow.top !== subWindow ) {
+
+ // Support: IE 11, Edge
+ if ( subWindow.addEventListener ) {
+ subWindow.addEventListener( "unload", unloadHandler, false );
+
+ // Support: IE 9 - 10 only
+ } else if ( subWindow.attachEvent ) {
+ subWindow.attachEvent( "onunload", unloadHandler );
+ }
+ }
+
+ /* Attributes
+ ---------------------------------------------------------------------- */
+
+ // Support: IE<8
+ // Verify that getAttribute really returns attributes and not properties
+ // (excepting IE8 booleans)
+ support.attributes = assert(function( el ) {
+ el.className = "i";
+ return !el.getAttribute("className");
+ });
+
+ /* getElement(s)By*
+ ---------------------------------------------------------------------- */
+
+ // Check if getElementsByTagName("*") returns only elements
+ support.getElementsByTagName = assert(function( el ) {
+ el.appendChild( document.createComment("") );
+ return !el.getElementsByTagName("*").length;
+ });
+
+ // Support: IE<9
+ support.getElementsByClassName = rnative.test( document.getElementsByClassName );
+
+ // Support: IE<10
+ // Check if getElementById returns elements by name
+ // The broken getElementById methods don't pick up programmatically-set names,
+ // so use a roundabout getElementsByName test
+ support.getById = assert(function( el ) {
+ docElem.appendChild( el ).id = expando;
+ return !document.getElementsByName || !document.getElementsByName( expando ).length;
+ });
+
+ // ID filter and find
+ if ( support.getById ) {
+ Expr.filter["ID"] = function( id ) {
+ var attrId = id.replace( runescape, funescape );
+ return function( elem ) {
+ return elem.getAttribute("id") === attrId;
+ };
+ };
+ Expr.find["ID"] = function( id, context ) {
+ if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
+ var elem = context.getElementById( id );
+ return elem ? [ elem ] : [];
+ }
+ };
+ } else {
+ Expr.filter["ID"] = function( id ) {
+ var attrId = id.replace( runescape, funescape );
+ return function( elem ) {
+ var node = typeof elem.getAttributeNode !== "undefined" &&
+ elem.getAttributeNode("id");
+ return node && node.value === attrId;
+ };
+ };
+
+ // Support: IE 6 - 7 only
+ // getElementById is not reliable as a find shortcut
+ Expr.find["ID"] = function( id, context ) {
+ if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
+ var node, i, elems,
+ elem = context.getElementById( id );
+
+ if ( elem ) {
+
+ // Verify the id attribute
+ node = elem.getAttributeNode("id");
+ if ( node && node.value === id ) {
+ return [ elem ];
+ }
+
+ // Fall back on getElementsByName
+ elems = context.getElementsByName( id );
+ i = 0;
+ while ( (elem = elems[i++]) ) {
+ node = elem.getAttributeNode("id");
+ if ( node && node.value === id ) {
+ return [ elem ];
+ }
+ }
+ }
+
+ return [];
+ }
+ };
+ }
+
+ // Tag
+ Expr.find["TAG"] = support.getElementsByTagName ?
+ function( tag, context ) {
+ if ( typeof context.getElementsByTagName !== "undefined" ) {
+ return context.getElementsByTagName( tag );
+
+ // DocumentFragment nodes don't have gEBTN
+ } else if ( support.qsa ) {
+ return context.querySelectorAll( tag );
+ }
+ } :
+
+ function( tag, context ) {
+ var elem,
+ tmp = [],
+ i = 0,
+ // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too
+ results = context.getElementsByTagName( tag );
+
+ // Filter out possible comments
+ if ( tag === "*" ) {
+ while ( (elem = results[i++]) ) {
+ if ( elem.nodeType === 1 ) {
+ tmp.push( elem );
+ }
+ }
+
+ return tmp;
+ }
+ return results;
+ };
+
+ // Class
+ Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) {
+ if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) {
+ return context.getElementsByClassName( className );
+ }
+ };
+
+ /* QSA/matchesSelector
+ ---------------------------------------------------------------------- */
+
+ // QSA and matchesSelector support
+
+ // matchesSelector(:active) reports false when true (IE9/Opera 11.5)
+ rbuggyMatches = [];
+
+ // qSa(:focus) reports false when true (Chrome 21)
+ // We allow this because of a bug in IE8/9 that throws an error
+ // whenever `document.activeElement` is accessed on an iframe
+ // So, we allow :focus to pass through QSA all the time to avoid the IE error
+ // See https://bugs.jquery.com/ticket/13378
+ rbuggyQSA = [];
+
+ if ( (support.qsa = rnative.test( document.querySelectorAll )) ) {
+ // Build QSA regex
+ // Regex strategy adopted from Diego Perini
+ assert(function( el ) {
+ // Select is set to empty string on purpose
+ // This is to test IE's treatment of not explicitly
+ // setting a boolean content attribute,
+ // since its presence should be enough
+ // https://bugs.jquery.com/ticket/12359
+ docElem.appendChild( el ).innerHTML = "<a id='" + expando + "'></a>" +
+ "<select id='" + expando + "-\r\\' msallowcapture=''>" +
+ "<option selected=''></option></select>";
+
+ // Support: IE8, Opera 11-12.16
+ // Nothing should be selected when empty strings follow ^= or $= or *=
+ // The test attribute must be unknown in Opera but "safe" for WinRT
+ // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section
+ if ( el.querySelectorAll("[msallowcapture^='']").length ) {
+ rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" );
+ }
+
+ // Support: IE8
+ // Boolean attributes and "value" are not treated correctly
+ if ( !el.querySelectorAll("[selected]").length ) {
+ rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" );
+ }
+
+ // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+
+ if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) {
+ rbuggyQSA.push("~=");
+ }
+
+ // Webkit/Opera - :checked should return selected option elements
+ // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
+ // IE8 throws error here and will not see later tests
+ if ( !el.querySelectorAll(":checked").length ) {
+ rbuggyQSA.push(":checked");
+ }
+
+ // Support: Safari 8+, iOS 8+
+ // https://bugs.webkit.org/show_bug.cgi?id=136851
+ // In-page `selector#id sibling-combinator selector` fails
+ if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) {
+ rbuggyQSA.push(".#.+[+~]");
+ }
+ });
+
+ assert(function( el ) {
+ el.innerHTML = "<a href='' disabled='disabled'></a>" +
+ "<select disabled='disabled'><option/></select>";
+
+ // Support: Windows 8 Native Apps
+ // The type and name attributes are restricted during .innerHTML assignment
+ var input = document.createElement("input");
+ input.setAttribute( "type", "hidden" );
+ el.appendChild( input ).setAttribute( "name", "D" );
+
+ // Support: IE8
+ // Enforce case-sensitivity of name attribute
+ if ( el.querySelectorAll("[name=d]").length ) {
+ rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" );
+ }
+
+ // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled)
+ // IE8 throws error here and will not see later tests
+ if ( el.querySelectorAll(":enabled").length !== 2 ) {
+ rbuggyQSA.push( ":enabled", ":disabled" );
+ }
+
+ // Support: IE9-11+
+ // IE's :disabled selector does not pick up the children of disabled fieldsets
+ docElem.appendChild( el ).disabled = true;
+ if ( el.querySelectorAll(":disabled").length !== 2 ) {
+ rbuggyQSA.push( ":enabled", ":disabled" );
+ }
+
+ // Opera 10-11 does not throw on post-comma invalid pseudos
+ el.querySelectorAll("*,:x");
+ rbuggyQSA.push(",.*:");
+ });
+ }
+
+ if ( (support.matchesSelector = rnative.test( (matches = docElem.matches ||
+ docElem.webkitMatchesSelector ||
+ docElem.mozMatchesSelector ||
+ docElem.oMatchesSelector ||
+ docElem.msMatchesSelector) )) ) {
+
+ assert(function( el ) {
+ // Check to see if it's possible to do matchesSelector
+ // on a disconnected node (IE 9)
+ support.disconnectedMatch = matches.call( el, "*" );
+
+ // This should fail with an exception
+ // Gecko does not error, returns false instead
+ matches.call( el, "[s!='']:x" );
+ rbuggyMatches.push( "!=", pseudos );
+ });
+ }
+
+ rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") );
+ rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") );
+
+ /* Contains
+ ---------------------------------------------------------------------- */
+ hasCompare = rnative.test( docElem.compareDocumentPosition );
+
+ // Element contains another
+ // Purposefully self-exclusive
+ // As in, an element does not contain itself
+ contains = hasCompare || rnative.test( docElem.contains ) ?
+ function( a, b ) {
+ var adown = a.nodeType === 9 ? a.documentElement : a,
+ bup = b && b.parentNode;
+ return a === bup || !!( bup && bup.nodeType === 1 && (
+ adown.contains ?
+ adown.contains( bup ) :
+ a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16
+ ));
+ } :
+ function( a, b ) {
+ if ( b ) {
+ while ( (b = b.parentNode) ) {
+ if ( b === a ) {
+ return true;
+ }
+ }
+ }
+ return false;
+ };
+
+ /* Sorting
+ ---------------------------------------------------------------------- */
+
+ // Document order sorting
+ sortOrder = hasCompare ?
+ function( a, b ) {
+
+ // Flag for duplicate removal
+ if ( a === b ) {
+ hasDuplicate = true;
+ return 0;
+ }
+
+ // Sort on method existence if only one input has compareDocumentPosition
+ var compare = !a.compareDocumentPosition - !b.compareDocumentPosition;
+ if ( compare ) {
+ return compare;
+ }
+
+ // Calculate position if both inputs belong to the same document
+ compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ?
+ a.compareDocumentPosition( b ) :
+
+ // Otherwise we know they are disconnected
+ 1;
+
+ // Disconnected nodes
+ if ( compare & 1 ||
+ (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) {
+
+ // Choose the first element that is related to our preferred document
+ if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) {
+ return -1;
+ }
+ if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) {
+ return 1;
+ }
+
+ // Maintain original order
+ return sortInput ?
+ ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :
+ 0;
+ }
+
+ return compare & 4 ? -1 : 1;
+ } :
+ function( a, b ) {
+ // Exit early if the nodes are identical
+ if ( a === b ) {
+ hasDuplicate = true;
+ return 0;
+ }
+
+ var cur,
+ i = 0,
+ aup = a.parentNode,
+ bup = b.parentNode,
+ ap = [ a ],
+ bp = [ b ];
+
+ // Parentless nodes are either documents or disconnected
+ if ( !aup || !bup ) {
+ return a === document ? -1 :
+ b === document ? 1 :
+ aup ? -1 :
+ bup ? 1 :
+ sortInput ?
+ ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :
+ 0;
+
+ // If the nodes are siblings, we can do a quick check
+ } else if ( aup === bup ) {
+ return siblingCheck( a, b );
+ }
+
+ // Otherwise we need full lists of their ancestors for comparison
+ cur = a;
+ while ( (cur = cur.parentNode) ) {
+ ap.unshift( cur );
+ }
+ cur = b;
+ while ( (cur = cur.parentNode) ) {
+ bp.unshift( cur );
+ }
+
+ // Walk down the tree looking for a discrepancy
+ while ( ap[i] === bp[i] ) {
+ i++;
+ }
+
+ return i ?
+ // Do a sibling check if the nodes have a common ancestor
+ siblingCheck( ap[i], bp[i] ) :
+
+ // Otherwise nodes in our document sort first
+ ap[i] === preferredDoc ? -1 :
+ bp[i] === preferredDoc ? 1 :
+ 0;
+ };
+
+ return document;
+};
+
+Sizzle.matches = function( expr, elements ) {
+ return Sizzle( expr, null, null, elements );
+};
+
+Sizzle.matchesSelector = function( elem, expr ) {
+ // Set document vars if needed
+ if ( ( elem.ownerDocument || elem ) !== document ) {
+ setDocument( elem );
+ }
+
+ // Make sure that attribute selectors are quoted
+ expr = expr.replace( rattributeQuotes, "='$1']" );
+
+ if ( support.matchesSelector && documentIsHTML &&
+ !compilerCache[ expr + " " ] &&
+ ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) &&
+ ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) {
+
+ try {
+ var ret = matches.call( elem, expr );
+
+ // IE 9's matchesSelector returns false on disconnected nodes
+ if ( ret || support.disconnectedMatch ||
+ // As well, disconnected nodes are said to be in a document
+ // fragment in IE 9
+ elem.document && elem.document.nodeType !== 11 ) {
+ return ret;
+ }
+ } catch (e) {}
+ }
+
+ return Sizzle( expr, document, null, [ elem ] ).length > 0;
+};
+
+Sizzle.contains = function( context, elem ) {
+ // Set document vars if needed
+ if ( ( context.ownerDocument || context ) !== document ) {
+ setDocument( context );
+ }
+ return contains( context, elem );
+};
+
+Sizzle.attr = function( elem, name ) {
+ // Set document vars if needed
+ if ( ( elem.ownerDocument || elem ) !== document ) {
+ setDocument( elem );
+ }
+
+ var fn = Expr.attrHandle[ name.toLowerCase() ],
+ // Don't get fooled by Object.prototype properties (jQuery #13807)
+ val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ?
+ fn( elem, name, !documentIsHTML ) :
+ undefined;
+
+ return val !== undefined ?
+ val :
+ support.attributes || !documentIsHTML ?
+ elem.getAttribute( name ) :
+ (val = elem.getAttributeNode(name)) && val.specified ?
+ val.value :
+ null;
+};
+
+Sizzle.escape = function( sel ) {
+ return (sel + "").replace( rcssescape, fcssescape );
+};
+
+Sizzle.error = function( msg ) {
+ throw new Error( "Syntax error, unrecognized expression: " + msg );
+};
+
+/**
+ * Document sorting and removing duplicates
+ * @param {ArrayLike} results
+ */
+Sizzle.uniqueSort = function( results ) {
+ var elem,
+ duplicates = [],
+ j = 0,
+ i = 0;
+
+ // Unless we *know* we can detect duplicates, assume their presence
+ hasDuplicate = !support.detectDuplicates;
+ sortInput = !support.sortStable && results.slice( 0 );
+ results.sort( sortOrder );
+
+ if ( hasDuplicate ) {
+ while ( (elem = results[i++]) ) {
+ if ( elem === results[ i ] ) {
+ j = duplicates.push( i );
+ }
+ }
+ while ( j-- ) {
+ results.splice( duplicates[ j ], 1 );
+ }
+ }
+
+ // Clear input after sorting to release objects
+ // See https://github.com/jquery/sizzle/pull/225
+ sortInput = null;
+
+ return results;
+};
+
+/**
+ * Utility function for retrieving the text value of an array of DOM nodes
+ * @param {Array|Element} elem
+ */
+getText = Sizzle.getText = function( elem ) {
+ var node,
+ ret = "",
+ i = 0,
+ nodeType = elem.nodeType;
+
+ if ( !nodeType ) {
+ // If no nodeType, this is expected to be an array
+ while ( (node = elem[i++]) ) {
+ // Do not traverse comment nodes
+ ret += getText( node );
+ }
+ } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) {
+ // Use textContent for elements
+ // innerText usage removed for consistency of new lines (jQuery #11153)
+ if ( typeof elem.textContent === "string" ) {
+ return elem.textContent;
+ } else {
+ // Traverse its children
+ for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
+ ret += getText( elem );
+ }
+ }
+ } else if ( nodeType === 3 || nodeType === 4 ) {
+ return elem.nodeValue;
+ }
+ // Do not include comment or processing instruction nodes
+
+ return ret;
+};
+
+Expr = Sizzle.selectors = {
+
+ // Can be adjusted by the user
+ cacheLength: 50,
+
+ createPseudo: markFunction,
+
+ match: matchExpr,
+
+ attrHandle: {},
+
+ find: {},
+
+ relative: {
+ ">": { dir: "parentNode", first: true },
+ " ": { dir: "parentNode" },
+ "+": { dir: "previousSibling", first: true },
+ "~": { dir: "previousSibling" }
+ },
+
+ preFilter: {
+ "ATTR": function( match ) {
+ match[1] = match[1].replace( runescape, funescape );
+
+ // Move the given value to match[3] whether quoted or unquoted
+ match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape );
+
+ if ( match[2] === "~=" ) {
+ match[3] = " " + match[3] + " ";
+ }
+
+ return match.slice( 0, 4 );
+ },
+
+ "CHILD": function( match ) {
+ /* matches from matchExpr["CHILD"]
+ 1 type (only|nth|...)
+ 2 what (child|of-type)
+ 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...)
+ 4 xn-component of xn+y argument ([+-]?\d*n|)
+ 5 sign of xn-component
+ 6 x of xn-component
+ 7 sign of y-component
+ 8 y of y-component
+ */
+ match[1] = match[1].toLowerCase();
+
+ if ( match[1].slice( 0, 3 ) === "nth" ) {
+ // nth-* requires argument
+ if ( !match[3] ) {
+ Sizzle.error( match[0] );
+ }
+
+ // numeric x and y parameters for Expr.filter.CHILD
+ // remember that false/true cast respectively to 0/1
+ match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) );
+ match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" );
+
+ // other types prohibit arguments
+ } else if ( match[3] ) {
+ Sizzle.error( match[0] );
+ }
+
+ return match;
+ },
+
+ "PSEUDO": function( match ) {
+ var excess,
+ unquoted = !match[6] && match[2];
+
+ if ( matchExpr["CHILD"].test( match[0] ) ) {
+ return null;
+ }
+
+ // Accept quoted arguments as-is
+ if ( match[3] ) {
+ match[2] = match[4] || match[5] || "";
+
+ // Strip excess characters from unquoted arguments
+ } else if ( unquoted && rpseudo.test( unquoted ) &&
+ // Get excess from tokenize (recursively)
+ (excess = tokenize( unquoted, true )) &&
+ // advance to the next closing parenthesis
+ (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) {
+
+ // excess is a negative index
+ match[0] = match[0].slice( 0, excess );
+ match[2] = unquoted.slice( 0, excess );
+ }
+
+ // Return only captures needed by the pseudo filter method (type and argument)
+ return match.slice( 0, 3 );
+ }
+ },
+
+ filter: {
+
+ "TAG": function( nodeNameSelector ) {
+ var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase();
+ return nodeNameSelector === "*" ?
+ function() { return true; } :
+ function( elem ) {
+ return elem.nodeName && elem.nodeName.toLowerCase() === nodeName;
+ };
+ },
+
+ "CLASS": function( className ) {
+ var pattern = classCache[ className + " " ];
+
+ return pattern ||
+ (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) &&
+ classCache( className, function( elem ) {
+ return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" );
+ });
+ },
+
+ "ATTR": function( name, operator, check ) {
+ return function( elem ) {
+ var result = Sizzle.attr( elem, name );
+
+ if ( result == null ) {
+ return operator === "!=";
+ }
+ if ( !operator ) {
+ return true;
+ }
+
+ result += "";
+
+ return operator === "=" ? result === check :
+ operator === "!=" ? result !== check :
+ operator === "^=" ? check && result.indexOf( check ) === 0 :
+ operator === "*=" ? check && result.indexOf( check ) > -1 :
+ operator === "$=" ? check && result.slice( -check.length ) === check :
+ operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 :
+ operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" :
+ false;
+ };
+ },
+
+ "CHILD": function( type, what, argument, first, last ) {
+ var simple = type.slice( 0, 3 ) !== "nth",
+ forward = type.slice( -4 ) !== "last",
+ ofType = what === "of-type";
+
+ return first === 1 && last === 0 ?
+
+ // Shortcut for :nth-*(n)
+ function( elem ) {
+ return !!elem.parentNode;
+ } :
+
+ function( elem, context, xml ) {
+ var cache, uniqueCache, outerCache, node, nodeIndex, start,
+ dir = simple !== forward ? "nextSibling" : "previousSibling",
+ parent = elem.parentNode,
+ name = ofType && elem.nodeName.toLowerCase(),
+ useCache = !xml && !ofType,
+ diff = false;
+
+ if ( parent ) {
+
+ // :(first|last|only)-(child|of-type)
+ if ( simple ) {
+ while ( dir ) {
+ node = elem;
+ while ( (node = node[ dir ]) ) {
+ if ( ofType ?
+ node.nodeName.toLowerCase() === name :
+ node.nodeType === 1 ) {
+
+ return false;
+ }
+ }
+ // Reverse direction for :only-* (if we haven't yet done so)
+ start = dir = type === "only" && !start && "nextSibling";
+ }
+ return true;
+ }
+
+ start = [ forward ? parent.firstChild : parent.lastChild ];
+
+ // non-xml :nth-child(...) stores cache data on `parent`
+ if ( forward && useCache ) {
+
+ // Seek `elem` from a previously-cached index
+
+ // ...in a gzip-friendly way
+ node = parent;
+ outerCache = node[ expando ] || (node[ expando ] = {});
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ node.uniqueID ] ||
+ (outerCache[ node.uniqueID ] = {});
+
+ cache = uniqueCache[ type ] || [];
+ nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];
+ diff = nodeIndex && cache[ 2 ];
+ node = nodeIndex && parent.childNodes[ nodeIndex ];
+
+ while ( (node = ++nodeIndex && node && node[ dir ] ||
+
+ // Fallback to seeking `elem` from the start
+ (diff = nodeIndex = 0) || start.pop()) ) {
+
+ // When found, cache indexes on `parent` and break
+ if ( node.nodeType === 1 && ++diff && node === elem ) {
+ uniqueCache[ type ] = [ dirruns, nodeIndex, diff ];
+ break;
+ }
+ }
+
+ } else {
+ // Use previously-cached element index if available
+ if ( useCache ) {
+ // ...in a gzip-friendly way
+ node = elem;
+ outerCache = node[ expando ] || (node[ expando ] = {});
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ node.uniqueID ] ||
+ (outerCache[ node.uniqueID ] = {});
+
+ cache = uniqueCache[ type ] || [];
+ nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];
+ diff = nodeIndex;
+ }
+
+ // xml :nth-child(...)
+ // or :nth-last-child(...) or :nth(-last)?-of-type(...)
+ if ( diff === false ) {
+ // Use the same loop as above to seek `elem` from the start
+ while ( (node = ++nodeIndex && node && node[ dir ] ||
+ (diff = nodeIndex = 0) || start.pop()) ) {
+
+ if ( ( ofType ?
+ node.nodeName.toLowerCase() === name :
+ node.nodeType === 1 ) &&
+ ++diff ) {
+
+ // Cache the index of each encountered element
+ if ( useCache ) {
+ outerCache = node[ expando ] || (node[ expando ] = {});
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ node.uniqueID ] ||
+ (outerCache[ node.uniqueID ] = {});
+
+ uniqueCache[ type ] = [ dirruns, diff ];
+ }
+
+ if ( node === elem ) {
+ break;
+ }
+ }
+ }
+ }
+ }
+
+ // Incorporate the offset, then check against cycle size
+ diff -= last;
+ return diff === first || ( diff % first === 0 && diff / first >= 0 );
+ }
+ };
+ },
+
+ "PSEUDO": function( pseudo, argument ) {
+ // pseudo-class names are case-insensitive
+ // http://www.w3.org/TR/selectors/#pseudo-classes
+ // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters
+ // Remember that setFilters inherits from pseudos
+ var args,
+ fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] ||
+ Sizzle.error( "unsupported pseudo: " + pseudo );
+
+ // The user may use createPseudo to indicate that
+ // arguments are needed to create the filter function
+ // just as Sizzle does
+ if ( fn[ expando ] ) {
+ return fn( argument );
+ }
+
+ // But maintain support for old signatures
+ if ( fn.length > 1 ) {
+ args = [ pseudo, pseudo, "", argument ];
+ return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ?
+ markFunction(function( seed, matches ) {
+ var idx,
+ matched = fn( seed, argument ),
+ i = matched.length;
+ while ( i-- ) {
+ idx = indexOf( seed, matched[i] );
+ seed[ idx ] = !( matches[ idx ] = matched[i] );
+ }
+ }) :
+ function( elem ) {
+ return fn( elem, 0, args );
+ };
+ }
+
+ return fn;
+ }
+ },
+
+ pseudos: {
+ // Potentially complex pseudos
+ "not": markFunction(function( selector ) {
+ // Trim the selector passed to compile
+ // to avoid treating leading and trailing
+ // spaces as combinators
+ var input = [],
+ results = [],
+ matcher = compile( selector.replace( rtrim, "$1" ) );
+
+ return matcher[ expando ] ?
+ markFunction(function( seed, matches, context, xml ) {
+ var elem,
+ unmatched = matcher( seed, null, xml, [] ),
+ i = seed.length;
+
+ // Match elements unmatched by `matcher`
+ while ( i-- ) {
+ if ( (elem = unmatched[i]) ) {
+ seed[i] = !(matches[i] = elem);
+ }
+ }
+ }) :
+ function( elem, context, xml ) {
+ input[0] = elem;
+ matcher( input, null, xml, results );
+ // Don't keep the element (issue #299)
+ input[0] = null;
+ return !results.pop();
+ };
+ }),
+
+ "has": markFunction(function( selector ) {
+ return function( elem ) {
+ return Sizzle( selector, elem ).length > 0;
+ };
+ }),
+
+ "contains": markFunction(function( text ) {
+ text = text.replace( runescape, funescape );
+ return function( elem ) {
+ return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1;
+ };
+ }),
+
+ // "Whether an element is represented by a :lang() selector
+ // is based solely on the element's language value
+ // being equal to the identifier C,
+ // or beginning with the identifier C immediately followed by "-".
+ // The matching of C against the element's language value is performed case-insensitively.
+ // The identifier C does not have to be a valid language name."
+ // http://www.w3.org/TR/selectors/#lang-pseudo
+ "lang": markFunction( function( lang ) {
+ // lang value must be a valid identifier
+ if ( !ridentifier.test(lang || "") ) {
+ Sizzle.error( "unsupported lang: " + lang );
+ }
+ lang = lang.replace( runescape, funescape ).toLowerCase();
+ return function( elem ) {
+ var elemLang;
+ do {
+ if ( (elemLang = documentIsHTML ?
+ elem.lang :
+ elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) {
+
+ elemLang = elemLang.toLowerCase();
+ return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0;
+ }
+ } while ( (elem = elem.parentNode) && elem.nodeType === 1 );
+ return false;
+ };
+ }),
+
+ // Miscellaneous
+ "target": function( elem ) {
+ var hash = window.location && window.location.hash;
+ return hash && hash.slice( 1 ) === elem.id;
+ },
+
+ "root": function( elem ) {
+ return elem === docElem;
+ },
+
+ "focus": function( elem ) {
+ return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex);
+ },
+
+ // Boolean properties
+ "enabled": createDisabledPseudo( false ),
+ "disabled": createDisabledPseudo( true ),
+
+ "checked": function( elem ) {
+ // In CSS3, :checked should return both checked and selected elements
+ // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
+ var nodeName = elem.nodeName.toLowerCase();
+ return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected);
+ },
+
+ "selected": function( elem ) {
+ // Accessing this property makes selected-by-default
+ // options in Safari work properly
+ if ( elem.parentNode ) {
+ elem.parentNode.selectedIndex;
+ }
+
+ return elem.selected === true;
+ },
+
+ // Contents
+ "empty": function( elem ) {
+ // http://www.w3.org/TR/selectors/#empty-pseudo
+ // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5),
+ // but not by others (comment: 8; processing instruction: 7; etc.)
+ // nodeType < 6 works because attributes (2) do not appear as children
+ for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
+ if ( elem.nodeType < 6 ) {
+ return false;
+ }
+ }
+ return true;
+ },
+
+ "parent": function( elem ) {
+ return !Expr.pseudos["empty"]( elem );
+ },
+
+ // Element/input types
+ "header": function( elem ) {
+ return rheader.test( elem.nodeName );
+ },
+
+ "input": function( elem ) {
+ return rinputs.test( elem.nodeName );
+ },
+
+ "button": function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && elem.type === "button" || name === "button";
+ },
+
+ "text": function( elem ) {
+ var attr;
+ return elem.nodeName.toLowerCase() === "input" &&
+ elem.type === "text" &&
+
+ // Support: IE<8
+ // New HTML5 attribute values (e.g., "search") appear with elem.type === "text"
+ ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" );
+ },
+
+ // Position-in-collection
+ "first": createPositionalPseudo(function() {
+ return [ 0 ];
+ }),
+
+ "last": createPositionalPseudo(function( matchIndexes, length ) {
+ return [ length - 1 ];
+ }),
+
+ "eq": createPositionalPseudo(function( matchIndexes, length, argument ) {
+ return [ argument < 0 ? argument + length : argument ];
+ }),
+
+ "even": createPositionalPseudo(function( matchIndexes, length ) {
+ var i = 0;
+ for ( ; i < length; i += 2 ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ }),
+
+ "odd": createPositionalPseudo(function( matchIndexes, length ) {
+ var i = 1;
+ for ( ; i < length; i += 2 ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ }),
+
+ "lt": createPositionalPseudo(function( matchIndexes, length, argument ) {
+ var i = argument < 0 ? argument + length : argument;
+ for ( ; --i >= 0; ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ }),
+
+ "gt": createPositionalPseudo(function( matchIndexes, length, argument ) {
+ var i = argument < 0 ? argument + length : argument;
+ for ( ; ++i < length; ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ })
+ }
+};
+
+Expr.pseudos["nth"] = Expr.pseudos["eq"];
+
+// Add button/input type pseudos
+for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) {
+ Expr.pseudos[ i ] = createInputPseudo( i );
+}
+for ( i in { submit: true, reset: true } ) {
+ Expr.pseudos[ i ] = createButtonPseudo( i );
+}
+
+// Easy API for creating new setFilters
+function setFilters() {}
+setFilters.prototype = Expr.filters = Expr.pseudos;
+Expr.setFilters = new setFilters();
+
+tokenize = Sizzle.tokenize = function( selector, parseOnly ) {
+ var matched, match, tokens, type,
+ soFar, groups, preFilters,
+ cached = tokenCache[ selector + " " ];
+
+ if ( cached ) {
+ return parseOnly ? 0 : cached.slice( 0 );
+ }
+
+ soFar = selector;
+ groups = [];
+ preFilters = Expr.preFilter;
+
+ while ( soFar ) {
+
+ // Comma and first run
+ if ( !matched || (match = rcomma.exec( soFar )) ) {
+ if ( match ) {
+ // Don't consume trailing commas as valid
+ soFar = soFar.slice( match[0].length ) || soFar;
+ }
+ groups.push( (tokens = []) );
+ }
+
+ matched = false;
+
+ // Combinators
+ if ( (match = rcombinators.exec( soFar )) ) {
+ matched = match.shift();
+ tokens.push({
+ value: matched,
+ // Cast descendant combinators to space
+ type: match[0].replace( rtrim, " " )
+ });
+ soFar = soFar.slice( matched.length );
+ }
+
+ // Filters
+ for ( type in Expr.filter ) {
+ if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] ||
+ (match = preFilters[ type ]( match ))) ) {
+ matched = match.shift();
+ tokens.push({
+ value: matched,
+ type: type,
+ matches: match
+ });
+ soFar = soFar.slice( matched.length );
+ }
+ }
+
+ if ( !matched ) {
+ break;
+ }
+ }
+
+ // Return the length of the invalid excess
+ // if we're just parsing
+ // Otherwise, throw an error or return tokens
+ return parseOnly ?
+ soFar.length :
+ soFar ?
+ Sizzle.error( selector ) :
+ // Cache the tokens
+ tokenCache( selector, groups ).slice( 0 );
+};
+
+function toSelector( tokens ) {
+ var i = 0,
+ len = tokens.length,
+ selector = "";
+ for ( ; i < len; i++ ) {
+ selector += tokens[i].value;
+ }
+ return selector;
+}
+
+function addCombinator( matcher, combinator, base ) {
+ var dir = combinator.dir,
+ skip = combinator.next,
+ key = skip || dir,
+ checkNonElements = base && key === "parentNode",
+ doneName = done++;
+
+ return combinator.first ?
+ // Check against closest ancestor/preceding element
+ function( elem, context, xml ) {
+ while ( (elem = elem[ dir ]) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ return matcher( elem, context, xml );
+ }
+ }
+ return false;
+ } :
+
+ // Check against all ancestor/preceding elements
+ function( elem, context, xml ) {
+ var oldCache, uniqueCache, outerCache,
+ newCache = [ dirruns, doneName ];
+
+ // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching
+ if ( xml ) {
+ while ( (elem = elem[ dir ]) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ if ( matcher( elem, context, xml ) ) {
+ return true;
+ }
+ }
+ }
+ } else {
+ while ( (elem = elem[ dir ]) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ outerCache = elem[ expando ] || (elem[ expando ] = {});
+
+ // Support: IE <9 only
+ // Defend against cloned attroperties (jQuery gh-1709)
+ uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {});
+
+ if ( skip && skip === elem.nodeName.toLowerCase() ) {
+ elem = elem[ dir ] || elem;
+ } else if ( (oldCache = uniqueCache[ key ]) &&
+ oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) {
+
+ // Assign to newCache so results back-propagate to previous elements
+ return (newCache[ 2 ] = oldCache[ 2 ]);
+ } else {
+ // Reuse newcache so results back-propagate to previous elements
+ uniqueCache[ key ] = newCache;
+
+ // A match means we're done; a fail means we have to keep checking
+ if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) {
+ return true;
+ }
+ }
+ }
+ }
+ }
+ return false;
+ };
+}
+
+function elementMatcher( matchers ) {
+ return matchers.length > 1 ?
+ function( elem, context, xml ) {
+ var i = matchers.length;
+ while ( i-- ) {
+ if ( !matchers[i]( elem, context, xml ) ) {
+ return false;
+ }
+ }
+ return true;
+ } :
+ matchers[0];
+}
+
+function multipleContexts( selector, contexts, results ) {
+ var i = 0,
+ len = contexts.length;
+ for ( ; i < len; i++ ) {
+ Sizzle( selector, contexts[i], results );
+ }
+ return results;
+}
+
+function condense( unmatched, map, filter, context, xml ) {
+ var elem,
+ newUnmatched = [],
+ i = 0,
+ len = unmatched.length,
+ mapped = map != null;
+
+ for ( ; i < len; i++ ) {
+ if ( (elem = unmatched[i]) ) {
+ if ( !filter || filter( elem, context, xml ) ) {
+ newUnmatched.push( elem );
+ if ( mapped ) {
+ map.push( i );
+ }
+ }
+ }
+ }
+
+ return newUnmatched;
+}
+
+function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) {
+ if ( postFilter && !postFilter[ expando ] ) {
+ postFilter = setMatcher( postFilter );
+ }
+ if ( postFinder && !postFinder[ expando ] ) {
+ postFinder = setMatcher( postFinder, postSelector );
+ }
+ return markFunction(function( seed, results, context, xml ) {
+ var temp, i, elem,
+ preMap = [],
+ postMap = [],
+ preexisting = results.length,
+
+ // Get initial elements from seed or context
+ elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ),
+
+ // Prefilter to get matcher input, preserving a map for seed-results synchronization
+ matcherIn = preFilter && ( seed || !selector ) ?
+ condense( elems, preMap, preFilter, context, xml ) :
+ elems,
+
+ matcherOut = matcher ?
+ // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results,
+ postFinder || ( seed ? preFilter : preexisting || postFilter ) ?
+
+ // ...intermediate processing is necessary
+ [] :
+
+ // ...otherwise use results directly
+ results :
+ matcherIn;
+
+ // Find primary matches
+ if ( matcher ) {
+ matcher( matcherIn, matcherOut, context, xml );
+ }
+
+ // Apply postFilter
+ if ( postFilter ) {
+ temp = condense( matcherOut, postMap );
+ postFilter( temp, [], context, xml );
+
+ // Un-match failing elements by moving them back to matcherIn
+ i = temp.length;
+ while ( i-- ) {
+ if ( (elem = temp[i]) ) {
+ matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem);
+ }
+ }
+ }
+
+ if ( seed ) {
+ if ( postFinder || preFilter ) {
+ if ( postFinder ) {
+ // Get the final matcherOut by condensing this intermediate into postFinder contexts
+ temp = [];
+ i = matcherOut.length;
+ while ( i-- ) {
+ if ( (elem = matcherOut[i]) ) {
+ // Restore matcherIn since elem is not yet a final match
+ temp.push( (matcherIn[i] = elem) );
+ }
+ }
+ postFinder( null, (matcherOut = []), temp, xml );
+ }
+
+ // Move matched elements from seed to results to keep them synchronized
+ i = matcherOut.length;
+ while ( i-- ) {
+ if ( (elem = matcherOut[i]) &&
+ (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) {
+
+ seed[temp] = !(results[temp] = elem);
+ }
+ }
+ }
+
+ // Add elements to results, through postFinder if defined
+ } else {
+ matcherOut = condense(
+ matcherOut === results ?
+ matcherOut.splice( preexisting, matcherOut.length ) :
+ matcherOut
+ );
+ if ( postFinder ) {
+ postFinder( null, results, matcherOut, xml );
+ } else {
+ push.apply( results, matcherOut );
+ }
+ }
+ });
+}
+
+function matcherFromTokens( tokens ) {
+ var checkContext, matcher, j,
+ len = tokens.length,
+ leadingRelative = Expr.relative[ tokens[0].type ],
+ implicitRelative = leadingRelative || Expr.relative[" "],
+ i = leadingRelative ? 1 : 0,
+
+ // The foundational matcher ensures that elements are reachable from top-level context(s)
+ matchContext = addCombinator( function( elem ) {
+ return elem === checkContext;
+ }, implicitRelative, true ),
+ matchAnyContext = addCombinator( function( elem ) {
+ return indexOf( checkContext, elem ) > -1;
+ }, implicitRelative, true ),
+ matchers = [ function( elem, context, xml ) {
+ var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || (
+ (checkContext = context).nodeType ?
+ matchContext( elem, context, xml ) :
+ matchAnyContext( elem, context, xml ) );
+ // Avoid hanging onto element (issue #299)
+ checkContext = null;
+ return ret;
+ } ];
+
+ for ( ; i < len; i++ ) {
+ if ( (matcher = Expr.relative[ tokens[i].type ]) ) {
+ matchers = [ addCombinator(elementMatcher( matchers ), matcher) ];
+ } else {
+ matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches );
+
+ // Return special upon seeing a positional matcher
+ if ( matcher[ expando ] ) {
+ // Find the next relative operator (if any) for proper handling
+ j = ++i;
+ for ( ; j < len; j++ ) {
+ if ( Expr.relative[ tokens[j].type ] ) {
+ break;
+ }
+ }
+ return setMatcher(
+ i > 1 && elementMatcher( matchers ),
+ i > 1 && toSelector(
+ // If the preceding token was a descendant combinator, insert an implicit any-element `*`
+ tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" })
+ ).replace( rtrim, "$1" ),
+ matcher,
+ i < j && matcherFromTokens( tokens.slice( i, j ) ),
+ j < len && matcherFromTokens( (tokens = tokens.slice( j )) ),
+ j < len && toSelector( tokens )
+ );
+ }
+ matchers.push( matcher );
+ }
+ }
+
+ return elementMatcher( matchers );
+}
+
+function matcherFromGroupMatchers( elementMatchers, setMatchers ) {
+ var bySet = setMatchers.length > 0,
+ byElement = elementMatchers.length > 0,
+ superMatcher = function( seed, context, xml, results, outermost ) {
+ var elem, j, matcher,
+ matchedCount = 0,
+ i = "0",
+ unmatched = seed && [],
+ setMatched = [],
+ contextBackup = outermostContext,
+ // We must always have either seed elements or outermost context
+ elems = seed || byElement && Expr.find["TAG"]( "*", outermost ),
+ // Use integer dirruns iff this is the outermost matcher
+ dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1),
+ len = elems.length;
+
+ if ( outermost ) {
+ outermostContext = context === document || context || outermost;
+ }
+
+ // Add elements passing elementMatchers directly to results
+ // Support: IE<9, Safari
+ // Tolerate NodeList properties (IE: "length"; Safari: <number>) matching elements by id
+ for ( ; i !== len && (elem = elems[i]) != null; i++ ) {
+ if ( byElement && elem ) {
+ j = 0;
+ if ( !context && elem.ownerDocument !== document ) {
+ setDocument( elem );
+ xml = !documentIsHTML;
+ }
+ while ( (matcher = elementMatchers[j++]) ) {
+ if ( matcher( elem, context || document, xml) ) {
+ results.push( elem );
+ break;
+ }
+ }
+ if ( outermost ) {
+ dirruns = dirrunsUnique;
+ }
+ }
+
+ // Track unmatched elements for set filters
+ if ( bySet ) {
+ // They will have gone through all possible matchers
+ if ( (elem = !matcher && elem) ) {
+ matchedCount--;
+ }
+
+ // Lengthen the array for every element, matched or not
+ if ( seed ) {
+ unmatched.push( elem );
+ }
+ }
+ }
+
+ // `i` is now the count of elements visited above, and adding it to `matchedCount`
+ // makes the latter nonnegative.
+ matchedCount += i;
+
+ // Apply set filters to unmatched elements
+ // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount`
+ // equals `i`), unless we didn't visit _any_ elements in the above loop because we have
+ // no element matchers and no seed.
+ // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that
+ // case, which will result in a "00" `matchedCount` that differs from `i` but is also
+ // numerically zero.
+ if ( bySet && i !== matchedCount ) {
+ j = 0;
+ while ( (matcher = setMatchers[j++]) ) {
+ matcher( unmatched, setMatched, context, xml );
+ }
+
+ if ( seed ) {
+ // Reintegrate element matches to eliminate the need for sorting
+ if ( matchedCount > 0 ) {
+ while ( i-- ) {
+ if ( !(unmatched[i] || setMatched[i]) ) {
+ setMatched[i] = pop.call( results );
+ }
+ }
+ }
+
+ // Discard index placeholder values to get only actual matches
+ setMatched = condense( setMatched );
+ }
+
+ // Add matches to results
+ push.apply( results, setMatched );
+
+ // Seedless set matches succeeding multiple successful matchers stipulate sorting
+ if ( outermost && !seed && setMatched.length > 0 &&
+ ( matchedCount + setMatchers.length ) > 1 ) {
+
+ Sizzle.uniqueSort( results );
+ }
+ }
+
+ // Override manipulation of globals by nested matchers
+ if ( outermost ) {
+ dirruns = dirrunsUnique;
+ outermostContext = contextBackup;
+ }
+
+ return unmatched;
+ };
+
+ return bySet ?
+ markFunction( superMatcher ) :
+ superMatcher;
+}
+
+compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) {
+ var i,
+ setMatchers = [],
+ elementMatchers = [],
+ cached = compilerCache[ selector + " " ];
+
+ if ( !cached ) {
+ // Generate a function of recursive functions that can be used to check each element
+ if ( !match ) {
+ match = tokenize( selector );
+ }
+ i = match.length;
+ while ( i-- ) {
+ cached = matcherFromTokens( match[i] );
+ if ( cached[ expando ] ) {
+ setMatchers.push( cached );
+ } else {
+ elementMatchers.push( cached );
+ }
+ }
+
+ // Cache the compiled function
+ cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) );
+
+ // Save selector and tokenization
+ cached.selector = selector;
+ }
+ return cached;
+};
+
+/**
+ * A low-level selection function that works with Sizzle's compiled
+ * selector functions
+ * @param {String|Function} selector A selector or a pre-compiled
+ * selector function built with Sizzle.compile
+ * @param {Element} context
+ * @param {Array} [results]
+ * @param {Array} [seed] A set of elements to match against
+ */
+select = Sizzle.select = function( selector, context, results, seed ) {
+ var i, tokens, token, type, find,
+ compiled = typeof selector === "function" && selector,
+ match = !seed && tokenize( (selector = compiled.selector || selector) );
+
+ results = results || [];
+
+ // Try to minimize operations if there is only one selector in the list and no seed
+ // (the latter of which guarantees us context)
+ if ( match.length === 1 ) {
+
+ // Reduce context if the leading compound selector is an ID
+ tokens = match[0] = match[0].slice( 0 );
+ if ( tokens.length > 2 && (token = tokens[0]).type === "ID" &&
+ context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) {
+
+ context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0];
+ if ( !context ) {
+ return results;
+
+ // Precompiled matchers will still verify ancestry, so step up a level
+ } else if ( compiled ) {
+ context = context.parentNode;
+ }
+
+ selector = selector.slice( tokens.shift().value.length );
+ }
+
+ // Fetch a seed set for right-to-left matching
+ i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length;
+ while ( i-- ) {
+ token = tokens[i];
+
+ // Abort if we hit a combinator
+ if ( Expr.relative[ (type = token.type) ] ) {
+ break;
+ }
+ if ( (find = Expr.find[ type ]) ) {
+ // Search, expanding context for leading sibling combinators
+ if ( (seed = find(
+ token.matches[0].replace( runescape, funescape ),
+ rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context
+ )) ) {
+
+ // If seed is empty or no tokens remain, we can return early
+ tokens.splice( i, 1 );
+ selector = seed.length && toSelector( tokens );
+ if ( !selector ) {
+ push.apply( results, seed );
+ return results;
+ }
+
+ break;
+ }
+ }
+ }
+ }
+
+ // Compile and execute a filtering function if one is not provided
+ // Provide `match` to avoid retokenization if we modified the selector above
+ ( compiled || compile( selector, match ) )(
+ seed,
+ context,
+ !documentIsHTML,
+ results,
+ !context || rsibling.test( selector ) && testContext( context.parentNode ) || context
+ );
+ return results;
+};
+
+// One-time assignments
+
+// Sort stability
+support.sortStable = expando.split("").sort( sortOrder ).join("") === expando;
+
+// Support: Chrome 14-35+
+// Always assume duplicates if they aren't passed to the comparison function
+support.detectDuplicates = !!hasDuplicate;
+
+// Initialize against the default document
+setDocument();
+
+// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27)
+// Detached nodes confoundingly follow *each other*
+support.sortDetached = assert(function( el ) {
+ // Should return 1, but returns 4 (following)
+ return el.compareDocumentPosition( document.createElement("fieldset") ) & 1;
+});
+
+// Support: IE<8
+// Prevent attribute/property "interpolation"
+// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx
+if ( !assert(function( el ) {
+ el.innerHTML = "<a href='#'></a>";
+ return el.firstChild.getAttribute("href") === "#" ;
+}) ) {
+ addHandle( "type|href|height|width", function( elem, name, isXML ) {
+ if ( !isXML ) {
+ return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 );
+ }
+ });
+}
+
+// Support: IE<9
+// Use defaultValue in place of getAttribute("value")
+if ( !support.attributes || !assert(function( el ) {
+ el.innerHTML = "<input/>";
+ el.firstChild.setAttribute( "value", "" );
+ return el.firstChild.getAttribute( "value" ) === "";
+}) ) {
+ addHandle( "value", function( elem, name, isXML ) {
+ if ( !isXML && elem.nodeName.toLowerCase() === "input" ) {
+ return elem.defaultValue;
+ }
+ });
+}
+
+// Support: IE<9
+// Use getAttributeNode to fetch booleans when getAttribute lies
+if ( !assert(function( el ) {
+ return el.getAttribute("disabled") == null;
+}) ) {
+ addHandle( booleans, function( elem, name, isXML ) {
+ var val;
+ if ( !isXML ) {
+ return elem[ name ] === true ? name.toLowerCase() :
+ (val = elem.getAttributeNode( name )) && val.specified ?
+ val.value :
+ null;
+ }
+ });
+}
+
+return Sizzle;
+
+})( window );
+
+
+
+jQuery.find = Sizzle;
+jQuery.expr = Sizzle.selectors;
+
+// Deprecated
+jQuery.expr[ ":" ] = jQuery.expr.pseudos;
+jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort;
+jQuery.text = Sizzle.getText;
+jQuery.isXMLDoc = Sizzle.isXML;
+jQuery.contains = Sizzle.contains;
+jQuery.escapeSelector = Sizzle.escape;
+
+
+
+
+var dir = function( elem, dir, until ) {
+ var matched = [],
+ truncate = until !== undefined;
+
+ while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) {
+ if ( elem.nodeType === 1 ) {
+ if ( truncate && jQuery( elem ).is( until ) ) {
+ break;
+ }
+ matched.push( elem );
+ }
+ }
+ return matched;
+};
+
+
+var siblings = function( n, elem ) {
+ var matched = [];
+
+ for ( ; n; n = n.nextSibling ) {
+ if ( n.nodeType === 1 && n !== elem ) {
+ matched.push( n );
+ }
+ }
+
+ return matched;
+};
+
+
+var rneedsContext = jQuery.expr.match.needsContext;
+
+
+
+function nodeName( elem, name ) {
+
+ return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase();
+
+};
+var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i );
+
+
+
+var risSimple = /^.[^:#\[\.,]*$/;
+
+// Implement the identical functionality for filter and not
+function winnow( elements, qualifier, not ) {
+ if ( jQuery.isFunction( qualifier ) ) {
+ return jQuery.grep( elements, function( elem, i ) {
+ return !!qualifier.call( elem, i, elem ) !== not;
+ } );
+ }
+
+ // Single element
+ if ( qualifier.nodeType ) {
+ return jQuery.grep( elements, function( elem ) {
+ return ( elem === qualifier ) !== not;
+ } );
+ }
+
+ // Arraylike of elements (jQuery, arguments, Array)
+ if ( typeof qualifier !== "string" ) {
+ return jQuery.grep( elements, function( elem ) {
+ return ( indexOf.call( qualifier, elem ) > -1 ) !== not;
+ } );
+ }
+
+ // Simple selector that can be filtered directly, removing non-Elements
+ if ( risSimple.test( qualifier ) ) {
+ return jQuery.filter( qualifier, elements, not );
+ }
+
+ // Complex selector, compare the two sets, removing non-Elements
+ qualifier = jQuery.filter( qualifier, elements );
+ return jQuery.grep( elements, function( elem ) {
+ return ( indexOf.call( qualifier, elem ) > -1 ) !== not && elem.nodeType === 1;
+ } );
+}
+
+jQuery.filter = function( expr, elems, not ) {
+ var elem = elems[ 0 ];
+
+ if ( not ) {
+ expr = ":not(" + expr + ")";
+ }
+
+ if ( elems.length === 1 && elem.nodeType === 1 ) {
+ return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [];
+ }
+
+ return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) {
+ return elem.nodeType === 1;
+ } ) );
+};
+
+jQuery.fn.extend( {
+ find: function( selector ) {
+ var i, ret,
+ len = this.length,
+ self = this;
+
+ if ( typeof selector !== "string" ) {
+ return this.pushStack( jQuery( selector ).filter( function() {
+ for ( i = 0; i < len; i++ ) {
+ if ( jQuery.contains( self[ i ], this ) ) {
+ return true;
+ }
+ }
+ } ) );
+ }
+
+ ret = this.pushStack( [] );
+
+ for ( i = 0; i < len; i++ ) {
+ jQuery.find( selector, self[ i ], ret );
+ }
+
+ return len > 1 ? jQuery.uniqueSort( ret ) : ret;
+ },
+ filter: function( selector ) {
+ return this.pushStack( winnow( this, selector || [], false ) );
+ },
+ not: function( selector ) {
+ return this.pushStack( winnow( this, selector || [], true ) );
+ },
+ is: function( selector ) {
+ return !!winnow(
+ this,
+
+ // If this is a positional/relative selector, check membership in the returned set
+ // so $("p:first").is("p:last") won't return true for a doc with two "p".
+ typeof selector === "string" && rneedsContext.test( selector ) ?
+ jQuery( selector ) :
+ selector || [],
+ false
+ ).length;
+ }
+} );
+
+
+// Initialize a jQuery object
+
+
+// A central reference to the root jQuery(document)
+var rootjQuery,
+
+ // A simple way to check for HTML strings
+ // Prioritize #id over <tag> to avoid XSS via location.hash (#9521)
+ // Strict HTML recognition (#11290: must start with <)
+ // Shortcut simple #id case for speed
+ rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,
+
+ init = jQuery.fn.init = function( selector, context, root ) {
+ var match, elem;
+
+ // HANDLE: $(""), $(null), $(undefined), $(false)
+ if ( !selector ) {
+ return this;
+ }
+
+ // Method init() accepts an alternate rootjQuery
+ // so migrate can support jQuery.sub (gh-2101)
+ root = root || rootjQuery;
+
+ // Handle HTML strings
+ if ( typeof selector === "string" ) {
+ if ( selector[ 0 ] === "<" &&
+ selector[ selector.length - 1 ] === ">" &&
+ selector.length >= 3 ) {
+
+ // Assume that strings that start and end with <> are HTML and skip the regex check
+ match = [ null, selector, null ];
+
+ } else {
+ match = rquickExpr.exec( selector );
+ }
+
+ // Match html or make sure no context is specified for #id
+ if ( match && ( match[ 1 ] || !context ) ) {
+
+ // HANDLE: $(html) -> $(array)
+ if ( match[ 1 ] ) {
+ context = context instanceof jQuery ? context[ 0 ] : context;
+
+ // Option to run scripts is true for back-compat
+ // Intentionally let the error be thrown if parseHTML is not present
+ jQuery.merge( this, jQuery.parseHTML(
+ match[ 1 ],
+ context && context.nodeType ? context.ownerDocument || context : document,
+ true
+ ) );
+
+ // HANDLE: $(html, props)
+ if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) {
+ for ( match in context ) {
+
+ // Properties of context are called as methods if possible
+ if ( jQuery.isFunction( this[ match ] ) ) {
+ this[ match ]( context[ match ] );
+
+ // ...and otherwise set as attributes
+ } else {
+ this.attr( match, context[ match ] );
+ }
+ }
+ }
+
+ return this;
+
+ // HANDLE: $(#id)
+ } else {
+ elem = document.getElementById( match[ 2 ] );
+
+ if ( elem ) {
+
+ // Inject the element directly into the jQuery object
+ this[ 0 ] = elem;
+ this.length = 1;
+ }
+ return this;
+ }
+
+ // HANDLE: $(expr, $(...))
+ } else if ( !context || context.jquery ) {
+ return ( context || root ).find( selector );
+
+ // HANDLE: $(expr, context)
+ // (which is just equivalent to: $(context).find(expr)
+ } else {
+ return this.constructor( context ).find( selector );
+ }
+
+ // HANDLE: $(DOMElement)
+ } else if ( selector.nodeType ) {
+ this[ 0 ] = selector;
+ this.length = 1;
+ return this;
+
+ // HANDLE: $(function)
+ // Shortcut for document ready
+ } else if ( jQuery.isFunction( selector ) ) {
+ return root.ready !== undefined ?
+ root.ready( selector ) :
+
+ // Execute immediately if ready is not present
+ selector( jQuery );
+ }
+
+ return jQuery.makeArray( selector, this );
+ };
+
+// Give the init function the jQuery prototype for later instantiation
+init.prototype = jQuery.fn;
+
+// Initialize central reference
+rootjQuery = jQuery( document );
+
+
+var rparentsprev = /^(?:parents|prev(?:Until|All))/,
+
+ // Methods guaranteed to produce a unique set when starting from a unique set
+ guaranteedUnique = {
+ children: true,
+ contents: true,
+ next: true,
+ prev: true
+ };
+
+jQuery.fn.extend( {
+ has: function( target ) {
+ var targets = jQuery( target, this ),
+ l = targets.length;
+
+ return this.filter( function() {
+ var i = 0;
+ for ( ; i < l; i++ ) {
+ if ( jQuery.contains( this, targets[ i ] ) ) {
+ return true;
+ }
+ }
+ } );
+ },
+
+ closest: function( selectors, context ) {
+ var cur,
+ i = 0,
+ l = this.length,
+ matched = [],
+ targets = typeof selectors !== "string" && jQuery( selectors );
+
+ // Positional selectors never match, since there's no _selection_ context
+ if ( !rneedsContext.test( selectors ) ) {
+ for ( ; i < l; i++ ) {
+ for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) {
+
+ // Always skip document fragments
+ if ( cur.nodeType < 11 && ( targets ?
+ targets.index( cur ) > -1 :
+
+ // Don't pass non-elements to Sizzle
+ cur.nodeType === 1 &&
+ jQuery.find.matchesSelector( cur, selectors ) ) ) {
+
+ matched.push( cur );
+ break;
+ }
+ }
+ }
+ }
+
+ return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched );
+ },
+
+ // Determine the position of an element within the set
+ index: function( elem ) {
+
+ // No argument, return index in parent
+ if ( !elem ) {
+ return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1;
+ }
+
+ // Index in selector
+ if ( typeof elem === "string" ) {
+ return indexOf.call( jQuery( elem ), this[ 0 ] );
+ }
+
+ // Locate the position of the desired element
+ return indexOf.call( this,
+
+ // If it receives a jQuery object, the first element is used
+ elem.jquery ? elem[ 0 ] : elem
+ );
+ },
+
+ add: function( selector, context ) {
+ return this.pushStack(
+ jQuery.uniqueSort(
+ jQuery.merge( this.get(), jQuery( selector, context ) )
+ )
+ );
+ },
+
+ addBack: function( selector ) {
+ return this.add( selector == null ?
+ this.prevObject : this.prevObject.filter( selector )
+ );
+ }
+} );
+
+function sibling( cur, dir ) {
+ while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {}
+ return cur;
+}
+
+jQuery.each( {
+ parent: function( elem ) {
+ var parent = elem.parentNode;
+ return parent && parent.nodeType !== 11 ? parent : null;
+ },
+ parents: function( elem ) {
+ return dir( elem, "parentNode" );
+ },
+ parentsUntil: function( elem, i, until ) {
+ return dir( elem, "parentNode", until );
+ },
+ next: function( elem ) {
+ return sibling( elem, "nextSibling" );
+ },
+ prev: function( elem ) {
+ return sibling( elem, "previousSibling" );
+ },
+ nextAll: function( elem ) {
+ return dir( elem, "nextSibling" );
+ },
+ prevAll: function( elem ) {
+ return dir( elem, "previousSibling" );
+ },
+ nextUntil: function( elem, i, until ) {
+ return dir( elem, "nextSibling", until );
+ },
+ prevUntil: function( elem, i, until ) {
+ return dir( elem, "previousSibling", until );
+ },
+ siblings: function( elem ) {
+ return siblings( ( elem.parentNode || {} ).firstChild, elem );
+ },
+ children: function( elem ) {
+ return siblings( elem.firstChild );
+ },
+ contents: function( elem ) {
+ if ( nodeName( elem, "iframe" ) ) {
+ return elem.contentDocument;
+ }
+
+ // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only
+ // Treat the template element as a regular one in browsers that
+ // don't support it.
+ if ( nodeName( elem, "template" ) ) {
+ elem = elem.content || elem;
+ }
+
+ return jQuery.merge( [], elem.childNodes );
+ }
+}, function( name, fn ) {
+ jQuery.fn[ name ] = function( until, selector ) {
+ var matched = jQuery.map( this, fn, until );
+
+ if ( name.slice( -5 ) !== "Until" ) {
+ selector = until;
+ }
+
+ if ( selector && typeof selector === "string" ) {
+ matched = jQuery.filter( selector, matched );
+ }
+
+ if ( this.length > 1 ) {
+
+ // Remove duplicates
+ if ( !guaranteedUnique[ name ] ) {
+ jQuery.uniqueSort( matched );
+ }
+
+ // Reverse order for parents* and prev-derivatives
+ if ( rparentsprev.test( name ) ) {
+ matched.reverse();
+ }
+ }
+
+ return this.pushStack( matched );
+ };
+} );
+var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g );
+
+
+
+// Convert String-formatted options into Object-formatted ones
+function createOptions( options ) {
+ var object = {};
+ jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) {
+ object[ flag ] = true;
+ } );
+ return object;
+}
+
+/*
+ * Create a callback list using the following parameters:
+ *
+ * options: an optional list of space-separated options that will change how
+ * the callback list behaves or a more traditional option object
+ *
+ * By default a callback list will act like an event callback list and can be
+ * "fired" multiple times.
+ *
+ * Possible options:
+ *
+ * once: will ensure the callback list can only be fired once (like a Deferred)
+ *
+ * memory: will keep track of previous values and will call any callback added
+ * after the list has been fired right away with the latest "memorized"
+ * values (like a Deferred)
+ *
+ * unique: will ensure a callback can only be added once (no duplicate in the list)
+ *
+ * stopOnFalse: interrupt callings when a callback returns false
+ *
+ */
+jQuery.Callbacks = function( options ) {
+
+ // Convert options from String-formatted to Object-formatted if needed
+ // (we check in cache first)
+ options = typeof options === "string" ?
+ createOptions( options ) :
+ jQuery.extend( {}, options );
+
+ var // Flag to know if list is currently firing
+ firing,
+
+ // Last fire value for non-forgettable lists
+ memory,
+
+ // Flag to know if list was already fired
+ fired,
+
+ // Flag to prevent firing
+ locked,
+
+ // Actual callback list
+ list = [],
+
+ // Queue of execution data for repeatable lists
+ queue = [],
+
+ // Index of currently firing callback (modified by add/remove as needed)
+ firingIndex = -1,
+
+ // Fire callbacks
+ fire = function() {
+
+ // Enforce single-firing
+ locked = locked || options.once;
+
+ // Execute callbacks for all pending executions,
+ // respecting firingIndex overrides and runtime changes
+ fired = firing = true;
+ for ( ; queue.length; firingIndex = -1 ) {
+ memory = queue.shift();
+ while ( ++firingIndex < list.length ) {
+
+ // Run callback and check for early termination
+ if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false &&
+ options.stopOnFalse ) {
+
+ // Jump to end and forget the data so .add doesn't re-fire
+ firingIndex = list.length;
+ memory = false;
+ }
+ }
+ }
+
+ // Forget the data if we're done with it
+ if ( !options.memory ) {
+ memory = false;
+ }
+
+ firing = false;
+
+ // Clean up if we're done firing for good
+ if ( locked ) {
+
+ // Keep an empty list if we have data for future add calls
+ if ( memory ) {
+ list = [];
+
+ // Otherwise, this object is spent
+ } else {
+ list = "";
+ }
+ }
+ },
+
+ // Actual Callbacks object
+ self = {
+
+ // Add a callback or a collection of callbacks to the list
+ add: function() {
+ if ( list ) {
+
+ // If we have memory from a past run, we should fire after adding
+ if ( memory && !firing ) {
+ firingIndex = list.length - 1;
+ queue.push( memory );
+ }
+
+ ( function add( args ) {
+ jQuery.each( args, function( _, arg ) {
+ if ( jQuery.isFunction( arg ) ) {
+ if ( !options.unique || !self.has( arg ) ) {
+ list.push( arg );
+ }
+ } else if ( arg && arg.length && jQuery.type( arg ) !== "string" ) {
+
+ // Inspect recursively
+ add( arg );
+ }
+ } );
+ } )( arguments );
+
+ if ( memory && !firing ) {
+ fire();
+ }
+ }
+ return this;
+ },
+
+ // Remove a callback from the list
+ remove: function() {
+ jQuery.each( arguments, function( _, arg ) {
+ var index;
+ while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) {
+ list.splice( index, 1 );
+
+ // Handle firing indexes
+ if ( index <= firingIndex ) {
+ firingIndex--;
+ }
+ }
+ } );
+ return this;
+ },
+
+ // Check if a given callback is in the list.
+ // If no argument is given, return whether or not list has callbacks attached.
+ has: function( fn ) {
+ return fn ?
+ jQuery.inArray( fn, list ) > -1 :
+ list.length > 0;
+ },
+
+ // Remove all callbacks from the list
+ empty: function() {
+ if ( list ) {
+ list = [];
+ }
+ return this;
+ },
+
+ // Disable .fire and .add
+ // Abort any current/pending executions
+ // Clear all callbacks and values
+ disable: function() {
+ locked = queue = [];
+ list = memory = "";
+ return this;
+ },
+ disabled: function() {
+ return !list;
+ },
+
+ // Disable .fire
+ // Also disable .add unless we have memory (since it would have no effect)
+ // Abort any pending executions
+ lock: function() {
+ locked = queue = [];
+ if ( !memory && !firing ) {
+ list = memory = "";
+ }
+ return this;
+ },
+ locked: function() {
+ return !!locked;
+ },
+
+ // Call all callbacks with the given context and arguments
+ fireWith: function( context, args ) {
+ if ( !locked ) {
+ args = args || [];
+ args = [ context, args.slice ? args.slice() : args ];
+ queue.push( args );
+ if ( !firing ) {
+ fire();
+ }
+ }
+ return this;
+ },
+
+ // Call all the callbacks with the given arguments
+ fire: function() {
+ self.fireWith( this, arguments );
+ return this;
+ },
+
+ // To know if the callbacks have already been called at least once
+ fired: function() {
+ return !!fired;
+ }
+ };
+
+ return self;
+};
+
+
+function Identity( v ) {
+ return v;
+}
+function Thrower( ex ) {
+ throw ex;
+}
+
+function adoptValue( value, resolve, reject, noValue ) {
+ var method;
+
+ try {
+
+ // Check for promise aspect first to privilege synchronous behavior
+ if ( value && jQuery.isFunction( ( method = value.promise ) ) ) {
+ method.call( value ).done( resolve ).fail( reject );
+
+ // Other thenables
+ } else if ( value && jQuery.isFunction( ( method = value.then ) ) ) {
+ method.call( value, resolve, reject );
+
+ // Other non-thenables
+ } else {
+
+ // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer:
+ // * false: [ value ].slice( 0 ) => resolve( value )
+ // * true: [ value ].slice( 1 ) => resolve()
+ resolve.apply( undefined, [ value ].slice( noValue ) );
+ }
+
+ // For Promises/A+, convert exceptions into rejections
+ // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in
+ // Deferred#then to conditionally suppress rejection.
+ } catch ( value ) {
+
+ // Support: Android 4.0 only
+ // Strict mode functions invoked without .call/.apply get global-object context
+ reject.apply( undefined, [ value ] );
+ }
+}
+
+jQuery.extend( {
+
+ Deferred: function( func ) {
+ var tuples = [
+
+ // action, add listener, callbacks,
+ // ... .then handlers, argument index, [final state]
+ [ "notify", "progress", jQuery.Callbacks( "memory" ),
+ jQuery.Callbacks( "memory" ), 2 ],
+ [ "resolve", "done", jQuery.Callbacks( "once memory" ),
+ jQuery.Callbacks( "once memory" ), 0, "resolved" ],
+ [ "reject", "fail", jQuery.Callbacks( "once memory" ),
+ jQuery.Callbacks( "once memory" ), 1, "rejected" ]
+ ],
+ state = "pending",
+ promise = {
+ state: function() {
+ return state;
+ },
+ always: function() {
+ deferred.done( arguments ).fail( arguments );
+ return this;
+ },
+ "catch": function( fn ) {
+ return promise.then( null, fn );
+ },
+
+ // Keep pipe for back-compat
+ pipe: function( /* fnDone, fnFail, fnProgress */ ) {
+ var fns = arguments;
+
+ return jQuery.Deferred( function( newDefer ) {
+ jQuery.each( tuples, function( i, tuple ) {
+
+ // Map tuples (progress, done, fail) to arguments (done, fail, progress)
+ var fn = jQuery.isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ];
+
+ // deferred.progress(function() { bind to newDefer or newDefer.notify })
+ // deferred.done(function() { bind to newDefer or newDefer.resolve })
+ // deferred.fail(function() { bind to newDefer or newDefer.reject })
+ deferred[ tuple[ 1 ] ]( function() {
+ var returned = fn && fn.apply( this, arguments );
+ if ( returned && jQuery.isFunction( returned.promise ) ) {
+ returned.promise()
+ .progress( newDefer.notify )
+ .done( newDefer.resolve )
+ .fail( newDefer.reject );
+ } else {
+ newDefer[ tuple[ 0 ] + "With" ](
+ this,
+ fn ? [ returned ] : arguments
+ );
+ }
+ } );
+ } );
+ fns = null;
+ } ).promise();
+ },
+ then: function( onFulfilled, onRejected, onProgress ) {
+ var maxDepth = 0;
+ function resolve( depth, deferred, handler, special ) {
+ return function() {
+ var that = this,
+ args = arguments,
+ mightThrow = function() {
+ var returned, then;
+
+ // Support: Promises/A+ section 2.3.3.3.3
+ // https://promisesaplus.com/#point-59
+ // Ignore double-resolution attempts
+ if ( depth < maxDepth ) {
+ return;
+ }
+
+ returned = handler.apply( that, args );
+
+ // Support: Promises/A+ section 2.3.1
+ // https://promisesaplus.com/#point-48
+ if ( returned === deferred.promise() ) {
+ throw new TypeError( "Thenable self-resolution" );
+ }
+
+ // Support: Promises/A+ sections 2.3.3.1, 3.5
+ // https://promisesaplus.com/#point-54
+ // https://promisesaplus.com/#point-75
+ // Retrieve `then` only once
+ then = returned &&
+
+ // Support: Promises/A+ section 2.3.4
+ // https://promisesaplus.com/#point-64
+ // Only check objects and functions for thenability
+ ( typeof returned === "object" ||
+ typeof returned === "function" ) &&
+ returned.then;
+
+ // Handle a returned thenable
+ if ( jQuery.isFunction( then ) ) {
+
+ // Special processors (notify) just wait for resolution
+ if ( special ) {
+ then.call(
+ returned,
+ resolve( maxDepth, deferred, Identity, special ),
+ resolve( maxDepth, deferred, Thrower, special )
+ );
+
+ // Normal processors (resolve) also hook into progress
+ } else {
+
+ // ...and disregard older resolution values
+ maxDepth++;
+
+ then.call(
+ returned,
+ resolve( maxDepth, deferred, Identity, special ),
+ resolve( maxDepth, deferred, Thrower, special ),
+ resolve( maxDepth, deferred, Identity,
+ deferred.notifyWith )
+ );
+ }
+
+ // Handle all other returned values
+ } else {
+
+ // Only substitute handlers pass on context
+ // and multiple values (non-spec behavior)
+ if ( handler !== Identity ) {
+ that = undefined;
+ args = [ returned ];
+ }
+
+ // Process the value(s)
+ // Default process is resolve
+ ( special || deferred.resolveWith )( that, args );
+ }
+ },
+
+ // Only normal processors (resolve) catch and reject exceptions
+ process = special ?
+ mightThrow :
+ function() {
+ try {
+ mightThrow();
+ } catch ( e ) {
+
+ if ( jQuery.Deferred.exceptionHook ) {
+ jQuery.Deferred.exceptionHook( e,
+ process.stackTrace );
+ }
+
+ // Support: Promises/A+ section 2.3.3.3.4.1
+ // https://promisesaplus.com/#point-61
+ // Ignore post-resolution exceptions
+ if ( depth + 1 >= maxDepth ) {
+
+ // Only substitute handlers pass on context
+ // and multiple values (non-spec behavior)
+ if ( handler !== Thrower ) {
+ that = undefined;
+ args = [ e ];
+ }
+
+ deferred.rejectWith( that, args );
+ }
+ }
+ };
+
+ // Support: Promises/A+ section 2.3.3.3.1
+ // https://promisesaplus.com/#point-57
+ // Re-resolve promises immediately to dodge false rejection from
+ // subsequent errors
+ if ( depth ) {
+ process();
+ } else {
+
+ // Call an optional hook to record the stack, in case of exception
+ // since it's otherwise lost when execution goes async
+ if ( jQuery.Deferred.getStackHook ) {
+ process.stackTrace = jQuery.Deferred.getStackHook();
+ }
+ window.setTimeout( process );
+ }
+ };
+ }
+
+ return jQuery.Deferred( function( newDefer ) {
+
+ // progress_handlers.add( ... )
+ tuples[ 0 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ jQuery.isFunction( onProgress ) ?
+ onProgress :
+ Identity,
+ newDefer.notifyWith
+ )
+ );
+
+ // fulfilled_handlers.add( ... )
+ tuples[ 1 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ jQuery.isFunction( onFulfilled ) ?
+ onFulfilled :
+ Identity
+ )
+ );
+
+ // rejected_handlers.add( ... )
+ tuples[ 2 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ jQuery.isFunction( onRejected ) ?
+ onRejected :
+ Thrower
+ )
+ );
+ } ).promise();
+ },
+
+ // Get a promise for this deferred
+ // If obj is provided, the promise aspect is added to the object
+ promise: function( obj ) {
+ return obj != null ? jQuery.extend( obj, promise ) : promise;
+ }
+ },
+ deferred = {};
+
+ // Add list-specific methods
+ jQuery.each( tuples, function( i, tuple ) {
+ var list = tuple[ 2 ],
+ stateString = tuple[ 5 ];
+
+ // promise.progress = list.add
+ // promise.done = list.add
+ // promise.fail = list.add
+ promise[ tuple[ 1 ] ] = list.add;
+
+ // Handle state
+ if ( stateString ) {
+ list.add(
+ function() {
+
+ // state = "resolved" (i.e., fulfilled)
+ // state = "rejected"
+ state = stateString;
+ },
+
+ // rejected_callbacks.disable
+ // fulfilled_callbacks.disable
+ tuples[ 3 - i ][ 2 ].disable,
+
+ // progress_callbacks.lock
+ tuples[ 0 ][ 2 ].lock
+ );
+ }
+
+ // progress_handlers.fire
+ // fulfilled_handlers.fire
+ // rejected_handlers.fire
+ list.add( tuple[ 3 ].fire );
+
+ // deferred.notify = function() { deferred.notifyWith(...) }
+ // deferred.resolve = function() { deferred.resolveWith(...) }
+ // deferred.reject = function() { deferred.rejectWith(...) }
+ deferred[ tuple[ 0 ] ] = function() {
+ deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments );
+ return this;
+ };
+
+ // deferred.notifyWith = list.fireWith
+ // deferred.resolveWith = list.fireWith
+ // deferred.rejectWith = list.fireWith
+ deferred[ tuple[ 0 ] + "With" ] = list.fireWith;
+ } );
+
+ // Make the deferred a promise
+ promise.promise( deferred );
+
+ // Call given func if any
+ if ( func ) {
+ func.call( deferred, deferred );
+ }
+
+ // All done!
+ return deferred;
+ },
+
+ // Deferred helper
+ when: function( singleValue ) {
+ var
+
+ // count of uncompleted subordinates
+ remaining = arguments.length,
+
+ // count of unprocessed arguments
+ i = remaining,
+
+ // subordinate fulfillment data
+ resolveContexts = Array( i ),
+ resolveValues = slice.call( arguments ),
+
+ // the master Deferred
+ master = jQuery.Deferred(),
+
+ // subordinate callback factory
+ updateFunc = function( i ) {
+ return function( value ) {
+ resolveContexts[ i ] = this;
+ resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value;
+ if ( !( --remaining ) ) {
+ master.resolveWith( resolveContexts, resolveValues );
+ }
+ };
+ };
+
+ // Single- and empty arguments are adopted like Promise.resolve
+ if ( remaining <= 1 ) {
+ adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject,
+ !remaining );
+
+ // Use .then() to unwrap secondary thenables (cf. gh-3000)
+ if ( master.state() === "pending" ||
+ jQuery.isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) {
+
+ return master.then();
+ }
+ }
+
+ // Multiple arguments are aggregated like Promise.all array elements
+ while ( i-- ) {
+ adoptValue( resolveValues[ i ], updateFunc( i ), master.reject );
+ }
+
+ return master.promise();
+ }
+} );
+
+
+// These usually indicate a programmer mistake during development,
+// warn about them ASAP rather than swallowing them by default.
+var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;
+
+jQuery.Deferred.exceptionHook = function( error, stack ) {
+
+ // Support: IE 8 - 9 only
+ // Console exists when dev tools are open, which can happen at any time
+ if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) {
+ window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack );
+ }
+};
+
+
+
+
+jQuery.readyException = function( error ) {
+ window.setTimeout( function() {
+ throw error;
+ } );
+};
+
+
+
+
+// The deferred used on DOM ready
+var readyList = jQuery.Deferred();
+
+jQuery.fn.ready = function( fn ) {
+
+ readyList
+ .then( fn )
+
+ // Wrap jQuery.readyException in a function so that the lookup
+ // happens at the time of error handling instead of callback
+ // registration.
+ .catch( function( error ) {
+ jQuery.readyException( error );
+ } );
+
+ return this;
+};
+
+jQuery.extend( {
+
+ // Is the DOM ready to be used? Set to true once it occurs.
+ isReady: false,
+
+ // A counter to track how many items to wait for before
+ // the ready event fires. See #6781
+ readyWait: 1,
+
+ // Handle when the DOM is ready
+ ready: function( wait ) {
+
+ // Abort if there are pending holds or we're already ready
+ if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) {
+ return;
+ }
+
+ // Remember that the DOM is ready
+ jQuery.isReady = true;
+
+ // If a normal DOM Ready event fired, decrement, and wait if need be
+ if ( wait !== true && --jQuery.readyWait > 0 ) {
+ return;
+ }
+
+ // If there are functions bound, to execute
+ readyList.resolveWith( document, [ jQuery ] );
+ }
+} );
+
+jQuery.ready.then = readyList.then;
+
+// The ready event handler and self cleanup method
+function completed() {
+ document.removeEventListener( "DOMContentLoaded", completed );
+ window.removeEventListener( "load", completed );
+ jQuery.ready();
+}
+
+// Catch cases where $(document).ready() is called
+// after the browser event has already occurred.
+// Support: IE <=9 - 10 only
+// Older IE sometimes signals "interactive" too soon
+if ( document.readyState === "complete" ||
+ ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) {
+
+ // Handle it asynchronously to allow scripts the opportunity to delay ready
+ window.setTimeout( jQuery.ready );
+
+} else {
+
+ // Use the handy event callback
+ document.addEventListener( "DOMContentLoaded", completed );
+
+ // A fallback to window.onload, that will always work
+ window.addEventListener( "load", completed );
+}
+
+
+
+
+// Multifunctional method to get and set values of a collection
+// The value/s can optionally be executed if it's a function
+var access = function( elems, fn, key, value, chainable, emptyGet, raw ) {
+ var i = 0,
+ len = elems.length,
+ bulk = key == null;
+
+ // Sets many values
+ if ( jQuery.type( key ) === "object" ) {
+ chainable = true;
+ for ( i in key ) {
+ access( elems, fn, i, key[ i ], true, emptyGet, raw );
+ }
+
+ // Sets one value
+ } else if ( value !== undefined ) {
+ chainable = true;
+
+ if ( !jQuery.isFunction( value ) ) {
+ raw = true;
+ }
+
+ if ( bulk ) {
+
+ // Bulk operations run against the entire set
+ if ( raw ) {
+ fn.call( elems, value );
+ fn = null;
+
+ // ...except when executing function values
+ } else {
+ bulk = fn;
+ fn = function( elem, key, value ) {
+ return bulk.call( jQuery( elem ), value );
+ };
+ }
+ }
+
+ if ( fn ) {
+ for ( ; i < len; i++ ) {
+ fn(
+ elems[ i ], key, raw ?
+ value :
+ value.call( elems[ i ], i, fn( elems[ i ], key ) )
+ );
+ }
+ }
+ }
+
+ if ( chainable ) {
+ return elems;
+ }
+
+ // Gets
+ if ( bulk ) {
+ return fn.call( elems );
+ }
+
+ return len ? fn( elems[ 0 ], key ) : emptyGet;
+};
+var acceptData = function( owner ) {
+
+ // Accepts only:
+ // - Node
+ // - Node.ELEMENT_NODE
+ // - Node.DOCUMENT_NODE
+ // - Object
+ // - Any
+ return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType );
+};
+
+
+
+
+function Data() {
+ this.expando = jQuery.expando + Data.uid++;
+}
+
+Data.uid = 1;
+
+Data.prototype = {
+
+ cache: function( owner ) {
+
+ // Check if the owner object already has a cache
+ var value = owner[ this.expando ];
+
+ // If not, create one
+ if ( !value ) {
+ value = {};
+
+ // We can accept data for non-element nodes in modern browsers,
+ // but we should not, see #8335.
+ // Always return an empty object.
+ if ( acceptData( owner ) ) {
+
+ // If it is a node unlikely to be stringify-ed or looped over
+ // use plain assignment
+ if ( owner.nodeType ) {
+ owner[ this.expando ] = value;
+
+ // Otherwise secure it in a non-enumerable property
+ // configurable must be true to allow the property to be
+ // deleted when data is removed
+ } else {
+ Object.defineProperty( owner, this.expando, {
+ value: value,
+ configurable: true
+ } );
+ }
+ }
+ }
+
+ return value;
+ },
+ set: function( owner, data, value ) {
+ var prop,
+ cache = this.cache( owner );
+
+ // Handle: [ owner, key, value ] args
+ // Always use camelCase key (gh-2257)
+ if ( typeof data === "string" ) {
+ cache[ jQuery.camelCase( data ) ] = value;
+
+ // Handle: [ owner, { properties } ] args
+ } else {
+
+ // Copy the properties one-by-one to the cache object
+ for ( prop in data ) {
+ cache[ jQuery.camelCase( prop ) ] = data[ prop ];
+ }
+ }
+ return cache;
+ },
+ get: function( owner, key ) {
+ return key === undefined ?
+ this.cache( owner ) :
+
+ // Always use camelCase key (gh-2257)
+ owner[ this.expando ] && owner[ this.expando ][ jQuery.camelCase( key ) ];
+ },
+ access: function( owner, key, value ) {
+
+ // In cases where either:
+ //
+ // 1. No key was specified
+ // 2. A string key was specified, but no value provided
+ //
+ // Take the "read" path and allow the get method to determine
+ // which value to return, respectively either:
+ //
+ // 1. The entire cache object
+ // 2. The data stored at the key
+ //
+ if ( key === undefined ||
+ ( ( key && typeof key === "string" ) && value === undefined ) ) {
+
+ return this.get( owner, key );
+ }
+
+ // When the key is not a string, or both a key and value
+ // are specified, set or extend (existing objects) with either:
+ //
+ // 1. An object of properties
+ // 2. A key and value
+ //
+ this.set( owner, key, value );
+
+ // Since the "set" path can have two possible entry points
+ // return the expected data based on which path was taken[*]
+ return value !== undefined ? value : key;
+ },
+ remove: function( owner, key ) {
+ var i,
+ cache = owner[ this.expando ];
+
+ if ( cache === undefined ) {
+ return;
+ }
+
+ if ( key !== undefined ) {
+
+ // Support array or space separated string of keys
+ if ( Array.isArray( key ) ) {
+
+ // If key is an array of keys...
+ // We always set camelCase keys, so remove that.
+ key = key.map( jQuery.camelCase );
+ } else {
+ key = jQuery.camelCase( key );
+
+ // If a key with the spaces exists, use it.
+ // Otherwise, create an array by matching non-whitespace
+ key = key in cache ?
+ [ key ] :
+ ( key.match( rnothtmlwhite ) || [] );
+ }
+
+ i = key.length;
+
+ while ( i-- ) {
+ delete cache[ key[ i ] ];
+ }
+ }
+
+ // Remove the expando if there's no more data
+ if ( key === undefined || jQuery.isEmptyObject( cache ) ) {
+
+ // Support: Chrome <=35 - 45
+ // Webkit & Blink performance suffers when deleting properties
+ // from DOM nodes, so set to undefined instead
+ // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted)
+ if ( owner.nodeType ) {
+ owner[ this.expando ] = undefined;
+ } else {
+ delete owner[ this.expando ];
+ }
+ }
+ },
+ hasData: function( owner ) {
+ var cache = owner[ this.expando ];
+ return cache !== undefined && !jQuery.isEmptyObject( cache );
+ }
+};
+var dataPriv = new Data();
+
+var dataUser = new Data();
+
+
+
+// Implementation Summary
+//
+// 1. Enforce API surface and semantic compatibility with 1.9.x branch
+// 2. Improve the module's maintainability by reducing the storage
+// paths to a single mechanism.
+// 3. Use the same single mechanism to support "private" and "user" data.
+// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData)
+// 5. Avoid exposing implementation details on user objects (eg. expando properties)
+// 6. Provide a clear path for implementation upgrade to WeakMap in 2014
+
+var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,
+ rmultiDash = /[A-Z]/g;
+
+function getData( data ) {
+ if ( data === "true" ) {
+ return true;
+ }
+
+ if ( data === "false" ) {
+ return false;
+ }
+
+ if ( data === "null" ) {
+ return null;
+ }
+
+ // Only convert to a number if it doesn't change the string
+ if ( data === +data + "" ) {
+ return +data;
+ }
+
+ if ( rbrace.test( data ) ) {
+ return JSON.parse( data );
+ }
+
+ return data;
+}
+
+function dataAttr( elem, key, data ) {
+ var name;
+
+ // If nothing was found internally, try to fetch any
+ // data from the HTML5 data-* attribute
+ if ( data === undefined && elem.nodeType === 1 ) {
+ name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase();
+ data = elem.getAttribute( name );
+
+ if ( typeof data === "string" ) {
+ try {
+ data = getData( data );
+ } catch ( e ) {}
+
+ // Make sure we set the data so it isn't changed later
+ dataUser.set( elem, key, data );
+ } else {
+ data = undefined;
+ }
+ }
+ return data;
+}
+
+jQuery.extend( {
+ hasData: function( elem ) {
+ return dataUser.hasData( elem ) || dataPriv.hasData( elem );
+ },
+
+ data: function( elem, name, data ) {
+ return dataUser.access( elem, name, data );
+ },
+
+ removeData: function( elem, name ) {
+ dataUser.remove( elem, name );
+ },
+
+ // TODO: Now that all calls to _data and _removeData have been replaced
+ // with direct calls to dataPriv methods, these can be deprecated.
+ _data: function( elem, name, data ) {
+ return dataPriv.access( elem, name, data );
+ },
+
+ _removeData: function( elem, name ) {
+ dataPriv.remove( elem, name );
+ }
+} );
+
+jQuery.fn.extend( {
+ data: function( key, value ) {
+ var i, name, data,
+ elem = this[ 0 ],
+ attrs = elem && elem.attributes;
+
+ // Gets all values
+ if ( key === undefined ) {
+ if ( this.length ) {
+ data = dataUser.get( elem );
+
+ if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) {
+ i = attrs.length;
+ while ( i-- ) {
+
+ // Support: IE 11 only
+ // The attrs elements can be null (#14894)
+ if ( attrs[ i ] ) {
+ name = attrs[ i ].name;
+ if ( name.indexOf( "data-" ) === 0 ) {
+ name = jQuery.camelCase( name.slice( 5 ) );
+ dataAttr( elem, name, data[ name ] );
+ }
+ }
+ }
+ dataPriv.set( elem, "hasDataAttrs", true );
+ }
+ }
+
+ return data;
+ }
+
+ // Sets multiple values
+ if ( typeof key === "object" ) {
+ return this.each( function() {
+ dataUser.set( this, key );
+ } );
+ }
+
+ return access( this, function( value ) {
+ var data;
+
+ // The calling jQuery object (element matches) is not empty
+ // (and therefore has an element appears at this[ 0 ]) and the
+ // `value` parameter was not undefined. An empty jQuery object
+ // will result in `undefined` for elem = this[ 0 ] which will
+ // throw an exception if an attempt to read a data cache is made.
+ if ( elem && value === undefined ) {
+
+ // Attempt to get data from the cache
+ // The key will always be camelCased in Data
+ data = dataUser.get( elem, key );
+ if ( data !== undefined ) {
+ return data;
+ }
+
+ // Attempt to "discover" the data in
+ // HTML5 custom data-* attrs
+ data = dataAttr( elem, key );
+ if ( data !== undefined ) {
+ return data;
+ }
+
+ // We tried really hard, but the data doesn't exist.
+ return;
+ }
+
+ // Set the data...
+ this.each( function() {
+
+ // We always store the camelCased key
+ dataUser.set( this, key, value );
+ } );
+ }, null, value, arguments.length > 1, null, true );
+ },
+
+ removeData: function( key ) {
+ return this.each( function() {
+ dataUser.remove( this, key );
+ } );
+ }
+} );
+
+
+jQuery.extend( {
+ queue: function( elem, type, data ) {
+ var queue;
+
+ if ( elem ) {
+ type = ( type || "fx" ) + "queue";
+ queue = dataPriv.get( elem, type );
+
+ // Speed up dequeue by getting out quickly if this is just a lookup
+ if ( data ) {
+ if ( !queue || Array.isArray( data ) ) {
+ queue = dataPriv.access( elem, type, jQuery.makeArray( data ) );
+ } else {
+ queue.push( data );
+ }
+ }
+ return queue || [];
+ }
+ },
+
+ dequeue: function( elem, type ) {
+ type = type || "fx";
+
+ var queue = jQuery.queue( elem, type ),
+ startLength = queue.length,
+ fn = queue.shift(),
+ hooks = jQuery._queueHooks( elem, type ),
+ next = function() {
+ jQuery.dequeue( elem, type );
+ };
+
+ // If the fx queue is dequeued, always remove the progress sentinel
+ if ( fn === "inprogress" ) {
+ fn = queue.shift();
+ startLength--;
+ }
+
+ if ( fn ) {
+
+ // Add a progress sentinel to prevent the fx queue from being
+ // automatically dequeued
+ if ( type === "fx" ) {
+ queue.unshift( "inprogress" );
+ }
+
+ // Clear up the last queue stop function
+ delete hooks.stop;
+ fn.call( elem, next, hooks );
+ }
+
+ if ( !startLength && hooks ) {
+ hooks.empty.fire();
+ }
+ },
+
+ // Not public - generate a queueHooks object, or return the current one
+ _queueHooks: function( elem, type ) {
+ var key = type + "queueHooks";
+ return dataPriv.get( elem, key ) || dataPriv.access( elem, key, {
+ empty: jQuery.Callbacks( "once memory" ).add( function() {
+ dataPriv.remove( elem, [ type + "queue", key ] );
+ } )
+ } );
+ }
+} );
+
+jQuery.fn.extend( {
+ queue: function( type, data ) {
+ var setter = 2;
+
+ if ( typeof type !== "string" ) {
+ data = type;
+ type = "fx";
+ setter--;
+ }
+
+ if ( arguments.length < setter ) {
+ return jQuery.queue( this[ 0 ], type );
+ }
+
+ return data === undefined ?
+ this :
+ this.each( function() {
+ var queue = jQuery.queue( this, type, data );
+
+ // Ensure a hooks for this queue
+ jQuery._queueHooks( this, type );
+
+ if ( type === "fx" && queue[ 0 ] !== "inprogress" ) {
+ jQuery.dequeue( this, type );
+ }
+ } );
+ },
+ dequeue: function( type ) {
+ return this.each( function() {
+ jQuery.dequeue( this, type );
+ } );
+ },
+ clearQueue: function( type ) {
+ return this.queue( type || "fx", [] );
+ },
+
+ // Get a promise resolved when queues of a certain type
+ // are emptied (fx is the type by default)
+ promise: function( type, obj ) {
+ var tmp,
+ count = 1,
+ defer = jQuery.Deferred(),
+ elements = this,
+ i = this.length,
+ resolve = function() {
+ if ( !( --count ) ) {
+ defer.resolveWith( elements, [ elements ] );
+ }
+ };
+
+ if ( typeof type !== "string" ) {
+ obj = type;
+ type = undefined;
+ }
+ type = type || "fx";
+
+ while ( i-- ) {
+ tmp = dataPriv.get( elements[ i ], type + "queueHooks" );
+ if ( tmp && tmp.empty ) {
+ count++;
+ tmp.empty.add( resolve );
+ }
+ }
+ resolve();
+ return defer.promise( obj );
+ }
+} );
+var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source;
+
+var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" );
+
+
+var cssExpand = [ "Top", "Right", "Bottom", "Left" ];
+
+var isHiddenWithinTree = function( elem, el ) {
+
+ // isHiddenWithinTree might be called from jQuery#filter function;
+ // in that case, element will be second argument
+ elem = el || elem;
+
+ // Inline style trumps all
+ return elem.style.display === "none" ||
+ elem.style.display === "" &&
+
+ // Otherwise, check computed style
+ // Support: Firefox <=43 - 45
+ // Disconnected elements can have computed display: none, so first confirm that elem is
+ // in the document.
+ jQuery.contains( elem.ownerDocument, elem ) &&
+
+ jQuery.css( elem, "display" ) === "none";
+ };
+
+var swap = function( elem, options, callback, args ) {
+ var ret, name,
+ old = {};
+
+ // Remember the old values, and insert the new ones
+ for ( name in options ) {
+ old[ name ] = elem.style[ name ];
+ elem.style[ name ] = options[ name ];
+ }
+
+ ret = callback.apply( elem, args || [] );
+
+ // Revert the old values
+ for ( name in options ) {
+ elem.style[ name ] = old[ name ];
+ }
+
+ return ret;
+};
+
+
+
+
+function adjustCSS( elem, prop, valueParts, tween ) {
+ var adjusted,
+ scale = 1,
+ maxIterations = 20,
+ currentValue = tween ?
+ function() {
+ return tween.cur();
+ } :
+ function() {
+ return jQuery.css( elem, prop, "" );
+ },
+ initial = currentValue(),
+ unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ),
+
+ // Starting value computation is required for potential unit mismatches
+ initialInUnit = ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) &&
+ rcssNum.exec( jQuery.css( elem, prop ) );
+
+ if ( initialInUnit && initialInUnit[ 3 ] !== unit ) {
+
+ // Trust units reported by jQuery.css
+ unit = unit || initialInUnit[ 3 ];
+
+ // Make sure we update the tween properties later on
+ valueParts = valueParts || [];
+
+ // Iteratively approximate from a nonzero starting point
+ initialInUnit = +initial || 1;
+
+ do {
+
+ // If previous iteration zeroed out, double until we get *something*.
+ // Use string for doubling so we don't accidentally see scale as unchanged below
+ scale = scale || ".5";
+
+ // Adjust and apply
+ initialInUnit = initialInUnit / scale;
+ jQuery.style( elem, prop, initialInUnit + unit );
+
+ // Update scale, tolerating zero or NaN from tween.cur()
+ // Break the loop if scale is unchanged or perfect, or if we've just had enough.
+ } while (
+ scale !== ( scale = currentValue() / initial ) && scale !== 1 && --maxIterations
+ );
+ }
+
+ if ( valueParts ) {
+ initialInUnit = +initialInUnit || +initial || 0;
+
+ // Apply relative offset (+=/-=) if specified
+ adjusted = valueParts[ 1 ] ?
+ initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] :
+ +valueParts[ 2 ];
+ if ( tween ) {
+ tween.unit = unit;
+ tween.start = initialInUnit;
+ tween.end = adjusted;
+ }
+ }
+ return adjusted;
+}
+
+
+var defaultDisplayMap = {};
+
+function getDefaultDisplay( elem ) {
+ var temp,
+ doc = elem.ownerDocument,
+ nodeName = elem.nodeName,
+ display = defaultDisplayMap[ nodeName ];
+
+ if ( display ) {
+ return display;
+ }
+
+ temp = doc.body.appendChild( doc.createElement( nodeName ) );
+ display = jQuery.css( temp, "display" );
+
+ temp.parentNode.removeChild( temp );
+
+ if ( display === "none" ) {
+ display = "block";
+ }
+ defaultDisplayMap[ nodeName ] = display;
+
+ return display;
+}
+
+function showHide( elements, show ) {
+ var display, elem,
+ values = [],
+ index = 0,
+ length = elements.length;
+
+ // Determine new display value for elements that need to change
+ for ( ; index < length; index++ ) {
+ elem = elements[ index ];
+ if ( !elem.style ) {
+ continue;
+ }
+
+ display = elem.style.display;
+ if ( show ) {
+
+ // Since we force visibility upon cascade-hidden elements, an immediate (and slow)
+ // check is required in this first loop unless we have a nonempty display value (either
+ // inline or about-to-be-restored)
+ if ( display === "none" ) {
+ values[ index ] = dataPriv.get( elem, "display" ) || null;
+ if ( !values[ index ] ) {
+ elem.style.display = "";
+ }
+ }
+ if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) {
+ values[ index ] = getDefaultDisplay( elem );
+ }
+ } else {
+ if ( display !== "none" ) {
+ values[ index ] = "none";
+
+ // Remember what we're overwriting
+ dataPriv.set( elem, "display", display );
+ }
+ }
+ }
+
+ // Set the display of the elements in a second loop to avoid constant reflow
+ for ( index = 0; index < length; index++ ) {
+ if ( values[ index ] != null ) {
+ elements[ index ].style.display = values[ index ];
+ }
+ }
+
+ return elements;
+}
+
+jQuery.fn.extend( {
+ show: function() {
+ return showHide( this, true );
+ },
+ hide: function() {
+ return showHide( this );
+ },
+ toggle: function( state ) {
+ if ( typeof state === "boolean" ) {
+ return state ? this.show() : this.hide();
+ }
+
+ return this.each( function() {
+ if ( isHiddenWithinTree( this ) ) {
+ jQuery( this ).show();
+ } else {
+ jQuery( this ).hide();
+ }
+ } );
+ }
+} );
+var rcheckableType = ( /^(?:checkbox|radio)$/i );
+
+var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]+)/i );
+
+var rscriptType = ( /^$|\/(?:java|ecma)script/i );
+
+
+
+// We have to close these tags to support XHTML (#13200)
+var wrapMap = {
+
+ // Support: IE <=9 only
+ option: [ 1, "<select multiple='multiple'>", "</select>" ],
+
+ // XHTML parsers do not magically insert elements in the
+ // same way that tag soup parsers do. So we cannot shorten
+ // this by omitting <tbody> or other required elements.
+ thead: [ 1, "<table>", "</table>" ],
+ col: [ 2, "<table><colgroup>", "</colgroup></table>" ],
+ tr: [ 2, "<table><tbody>", "</tbody></table>" ],
+ td: [ 3, "<table><tbody><tr>", "</tr></tbody></table>" ],
+
+ _default: [ 0, "", "" ]
+};
+
+// Support: IE <=9 only
+wrapMap.optgroup = wrapMap.option;
+
+wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;
+wrapMap.th = wrapMap.td;
+
+
+function getAll( context, tag ) {
+
+ // Support: IE <=9 - 11 only
+ // Use typeof to avoid zero-argument method invocation on host objects (#15151)
+ var ret;
+
+ if ( typeof context.getElementsByTagName !== "undefined" ) {
+ ret = context.getElementsByTagName( tag || "*" );
+
+ } else if ( typeof context.querySelectorAll !== "undefined" ) {
+ ret = context.querySelectorAll( tag || "*" );
+
+ } else {
+ ret = [];
+ }
+
+ if ( tag === undefined || tag && nodeName( context, tag ) ) {
+ return jQuery.merge( [ context ], ret );
+ }
+
+ return ret;
+}
+
+
+// Mark scripts as having already been evaluated
+function setGlobalEval( elems, refElements ) {
+ var i = 0,
+ l = elems.length;
+
+ for ( ; i < l; i++ ) {
+ dataPriv.set(
+ elems[ i ],
+ "globalEval",
+ !refElements || dataPriv.get( refElements[ i ], "globalEval" )
+ );
+ }
+}
+
+
+var rhtml = /<|&#?\w+;/;
+
+function buildFragment( elems, context, scripts, selection, ignored ) {
+ var elem, tmp, tag, wrap, contains, j,
+ fragment = context.createDocumentFragment(),
+ nodes = [],
+ i = 0,
+ l = elems.length;
+
+ for ( ; i < l; i++ ) {
+ elem = elems[ i ];
+
+ if ( elem || elem === 0 ) {
+
+ // Add nodes directly
+ if ( jQuery.type( elem ) === "object" ) {
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem );
+
+ // Convert non-html into a text node
+ } else if ( !rhtml.test( elem ) ) {
+ nodes.push( context.createTextNode( elem ) );
+
+ // Convert html into DOM nodes
+ } else {
+ tmp = tmp || fragment.appendChild( context.createElement( "div" ) );
+
+ // Deserialize a standard representation
+ tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase();
+ wrap = wrapMap[ tag ] || wrapMap._default;
+ tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ];
+
+ // Descend through wrappers to the right content
+ j = wrap[ 0 ];
+ while ( j-- ) {
+ tmp = tmp.lastChild;
+ }
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( nodes, tmp.childNodes );
+
+ // Remember the top-level container
+ tmp = fragment.firstChild;
+
+ // Ensure the created nodes are orphaned (#12392)
+ tmp.textContent = "";
+ }
+ }
+ }
+
+ // Remove wrapper from fragment
+ fragment.textContent = "";
+
+ i = 0;
+ while ( ( elem = nodes[ i++ ] ) ) {
+
+ // Skip elements already in the context collection (trac-4087)
+ if ( selection && jQuery.inArray( elem, selection ) > -1 ) {
+ if ( ignored ) {
+ ignored.push( elem );
+ }
+ continue;
+ }
+
+ contains = jQuery.contains( elem.ownerDocument, elem );
+
+ // Append to fragment
+ tmp = getAll( fragment.appendChild( elem ), "script" );
+
+ // Preserve script evaluation history
+ if ( contains ) {
+ setGlobalEval( tmp );
+ }
+
+ // Capture executables
+ if ( scripts ) {
+ j = 0;
+ while ( ( elem = tmp[ j++ ] ) ) {
+ if ( rscriptType.test( elem.type || "" ) ) {
+ scripts.push( elem );
+ }
+ }
+ }
+ }
+
+ return fragment;
+}
+
+
+( function() {
+ var fragment = document.createDocumentFragment(),
+ div = fragment.appendChild( document.createElement( "div" ) ),
+ input = document.createElement( "input" );
+
+ // Support: Android 4.0 - 4.3 only
+ // Check state lost if the name is set (#11217)
+ // Support: Windows Web Apps (WWA)
+ // `name` and `type` must use .setAttribute for WWA (#14901)
+ input.setAttribute( "type", "radio" );
+ input.setAttribute( "checked", "checked" );
+ input.setAttribute( "name", "t" );
+
+ div.appendChild( input );
+
+ // Support: Android <=4.1 only
+ // Older WebKit doesn't clone checked state correctly in fragments
+ support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked;
+
+ // Support: IE <=11 only
+ // Make sure textarea (and checkbox) defaultValue is properly cloned
+ div.innerHTML = "<textarea>x</textarea>";
+ support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue;
+} )();
+var documentElement = document.documentElement;
+
+
+
+var
+ rkeyEvent = /^key/,
+ rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/,
+ rtypenamespace = /^([^.]*)(?:\.(.+)|)/;
+
+function returnTrue() {
+ return true;
+}
+
+function returnFalse() {
+ return false;
+}
+
+// Support: IE <=9 only
+// See #13393 for more info
+function safeActiveElement() {
+ try {
+ return document.activeElement;
+ } catch ( err ) { }
+}
+
+function on( elem, types, selector, data, fn, one ) {
+ var origFn, type;
+
+ // Types can be a map of types/handlers
+ if ( typeof types === "object" ) {
+
+ // ( types-Object, selector, data )
+ if ( typeof selector !== "string" ) {
+
+ // ( types-Object, data )
+ data = data || selector;
+ selector = undefined;
+ }
+ for ( type in types ) {
+ on( elem, type, selector, data, types[ type ], one );
+ }
+ return elem;
+ }
+
+ if ( data == null && fn == null ) {
+
+ // ( types, fn )
+ fn = selector;
+ data = selector = undefined;
+ } else if ( fn == null ) {
+ if ( typeof selector === "string" ) {
+
+ // ( types, selector, fn )
+ fn = data;
+ data = undefined;
+ } else {
+
+ // ( types, data, fn )
+ fn = data;
+ data = selector;
+ selector = undefined;
+ }
+ }
+ if ( fn === false ) {
+ fn = returnFalse;
+ } else if ( !fn ) {
+ return elem;
+ }
+
+ if ( one === 1 ) {
+ origFn = fn;
+ fn = function( event ) {
+
+ // Can use an empty set, since event contains the info
+ jQuery().off( event );
+ return origFn.apply( this, arguments );
+ };
+
+ // Use same guid so caller can remove using origFn
+ fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ );
+ }
+ return elem.each( function() {
+ jQuery.event.add( this, types, fn, data, selector );
+ } );
+}
+
+/*
+ * Helper functions for managing events -- not part of the public interface.
+ * Props to Dean Edwards' addEvent library for many of the ideas.
+ */
+jQuery.event = {
+
+ global: {},
+
+ add: function( elem, types, handler, data, selector ) {
+
+ var handleObjIn, eventHandle, tmp,
+ events, t, handleObj,
+ special, handlers, type, namespaces, origType,
+ elemData = dataPriv.get( elem );
+
+ // Don't attach events to noData or text/comment nodes (but allow plain objects)
+ if ( !elemData ) {
+ return;
+ }
+
+ // Caller can pass in an object of custom data in lieu of the handler
+ if ( handler.handler ) {
+ handleObjIn = handler;
+ handler = handleObjIn.handler;
+ selector = handleObjIn.selector;
+ }
+
+ // Ensure that invalid selectors throw exceptions at attach time
+ // Evaluate against documentElement in case elem is a non-element node (e.g., document)
+ if ( selector ) {
+ jQuery.find.matchesSelector( documentElement, selector );
+ }
+
+ // Make sure that the handler has a unique ID, used to find/remove it later
+ if ( !handler.guid ) {
+ handler.guid = jQuery.guid++;
+ }
+
+ // Init the element's event structure and main handler, if this is the first
+ if ( !( events = elemData.events ) ) {
+ events = elemData.events = {};
+ }
+ if ( !( eventHandle = elemData.handle ) ) {
+ eventHandle = elemData.handle = function( e ) {
+
+ // Discard the second event of a jQuery.event.trigger() and
+ // when an event is called after a page has unloaded
+ return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ?
+ jQuery.event.dispatch.apply( elem, arguments ) : undefined;
+ };
+ }
+
+ // Handle multiple events separated by a space
+ types = ( types || "" ).match( rnothtmlwhite ) || [ "" ];
+ t = types.length;
+ while ( t-- ) {
+ tmp = rtypenamespace.exec( types[ t ] ) || [];
+ type = origType = tmp[ 1 ];
+ namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort();
+
+ // There *must* be a type, no attaching namespace-only handlers
+ if ( !type ) {
+ continue;
+ }
+
+ // If event changes its type, use the special event handlers for the changed type
+ special = jQuery.event.special[ type ] || {};
+
+ // If selector defined, determine special event api type, otherwise given type
+ type = ( selector ? special.delegateType : special.bindType ) || type;
+
+ // Update special based on newly reset type
+ special = jQuery.event.special[ type ] || {};
+
+ // handleObj is passed to all event handlers
+ handleObj = jQuery.extend( {
+ type: type,
+ origType: origType,
+ data: data,
+ handler: handler,
+ guid: handler.guid,
+ selector: selector,
+ needsContext: selector && jQuery.expr.match.needsContext.test( selector ),
+ namespace: namespaces.join( "." )
+ }, handleObjIn );
+
+ // Init the event handler queue if we're the first
+ if ( !( handlers = events[ type ] ) ) {
+ handlers = events[ type ] = [];
+ handlers.delegateCount = 0;
+
+ // Only use addEventListener if the special events handler returns false
+ if ( !special.setup ||
+ special.setup.call( elem, data, namespaces, eventHandle ) === false ) {
+
+ if ( elem.addEventListener ) {
+ elem.addEventListener( type, eventHandle );
+ }
+ }
+ }
+
+ if ( special.add ) {
+ special.add.call( elem, handleObj );
+
+ if ( !handleObj.handler.guid ) {
+ handleObj.handler.guid = handler.guid;
+ }
+ }
+
+ // Add to the element's handler list, delegates in front
+ if ( selector ) {
+ handlers.splice( handlers.delegateCount++, 0, handleObj );
+ } else {
+ handlers.push( handleObj );
+ }
+
+ // Keep track of which events have ever been used, for event optimization
+ jQuery.event.global[ type ] = true;
+ }
+
+ },
+
+ // Detach an event or set of events from an element
+ remove: function( elem, types, handler, selector, mappedTypes ) {
+
+ var j, origCount, tmp,
+ events, t, handleObj,
+ special, handlers, type, namespaces, origType,
+ elemData = dataPriv.hasData( elem ) && dataPriv.get( elem );
+
+ if ( !elemData || !( events = elemData.events ) ) {
+ return;
+ }
+
+ // Once for each type.namespace in types; type may be omitted
+ types = ( types || "" ).match( rnothtmlwhite ) || [ "" ];
+ t = types.length;
+ while ( t-- ) {
+ tmp = rtypenamespace.exec( types[ t ] ) || [];
+ type = origType = tmp[ 1 ];
+ namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort();
+
+ // Unbind all events (on this namespace, if provided) for the element
+ if ( !type ) {
+ for ( type in events ) {
+ jQuery.event.remove( elem, type + types[ t ], handler, selector, true );
+ }
+ continue;
+ }
+
+ special = jQuery.event.special[ type ] || {};
+ type = ( selector ? special.delegateType : special.bindType ) || type;
+ handlers = events[ type ] || [];
+ tmp = tmp[ 2 ] &&
+ new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" );
+
+ // Remove matching events
+ origCount = j = handlers.length;
+ while ( j-- ) {
+ handleObj = handlers[ j ];
+
+ if ( ( mappedTypes || origType === handleObj.origType ) &&
+ ( !handler || handler.guid === handleObj.guid ) &&
+ ( !tmp || tmp.test( handleObj.namespace ) ) &&
+ ( !selector || selector === handleObj.selector ||
+ selector === "**" && handleObj.selector ) ) {
+ handlers.splice( j, 1 );
+
+ if ( handleObj.selector ) {
+ handlers.delegateCount--;
+ }
+ if ( special.remove ) {
+ special.remove.call( elem, handleObj );
+ }
+ }
+ }
+
+ // Remove generic event handler if we removed something and no more handlers exist
+ // (avoids potential for endless recursion during removal of special event handlers)
+ if ( origCount && !handlers.length ) {
+ if ( !special.teardown ||
+ special.teardown.call( elem, namespaces, elemData.handle ) === false ) {
+
+ jQuery.removeEvent( elem, type, elemData.handle );
+ }
+
+ delete events[ type ];
+ }
+ }
+
+ // Remove data and the expando if it's no longer used
+ if ( jQuery.isEmptyObject( events ) ) {
+ dataPriv.remove( elem, "handle events" );
+ }
+ },
+
+ dispatch: function( nativeEvent ) {
+
+ // Make a writable jQuery.Event from the native event object
+ var event = jQuery.event.fix( nativeEvent );
+
+ var i, j, ret, matched, handleObj, handlerQueue,
+ args = new Array( arguments.length ),
+ handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [],
+ special = jQuery.event.special[ event.type ] || {};
+
+ // Use the fix-ed jQuery.Event rather than the (read-only) native event
+ args[ 0 ] = event;
+
+ for ( i = 1; i < arguments.length; i++ ) {
+ args[ i ] = arguments[ i ];
+ }
+
+ event.delegateTarget = this;
+
+ // Call the preDispatch hook for the mapped type, and let it bail if desired
+ if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) {
+ return;
+ }
+
+ // Determine handlers
+ handlerQueue = jQuery.event.handlers.call( this, event, handlers );
+
+ // Run delegates first; they may want to stop propagation beneath us
+ i = 0;
+ while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) {
+ event.currentTarget = matched.elem;
+
+ j = 0;
+ while ( ( handleObj = matched.handlers[ j++ ] ) &&
+ !event.isImmediatePropagationStopped() ) {
+
+ // Triggered event must either 1) have no namespace, or 2) have namespace(s)
+ // a subset or equal to those in the bound event (both can have no namespace).
+ if ( !event.rnamespace || event.rnamespace.test( handleObj.namespace ) ) {
+
+ event.handleObj = handleObj;
+ event.data = handleObj.data;
+
+ ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle ||
+ handleObj.handler ).apply( matched.elem, args );
+
+ if ( ret !== undefined ) {
+ if ( ( event.result = ret ) === false ) {
+ event.preventDefault();
+ event.stopPropagation();
+ }
+ }
+ }
+ }
+ }
+
+ // Call the postDispatch hook for the mapped type
+ if ( special.postDispatch ) {
+ special.postDispatch.call( this, event );
+ }
+
+ return event.result;
+ },
+
+ handlers: function( event, handlers ) {
+ var i, handleObj, sel, matchedHandlers, matchedSelectors,
+ handlerQueue = [],
+ delegateCount = handlers.delegateCount,
+ cur = event.target;
+
+ // Find delegate handlers
+ if ( delegateCount &&
+
+ // Support: IE <=9
+ // Black-hole SVG <use> instance trees (trac-13180)
+ cur.nodeType &&
+
+ // Support: Firefox <=42
+ // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861)
+ // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click
+ // Support: IE 11 only
+ // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343)
+ !( event.type === "click" && event.button >= 1 ) ) {
+
+ for ( ; cur !== this; cur = cur.parentNode || this ) {
+
+ // Don't check non-elements (#13208)
+ // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764)
+ if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) {
+ matchedHandlers = [];
+ matchedSelectors = {};
+ for ( i = 0; i < delegateCount; i++ ) {
+ handleObj = handlers[ i ];
+
+ // Don't conflict with Object.prototype properties (#13203)
+ sel = handleObj.selector + " ";
+
+ if ( matchedSelectors[ sel ] === undefined ) {
+ matchedSelectors[ sel ] = handleObj.needsContext ?
+ jQuery( sel, this ).index( cur ) > -1 :
+ jQuery.find( sel, this, null, [ cur ] ).length;
+ }
+ if ( matchedSelectors[ sel ] ) {
+ matchedHandlers.push( handleObj );
+ }
+ }
+ if ( matchedHandlers.length ) {
+ handlerQueue.push( { elem: cur, handlers: matchedHandlers } );
+ }
+ }
+ }
+ }
+
+ // Add the remaining (directly-bound) handlers
+ cur = this;
+ if ( delegateCount < handlers.length ) {
+ handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } );
+ }
+
+ return handlerQueue;
+ },
+
+ addProp: function( name, hook ) {
+ Object.defineProperty( jQuery.Event.prototype, name, {
+ enumerable: true,
+ configurable: true,
+
+ get: jQuery.isFunction( hook ) ?
+ function() {
+ if ( this.originalEvent ) {
+ return hook( this.originalEvent );
+ }
+ } :
+ function() {
+ if ( this.originalEvent ) {
+ return this.originalEvent[ name ];
+ }
+ },
+
+ set: function( value ) {
+ Object.defineProperty( this, name, {
+ enumerable: true,
+ configurable: true,
+ writable: true,
+ value: value
+ } );
+ }
+ } );
+ },
+
+ fix: function( originalEvent ) {
+ return originalEvent[ jQuery.expando ] ?
+ originalEvent :
+ new jQuery.Event( originalEvent );
+ },
+
+ special: {
+ load: {
+
+ // Prevent triggered image.load events from bubbling to window.load
+ noBubble: true
+ },
+ focus: {
+
+ // Fire native event if possible so blur/focus sequence is correct
+ trigger: function() {
+ if ( this !== safeActiveElement() && this.focus ) {
+ this.focus();
+ return false;
+ }
+ },
+ delegateType: "focusin"
+ },
+ blur: {
+ trigger: function() {
+ if ( this === safeActiveElement() && this.blur ) {
+ this.blur();
+ return false;
+ }
+ },
+ delegateType: "focusout"
+ },
+ click: {
+
+ // For checkbox, fire native event so checked state will be right
+ trigger: function() {
+ if ( this.type === "checkbox" && this.click && nodeName( this, "input" ) ) {
+ this.click();
+ return false;
+ }
+ },
+
+ // For cross-browser consistency, don't fire native .click() on links
+ _default: function( event ) {
+ return nodeName( event.target, "a" );
+ }
+ },
+
+ beforeunload: {
+ postDispatch: function( event ) {
+
+ // Support: Firefox 20+
+ // Firefox doesn't alert if the returnValue field is not set.
+ if ( event.result !== undefined && event.originalEvent ) {
+ event.originalEvent.returnValue = event.result;
+ }
+ }
+ }
+ }
+};
+
+jQuery.removeEvent = function( elem, type, handle ) {
+
+ // This "if" is needed for plain objects
+ if ( elem.removeEventListener ) {
+ elem.removeEventListener( type, handle );
+ }
+};
+
+jQuery.Event = function( src, props ) {
+
+ // Allow instantiation without the 'new' keyword
+ if ( !( this instanceof jQuery.Event ) ) {
+ return new jQuery.Event( src, props );
+ }
+
+ // Event object
+ if ( src && src.type ) {
+ this.originalEvent = src;
+ this.type = src.type;
+
+ // Events bubbling up the document may have been marked as prevented
+ // by a handler lower down the tree; reflect the correct value.
+ this.isDefaultPrevented = src.defaultPrevented ||
+ src.defaultPrevented === undefined &&
+
+ // Support: Android <=2.3 only
+ src.returnValue === false ?
+ returnTrue :
+ returnFalse;
+
+ // Create target properties
+ // Support: Safari <=6 - 7 only
+ // Target should not be a text node (#504, #13143)
+ this.target = ( src.target && src.target.nodeType === 3 ) ?
+ src.target.parentNode :
+ src.target;
+
+ this.currentTarget = src.currentTarget;
+ this.relatedTarget = src.relatedTarget;
+
+ // Event type
+ } else {
+ this.type = src;
+ }
+
+ // Put explicitly provided properties onto the event object
+ if ( props ) {
+ jQuery.extend( this, props );
+ }
+
+ // Create a timestamp if incoming event doesn't have one
+ this.timeStamp = src && src.timeStamp || jQuery.now();
+
+ // Mark it as fixed
+ this[ jQuery.expando ] = true;
+};
+
+// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding
+// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html
+jQuery.Event.prototype = {
+ constructor: jQuery.Event,
+ isDefaultPrevented: returnFalse,
+ isPropagationStopped: returnFalse,
+ isImmediatePropagationStopped: returnFalse,
+ isSimulated: false,
+
+ preventDefault: function() {
+ var e = this.originalEvent;
+
+ this.isDefaultPrevented = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.preventDefault();
+ }
+ },
+ stopPropagation: function() {
+ var e = this.originalEvent;
+
+ this.isPropagationStopped = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.stopPropagation();
+ }
+ },
+ stopImmediatePropagation: function() {
+ var e = this.originalEvent;
+
+ this.isImmediatePropagationStopped = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.stopImmediatePropagation();
+ }
+
+ this.stopPropagation();
+ }
+};
+
+// Includes all common event props including KeyEvent and MouseEvent specific props
+jQuery.each( {
+ altKey: true,
+ bubbles: true,
+ cancelable: true,
+ changedTouches: true,
+ ctrlKey: true,
+ detail: true,
+ eventPhase: true,
+ metaKey: true,
+ pageX: true,
+ pageY: true,
+ shiftKey: true,
+ view: true,
+ "char": true,
+ charCode: true,
+ key: true,
+ keyCode: true,
+ button: true,
+ buttons: true,
+ clientX: true,
+ clientY: true,
+ offsetX: true,
+ offsetY: true,
+ pointerId: true,
+ pointerType: true,
+ screenX: true,
+ screenY: true,
+ targetTouches: true,
+ toElement: true,
+ touches: true,
+
+ which: function( event ) {
+ var button = event.button;
+
+ // Add which for key events
+ if ( event.which == null && rkeyEvent.test( event.type ) ) {
+ return event.charCode != null ? event.charCode : event.keyCode;
+ }
+
+ // Add which for click: 1 === left; 2 === middle; 3 === right
+ if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) {
+ if ( button & 1 ) {
+ return 1;
+ }
+
+ if ( button & 2 ) {
+ return 3;
+ }
+
+ if ( button & 4 ) {
+ return 2;
+ }
+
+ return 0;
+ }
+
+ return event.which;
+ }
+}, jQuery.event.addProp );
+
+// Create mouseenter/leave events using mouseover/out and event-time checks
+// so that event delegation works in jQuery.
+// Do the same for pointerenter/pointerleave and pointerover/pointerout
+//
+// Support: Safari 7 only
+// Safari sends mouseenter too often; see:
+// https://bugs.chromium.org/p/chromium/issues/detail?id=470258
+// for the description of the bug (it existed in older Chrome versions as well).
+jQuery.each( {
+ mouseenter: "mouseover",
+ mouseleave: "mouseout",
+ pointerenter: "pointerover",
+ pointerleave: "pointerout"
+}, function( orig, fix ) {
+ jQuery.event.special[ orig ] = {
+ delegateType: fix,
+ bindType: fix,
+
+ handle: function( event ) {
+ var ret,
+ target = this,
+ related = event.relatedTarget,
+ handleObj = event.handleObj;
+
+ // For mouseenter/leave call the handler if related is outside the target.
+ // NB: No relatedTarget if the mouse left/entered the browser window
+ if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) {
+ event.type = handleObj.origType;
+ ret = handleObj.handler.apply( this, arguments );
+ event.type = fix;
+ }
+ return ret;
+ }
+ };
+} );
+
+jQuery.fn.extend( {
+
+ on: function( types, selector, data, fn ) {
+ return on( this, types, selector, data, fn );
+ },
+ one: function( types, selector, data, fn ) {
+ return on( this, types, selector, data, fn, 1 );
+ },
+ off: function( types, selector, fn ) {
+ var handleObj, type;
+ if ( types && types.preventDefault && types.handleObj ) {
+
+ // ( event ) dispatched jQuery.Event
+ handleObj = types.handleObj;
+ jQuery( types.delegateTarget ).off(
+ handleObj.namespace ?
+ handleObj.origType + "." + handleObj.namespace :
+ handleObj.origType,
+ handleObj.selector,
+ handleObj.handler
+ );
+ return this;
+ }
+ if ( typeof types === "object" ) {
+
+ // ( types-object [, selector] )
+ for ( type in types ) {
+ this.off( type, selector, types[ type ] );
+ }
+ return this;
+ }
+ if ( selector === false || typeof selector === "function" ) {
+
+ // ( types [, fn] )
+ fn = selector;
+ selector = undefined;
+ }
+ if ( fn === false ) {
+ fn = returnFalse;
+ }
+ return this.each( function() {
+ jQuery.event.remove( this, types, fn, selector );
+ } );
+ }
+} );
+
+
+var
+
+ /* eslint-disable max-len */
+
+ // See https://github.com/eslint/eslint/issues/3229
+ rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi,
+
+ /* eslint-enable */
+
+ // Support: IE <=10 - 11, Edge 12 - 13
+ // In IE/Edge using regex groups here causes severe slowdowns.
+ // See https://connect.microsoft.com/IE/feedback/details/1736512/
+ rnoInnerhtml = /<script|<style|<link/i,
+
+ // checked="checked" or checked
+ rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i,
+ rscriptTypeMasked = /^true\/(.*)/,
+ rcleanScript = /^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;
+
+// Prefer a tbody over its parent table for containing new rows
+function manipulationTarget( elem, content ) {
+ if ( nodeName( elem, "table" ) &&
+ nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) {
+
+ return jQuery( ">tbody", elem )[ 0 ] || elem;
+ }
+
+ return elem;
+}
+
+// Replace/restore the type attribute of script elements for safe DOM manipulation
+function disableScript( elem ) {
+ elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type;
+ return elem;
+}
+function restoreScript( elem ) {
+ var match = rscriptTypeMasked.exec( elem.type );
+
+ if ( match ) {
+ elem.type = match[ 1 ];
+ } else {
+ elem.removeAttribute( "type" );
+ }
+
+ return elem;
+}
+
+function cloneCopyEvent( src, dest ) {
+ var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events;
+
+ if ( dest.nodeType !== 1 ) {
+ return;
+ }
+
+ // 1. Copy private data: events, handlers, etc.
+ if ( dataPriv.hasData( src ) ) {
+ pdataOld = dataPriv.access( src );
+ pdataCur = dataPriv.set( dest, pdataOld );
+ events = pdataOld.events;
+
+ if ( events ) {
+ delete pdataCur.handle;
+ pdataCur.events = {};
+
+ for ( type in events ) {
+ for ( i = 0, l = events[ type ].length; i < l; i++ ) {
+ jQuery.event.add( dest, type, events[ type ][ i ] );
+ }
+ }
+ }
+ }
+
+ // 2. Copy user data
+ if ( dataUser.hasData( src ) ) {
+ udataOld = dataUser.access( src );
+ udataCur = jQuery.extend( {}, udataOld );
+
+ dataUser.set( dest, udataCur );
+ }
+}
+
+// Fix IE bugs, see support tests
+function fixInput( src, dest ) {
+ var nodeName = dest.nodeName.toLowerCase();
+
+ // Fails to persist the checked state of a cloned checkbox or radio button.
+ if ( nodeName === "input" && rcheckableType.test( src.type ) ) {
+ dest.checked = src.checked;
+
+ // Fails to return the selected option to the default selected state when cloning options
+ } else if ( nodeName === "input" || nodeName === "textarea" ) {
+ dest.defaultValue = src.defaultValue;
+ }
+}
+
+function domManip( collection, args, callback, ignored ) {
+
+ // Flatten any nested arrays
+ args = concat.apply( [], args );
+
+ var fragment, first, scripts, hasScripts, node, doc,
+ i = 0,
+ l = collection.length,
+ iNoClone = l - 1,
+ value = args[ 0 ],
+ isFunction = jQuery.isFunction( value );
+
+ // We can't cloneNode fragments that contain checked, in WebKit
+ if ( isFunction ||
+ ( l > 1 && typeof value === "string" &&
+ !support.checkClone && rchecked.test( value ) ) ) {
+ return collection.each( function( index ) {
+ var self = collection.eq( index );
+ if ( isFunction ) {
+ args[ 0 ] = value.call( this, index, self.html() );
+ }
+ domManip( self, args, callback, ignored );
+ } );
+ }
+
+ if ( l ) {
+ fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored );
+ first = fragment.firstChild;
+
+ if ( fragment.childNodes.length === 1 ) {
+ fragment = first;
+ }
+
+ // Require either new content or an interest in ignored elements to invoke the callback
+ if ( first || ignored ) {
+ scripts = jQuery.map( getAll( fragment, "script" ), disableScript );
+ hasScripts = scripts.length;
+
+ // Use the original fragment for the last item
+ // instead of the first because it can end up
+ // being emptied incorrectly in certain situations (#8070).
+ for ( ; i < l; i++ ) {
+ node = fragment;
+
+ if ( i !== iNoClone ) {
+ node = jQuery.clone( node, true, true );
+
+ // Keep references to cloned scripts for later restoration
+ if ( hasScripts ) {
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( scripts, getAll( node, "script" ) );
+ }
+ }
+
+ callback.call( collection[ i ], node, i );
+ }
+
+ if ( hasScripts ) {
+ doc = scripts[ scripts.length - 1 ].ownerDocument;
+
+ // Reenable scripts
+ jQuery.map( scripts, restoreScript );
+
+ // Evaluate executable scripts on first document insertion
+ for ( i = 0; i < hasScripts; i++ ) {
+ node = scripts[ i ];
+ if ( rscriptType.test( node.type || "" ) &&
+ !dataPriv.access( node, "globalEval" ) &&
+ jQuery.contains( doc, node ) ) {
+
+ if ( node.src ) {
+
+ // Optional AJAX dependency, but won't run scripts if not present
+ if ( jQuery._evalUrl ) {
+ jQuery._evalUrl( node.src );
+ }
+ } else {
+ DOMEval( node.textContent.replace( rcleanScript, "" ), doc );
+ }
+ }
+ }
+ }
+ }
+ }
+
+ return collection;
+}
+
+function remove( elem, selector, keepData ) {
+ var node,
+ nodes = selector ? jQuery.filter( selector, elem ) : elem,
+ i = 0;
+
+ for ( ; ( node = nodes[ i ] ) != null; i++ ) {
+ if ( !keepData && node.nodeType === 1 ) {
+ jQuery.cleanData( getAll( node ) );
+ }
+
+ if ( node.parentNode ) {
+ if ( keepData && jQuery.contains( node.ownerDocument, node ) ) {
+ setGlobalEval( getAll( node, "script" ) );
+ }
+ node.parentNode.removeChild( node );
+ }
+ }
+
+ return elem;
+}
+
+jQuery.extend( {
+ htmlPrefilter: function( html ) {
+ return html.replace( rxhtmlTag, "<$1></$2>" );
+ },
+
+ clone: function( elem, dataAndEvents, deepDataAndEvents ) {
+ var i, l, srcElements, destElements,
+ clone = elem.cloneNode( true ),
+ inPage = jQuery.contains( elem.ownerDocument, elem );
+
+ // Fix IE cloning issues
+ if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) &&
+ !jQuery.isXMLDoc( elem ) ) {
+
+ // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2
+ destElements = getAll( clone );
+ srcElements = getAll( elem );
+
+ for ( i = 0, l = srcElements.length; i < l; i++ ) {
+ fixInput( srcElements[ i ], destElements[ i ] );
+ }
+ }
+
+ // Copy the events from the original to the clone
+ if ( dataAndEvents ) {
+ if ( deepDataAndEvents ) {
+ srcElements = srcElements || getAll( elem );
+ destElements = destElements || getAll( clone );
+
+ for ( i = 0, l = srcElements.length; i < l; i++ ) {
+ cloneCopyEvent( srcElements[ i ], destElements[ i ] );
+ }
+ } else {
+ cloneCopyEvent( elem, clone );
+ }
+ }
+
+ // Preserve script evaluation history
+ destElements = getAll( clone, "script" );
+ if ( destElements.length > 0 ) {
+ setGlobalEval( destElements, !inPage && getAll( elem, "script" ) );
+ }
+
+ // Return the cloned set
+ return clone;
+ },
+
+ cleanData: function( elems ) {
+ var data, elem, type,
+ special = jQuery.event.special,
+ i = 0;
+
+ for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) {
+ if ( acceptData( elem ) ) {
+ if ( ( data = elem[ dataPriv.expando ] ) ) {
+ if ( data.events ) {
+ for ( type in data.events ) {
+ if ( special[ type ] ) {
+ jQuery.event.remove( elem, type );
+
+ // This is a shortcut to avoid jQuery.event.remove's overhead
+ } else {
+ jQuery.removeEvent( elem, type, data.handle );
+ }
+ }
+ }
+
+ // Support: Chrome <=35 - 45+
+ // Assign undefined instead of using delete, see Data#remove
+ elem[ dataPriv.expando ] = undefined;
+ }
+ if ( elem[ dataUser.expando ] ) {
+
+ // Support: Chrome <=35 - 45+
+ // Assign undefined instead of using delete, see Data#remove
+ elem[ dataUser.expando ] = undefined;
+ }
+ }
+ }
+ }
+} );
+
+jQuery.fn.extend( {
+ detach: function( selector ) {
+ return remove( this, selector, true );
+ },
+
+ remove: function( selector ) {
+ return remove( this, selector );
+ },
+
+ text: function( value ) {
+ return access( this, function( value ) {
+ return value === undefined ?
+ jQuery.text( this ) :
+ this.empty().each( function() {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ this.textContent = value;
+ }
+ } );
+ }, null, value, arguments.length );
+ },
+
+ append: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ var target = manipulationTarget( this, elem );
+ target.appendChild( elem );
+ }
+ } );
+ },
+
+ prepend: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ var target = manipulationTarget( this, elem );
+ target.insertBefore( elem, target.firstChild );
+ }
+ } );
+ },
+
+ before: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.parentNode ) {
+ this.parentNode.insertBefore( elem, this );
+ }
+ } );
+ },
+
+ after: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.parentNode ) {
+ this.parentNode.insertBefore( elem, this.nextSibling );
+ }
+ } );
+ },
+
+ empty: function() {
+ var elem,
+ i = 0;
+
+ for ( ; ( elem = this[ i ] ) != null; i++ ) {
+ if ( elem.nodeType === 1 ) {
+
+ // Prevent memory leaks
+ jQuery.cleanData( getAll( elem, false ) );
+
+ // Remove any remaining nodes
+ elem.textContent = "";
+ }
+ }
+
+ return this;
+ },
+
+ clone: function( dataAndEvents, deepDataAndEvents ) {
+ dataAndEvents = dataAndEvents == null ? false : dataAndEvents;
+ deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents;
+
+ return this.map( function() {
+ return jQuery.clone( this, dataAndEvents, deepDataAndEvents );
+ } );
+ },
+
+ html: function( value ) {
+ return access( this, function( value ) {
+ var elem = this[ 0 ] || {},
+ i = 0,
+ l = this.length;
+
+ if ( value === undefined && elem.nodeType === 1 ) {
+ return elem.innerHTML;
+ }
+
+ // See if we can take a shortcut and just use innerHTML
+ if ( typeof value === "string" && !rnoInnerhtml.test( value ) &&
+ !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) {
+
+ value = jQuery.htmlPrefilter( value );
+
+ try {
+ for ( ; i < l; i++ ) {
+ elem = this[ i ] || {};
+
+ // Remove element nodes and prevent memory leaks
+ if ( elem.nodeType === 1 ) {
+ jQuery.cleanData( getAll( elem, false ) );
+ elem.innerHTML = value;
+ }
+ }
+
+ elem = 0;
+
+ // If using innerHTML throws an exception, use the fallback method
+ } catch ( e ) {}
+ }
+
+ if ( elem ) {
+ this.empty().append( value );
+ }
+ }, null, value, arguments.length );
+ },
+
+ replaceWith: function() {
+ var ignored = [];
+
+ // Make the changes, replacing each non-ignored context element with the new content
+ return domManip( this, arguments, function( elem ) {
+ var parent = this.parentNode;
+
+ if ( jQuery.inArray( this, ignored ) < 0 ) {
+ jQuery.cleanData( getAll( this ) );
+ if ( parent ) {
+ parent.replaceChild( elem, this );
+ }
+ }
+
+ // Force callback invocation
+ }, ignored );
+ }
+} );
+
+jQuery.each( {
+ appendTo: "append",
+ prependTo: "prepend",
+ insertBefore: "before",
+ insertAfter: "after",
+ replaceAll: "replaceWith"
+}, function( name, original ) {
+ jQuery.fn[ name ] = function( selector ) {
+ var elems,
+ ret = [],
+ insert = jQuery( selector ),
+ last = insert.length - 1,
+ i = 0;
+
+ for ( ; i <= last; i++ ) {
+ elems = i === last ? this : this.clone( true );
+ jQuery( insert[ i ] )[ original ]( elems );
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // .get() because push.apply(_, arraylike) throws on ancient WebKit
+ push.apply( ret, elems.get() );
+ }
+
+ return this.pushStack( ret );
+ };
+} );
+var rmargin = ( /^margin/ );
+
+var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" );
+
+var getStyles = function( elem ) {
+
+ // Support: IE <=11 only, Firefox <=30 (#15098, #14150)
+ // IE throws on elements created in popups
+ // FF meanwhile throws on frame elements through "defaultView.getComputedStyle"
+ var view = elem.ownerDocument.defaultView;
+
+ if ( !view || !view.opener ) {
+ view = window;
+ }
+
+ return view.getComputedStyle( elem );
+ };
+
+
+
+( function() {
+
+ // Executing both pixelPosition & boxSizingReliable tests require only one layout
+ // so they're executed at the same time to save the second computation.
+ function computeStyleTests() {
+
+ // This is a singleton, we need to execute it only once
+ if ( !div ) {
+ return;
+ }
+
+ div.style.cssText =
+ "box-sizing:border-box;" +
+ "position:relative;display:block;" +
+ "margin:auto;border:1px;padding:1px;" +
+ "top:1%;width:50%";
+ div.innerHTML = "";
+ documentElement.appendChild( container );
+
+ var divStyle = window.getComputedStyle( div );
+ pixelPositionVal = divStyle.top !== "1%";
+
+ // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44
+ reliableMarginLeftVal = divStyle.marginLeft === "2px";
+ boxSizingReliableVal = divStyle.width === "4px";
+
+ // Support: Android 4.0 - 4.3 only
+ // Some styles come back with percentage values, even though they shouldn't
+ div.style.marginRight = "50%";
+ pixelMarginRightVal = divStyle.marginRight === "4px";
+
+ documentElement.removeChild( container );
+
+ // Nullify the div so it wouldn't be stored in the memory and
+ // it will also be a sign that checks already performed
+ div = null;
+ }
+
+ var pixelPositionVal, boxSizingReliableVal, pixelMarginRightVal, reliableMarginLeftVal,
+ container = document.createElement( "div" ),
+ div = document.createElement( "div" );
+
+ // Finish early in limited (non-browser) environments
+ if ( !div.style ) {
+ return;
+ }
+
+ // Support: IE <=9 - 11 only
+ // Style of cloned element affects source element cloned (#8908)
+ div.style.backgroundClip = "content-box";
+ div.cloneNode( true ).style.backgroundClip = "";
+ support.clearCloneStyle = div.style.backgroundClip === "content-box";
+
+ container.style.cssText = "border:0;width:8px;height:0;top:0;left:-9999px;" +
+ "padding:0;margin-top:1px;position:absolute";
+ container.appendChild( div );
+
+ jQuery.extend( support, {
+ pixelPosition: function() {
+ computeStyleTests();
+ return pixelPositionVal;
+ },
+ boxSizingReliable: function() {
+ computeStyleTests();
+ return boxSizingReliableVal;
+ },
+ pixelMarginRight: function() {
+ computeStyleTests();
+ return pixelMarginRightVal;
+ },
+ reliableMarginLeft: function() {
+ computeStyleTests();
+ return reliableMarginLeftVal;
+ }
+ } );
+} )();
+
+
+function curCSS( elem, name, computed ) {
+ var width, minWidth, maxWidth, ret,
+
+ // Support: Firefox 51+
+ // Retrieving style before computed somehow
+ // fixes an issue with getting wrong values
+ // on detached elements
+ style = elem.style;
+
+ computed = computed || getStyles( elem );
+
+ // getPropertyValue is needed for:
+ // .css('filter') (IE 9 only, #12537)
+ // .css('--customProperty) (#3144)
+ if ( computed ) {
+ ret = computed.getPropertyValue( name ) || computed[ name ];
+
+ if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) {
+ ret = jQuery.style( elem, name );
+ }
+
+ // A tribute to the "awesome hack by Dean Edwards"
+ // Android Browser returns percentage for some values,
+ // but width seems to be reliably pixels.
+ // This is against the CSSOM draft spec:
+ // https://drafts.csswg.org/cssom/#resolved-values
+ if ( !support.pixelMarginRight() && rnumnonpx.test( ret ) && rmargin.test( name ) ) {
+
+ // Remember the original values
+ width = style.width;
+ minWidth = style.minWidth;
+ maxWidth = style.maxWidth;
+
+ // Put in the new values to get a computed value out
+ style.minWidth = style.maxWidth = style.width = ret;
+ ret = computed.width;
+
+ // Revert the changed values
+ style.width = width;
+ style.minWidth = minWidth;
+ style.maxWidth = maxWidth;
+ }
+ }
+
+ return ret !== undefined ?
+
+ // Support: IE <=9 - 11 only
+ // IE returns zIndex value as an integer.
+ ret + "" :
+ ret;
+}
+
+
+function addGetHookIf( conditionFn, hookFn ) {
+
+ // Define the hook, we'll check on the first run if it's really needed.
+ return {
+ get: function() {
+ if ( conditionFn() ) {
+
+ // Hook not needed (or it's not possible to use it due
+ // to missing dependency), remove it.
+ delete this.get;
+ return;
+ }
+
+ // Hook needed; redefine it so that the support test is not executed again.
+ return ( this.get = hookFn ).apply( this, arguments );
+ }
+ };
+}
+
+
+var
+
+ // Swappable if display is none or starts with table
+ // except "table", "table-cell", or "table-caption"
+ // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display
+ rdisplayswap = /^(none|table(?!-c[ea]).+)/,
+ rcustomProp = /^--/,
+ cssShow = { position: "absolute", visibility: "hidden", display: "block" },
+ cssNormalTransform = {
+ letterSpacing: "0",
+ fontWeight: "400"
+ },
+
+ cssPrefixes = [ "Webkit", "Moz", "ms" ],
+ emptyStyle = document.createElement( "div" ).style;
+
+// Return a css property mapped to a potentially vendor prefixed property
+function vendorPropName( name ) {
+
+ // Shortcut for names that are not vendor prefixed
+ if ( name in emptyStyle ) {
+ return name;
+ }
+
+ // Check for vendor prefixed names
+ var capName = name[ 0 ].toUpperCase() + name.slice( 1 ),
+ i = cssPrefixes.length;
+
+ while ( i-- ) {
+ name = cssPrefixes[ i ] + capName;
+ if ( name in emptyStyle ) {
+ return name;
+ }
+ }
+}
+
+// Return a property mapped along what jQuery.cssProps suggests or to
+// a vendor prefixed property.
+function finalPropName( name ) {
+ var ret = jQuery.cssProps[ name ];
+ if ( !ret ) {
+ ret = jQuery.cssProps[ name ] = vendorPropName( name ) || name;
+ }
+ return ret;
+}
+
+function setPositiveNumber( elem, value, subtract ) {
+
+ // Any relative (+/-) values have already been
+ // normalized at this point
+ var matches = rcssNum.exec( value );
+ return matches ?
+
+ // Guard against undefined "subtract", e.g., when used as in cssHooks
+ Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) :
+ value;
+}
+
+function augmentWidthOrHeight( elem, name, extra, isBorderBox, styles ) {
+ var i,
+ val = 0;
+
+ // If we already have the right measurement, avoid augmentation
+ if ( extra === ( isBorderBox ? "border" : "content" ) ) {
+ i = 4;
+
+ // Otherwise initialize for horizontal or vertical properties
+ } else {
+ i = name === "width" ? 1 : 0;
+ }
+
+ for ( ; i < 4; i += 2 ) {
+
+ // Both box models exclude margin, so add it if we want it
+ if ( extra === "margin" ) {
+ val += jQuery.css( elem, extra + cssExpand[ i ], true, styles );
+ }
+
+ if ( isBorderBox ) {
+
+ // border-box includes padding, so remove it if we want content
+ if ( extra === "content" ) {
+ val -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles );
+ }
+
+ // At this point, extra isn't border nor margin, so remove border
+ if ( extra !== "margin" ) {
+ val -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
+ }
+ } else {
+
+ // At this point, extra isn't content, so add padding
+ val += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles );
+
+ // At this point, extra isn't content nor padding, so add border
+ if ( extra !== "padding" ) {
+ val += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
+ }
+ }
+ }
+
+ return val;
+}
+
+function getWidthOrHeight( elem, name, extra ) {
+
+ // Start with computed style
+ var valueIsBorderBox,
+ styles = getStyles( elem ),
+ val = curCSS( elem, name, styles ),
+ isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box";
+
+ // Computed unit is not pixels. Stop here and return.
+ if ( rnumnonpx.test( val ) ) {
+ return val;
+ }
+
+ // Check for style in case a browser which returns unreliable values
+ // for getComputedStyle silently falls back to the reliable elem.style
+ valueIsBorderBox = isBorderBox &&
+ ( support.boxSizingReliable() || val === elem.style[ name ] );
+
+ // Fall back to offsetWidth/Height when value is "auto"
+ // This happens for inline elements with no explicit setting (gh-3571)
+ if ( val === "auto" ) {
+ val = elem[ "offset" + name[ 0 ].toUpperCase() + name.slice( 1 ) ];
+ }
+
+ // Normalize "", auto, and prepare for extra
+ val = parseFloat( val ) || 0;
+
+ // Use the active box-sizing model to add/subtract irrelevant styles
+ return ( val +
+ augmentWidthOrHeight(
+ elem,
+ name,
+ extra || ( isBorderBox ? "border" : "content" ),
+ valueIsBorderBox,
+ styles
+ )
+ ) + "px";
+}
+
+jQuery.extend( {
+
+ // Add in style property hooks for overriding the default
+ // behavior of getting and setting a style property
+ cssHooks: {
+ opacity: {
+ get: function( elem, computed ) {
+ if ( computed ) {
+
+ // We should always get a number back from opacity
+ var ret = curCSS( elem, "opacity" );
+ return ret === "" ? "1" : ret;
+ }
+ }
+ }
+ },
+
+ // Don't automatically add "px" to these possibly-unitless properties
+ cssNumber: {
+ "animationIterationCount": true,
+ "columnCount": true,
+ "fillOpacity": true,
+ "flexGrow": true,
+ "flexShrink": true,
+ "fontWeight": true,
+ "lineHeight": true,
+ "opacity": true,
+ "order": true,
+ "orphans": true,
+ "widows": true,
+ "zIndex": true,
+ "zoom": true
+ },
+
+ // Add in properties whose names you wish to fix before
+ // setting or getting the value
+ cssProps: {
+ "float": "cssFloat"
+ },
+
+ // Get and set the style property on a DOM Node
+ style: function( elem, name, value, extra ) {
+
+ // Don't set styles on text and comment nodes
+ if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) {
+ return;
+ }
+
+ // Make sure that we're working with the right name
+ var ret, type, hooks,
+ origName = jQuery.camelCase( name ),
+ isCustomProp = rcustomProp.test( name ),
+ style = elem.style;
+
+ // Make sure that we're working with the right name. We don't
+ // want to query the value if it is a CSS custom property
+ // since they are user-defined.
+ if ( !isCustomProp ) {
+ name = finalPropName( origName );
+ }
+
+ // Gets hook for the prefixed version, then unprefixed version
+ hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];
+
+ // Check if we're setting a value
+ if ( value !== undefined ) {
+ type = typeof value;
+
+ // Convert "+=" or "-=" to relative numbers (#7345)
+ if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) {
+ value = adjustCSS( elem, name, ret );
+
+ // Fixes bug #9237
+ type = "number";
+ }
+
+ // Make sure that null and NaN values aren't set (#7116)
+ if ( value == null || value !== value ) {
+ return;
+ }
+
+ // If a number was passed in, add the unit (except for certain CSS properties)
+ if ( type === "number" ) {
+ value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" );
+ }
+
+ // background-* props affect original clone's values
+ if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) {
+ style[ name ] = "inherit";
+ }
+
+ // If a hook was provided, use that value, otherwise just set the specified value
+ if ( !hooks || !( "set" in hooks ) ||
+ ( value = hooks.set( elem, value, extra ) ) !== undefined ) {
+
+ if ( isCustomProp ) {
+ style.setProperty( name, value );
+ } else {
+ style[ name ] = value;
+ }
+ }
+
+ } else {
+
+ // If a hook was provided get the non-computed value from there
+ if ( hooks && "get" in hooks &&
+ ( ret = hooks.get( elem, false, extra ) ) !== undefined ) {
+
+ return ret;
+ }
+
+ // Otherwise just get the value from the style object
+ return style[ name ];
+ }
+ },
+
+ css: function( elem, name, extra, styles ) {
+ var val, num, hooks,
+ origName = jQuery.camelCase( name ),
+ isCustomProp = rcustomProp.test( name );
+
+ // Make sure that we're working with the right name. We don't
+ // want to modify the value if it is a CSS custom property
+ // since they are user-defined.
+ if ( !isCustomProp ) {
+ name = finalPropName( origName );
+ }
+
+ // Try prefixed name followed by the unprefixed name
+ hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];
+
+ // If a hook was provided get the computed value from there
+ if ( hooks && "get" in hooks ) {
+ val = hooks.get( elem, true, extra );
+ }
+
+ // Otherwise, if a way to get the computed value exists, use that
+ if ( val === undefined ) {
+ val = curCSS( elem, name, styles );
+ }
+
+ // Convert "normal" to computed value
+ if ( val === "normal" && name in cssNormalTransform ) {
+ val = cssNormalTransform[ name ];
+ }
+
+ // Make numeric if forced or a qualifier was provided and val looks numeric
+ if ( extra === "" || extra ) {
+ num = parseFloat( val );
+ return extra === true || isFinite( num ) ? num || 0 : val;
+ }
+
+ return val;
+ }
+} );
+
+jQuery.each( [ "height", "width" ], function( i, name ) {
+ jQuery.cssHooks[ name ] = {
+ get: function( elem, computed, extra ) {
+ if ( computed ) {
+
+ // Certain elements can have dimension info if we invisibly show them
+ // but it must have a current display style that would benefit
+ return rdisplayswap.test( jQuery.css( elem, "display" ) ) &&
+
+ // Support: Safari 8+
+ // Table columns in Safari have non-zero offsetWidth & zero
+ // getBoundingClientRect().width unless display is changed.
+ // Support: IE <=11 only
+ // Running getBoundingClientRect on a disconnected node
+ // in IE throws an error.
+ ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ?
+ swap( elem, cssShow, function() {
+ return getWidthOrHeight( elem, name, extra );
+ } ) :
+ getWidthOrHeight( elem, name, extra );
+ }
+ },
+
+ set: function( elem, value, extra ) {
+ var matches,
+ styles = extra && getStyles( elem ),
+ subtract = extra && augmentWidthOrHeight(
+ elem,
+ name,
+ extra,
+ jQuery.css( elem, "boxSizing", false, styles ) === "border-box",
+ styles
+ );
+
+ // Convert to pixels if value adjustment is needed
+ if ( subtract && ( matches = rcssNum.exec( value ) ) &&
+ ( matches[ 3 ] || "px" ) !== "px" ) {
+
+ elem.style[ name ] = value;
+ value = jQuery.css( elem, name );
+ }
+
+ return setPositiveNumber( elem, value, subtract );
+ }
+ };
+} );
+
+jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft,
+ function( elem, computed ) {
+ if ( computed ) {
+ return ( parseFloat( curCSS( elem, "marginLeft" ) ) ||
+ elem.getBoundingClientRect().left -
+ swap( elem, { marginLeft: 0 }, function() {
+ return elem.getBoundingClientRect().left;
+ } )
+ ) + "px";
+ }
+ }
+);
+
+// These hooks are used by animate to expand properties
+jQuery.each( {
+ margin: "",
+ padding: "",
+ border: "Width"
+}, function( prefix, suffix ) {
+ jQuery.cssHooks[ prefix + suffix ] = {
+ expand: function( value ) {
+ var i = 0,
+ expanded = {},
+
+ // Assumes a single number if not a string
+ parts = typeof value === "string" ? value.split( " " ) : [ value ];
+
+ for ( ; i < 4; i++ ) {
+ expanded[ prefix + cssExpand[ i ] + suffix ] =
+ parts[ i ] || parts[ i - 2 ] || parts[ 0 ];
+ }
+
+ return expanded;
+ }
+ };
+
+ if ( !rmargin.test( prefix ) ) {
+ jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber;
+ }
+} );
+
+jQuery.fn.extend( {
+ css: function( name, value ) {
+ return access( this, function( elem, name, value ) {
+ var styles, len,
+ map = {},
+ i = 0;
+
+ if ( Array.isArray( name ) ) {
+ styles = getStyles( elem );
+ len = name.length;
+
+ for ( ; i < len; i++ ) {
+ map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles );
+ }
+
+ return map;
+ }
+
+ return value !== undefined ?
+ jQuery.style( elem, name, value ) :
+ jQuery.css( elem, name );
+ }, name, value, arguments.length > 1 );
+ }
+} );
+
+
+function Tween( elem, options, prop, end, easing ) {
+ return new Tween.prototype.init( elem, options, prop, end, easing );
+}
+jQuery.Tween = Tween;
+
+Tween.prototype = {
+ constructor: Tween,
+ init: function( elem, options, prop, end, easing, unit ) {
+ this.elem = elem;
+ this.prop = prop;
+ this.easing = easing || jQuery.easing._default;
+ this.options = options;
+ this.start = this.now = this.cur();
+ this.end = end;
+ this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" );
+ },
+ cur: function() {
+ var hooks = Tween.propHooks[ this.prop ];
+
+ return hooks && hooks.get ?
+ hooks.get( this ) :
+ Tween.propHooks._default.get( this );
+ },
+ run: function( percent ) {
+ var eased,
+ hooks = Tween.propHooks[ this.prop ];
+
+ if ( this.options.duration ) {
+ this.pos = eased = jQuery.easing[ this.easing ](
+ percent, this.options.duration * percent, 0, 1, this.options.duration
+ );
+ } else {
+ this.pos = eased = percent;
+ }
+ this.now = ( this.end - this.start ) * eased + this.start;
+
+ if ( this.options.step ) {
+ this.options.step.call( this.elem, this.now, this );
+ }
+
+ if ( hooks && hooks.set ) {
+ hooks.set( this );
+ } else {
+ Tween.propHooks._default.set( this );
+ }
+ return this;
+ }
+};
+
+Tween.prototype.init.prototype = Tween.prototype;
+
+Tween.propHooks = {
+ _default: {
+ get: function( tween ) {
+ var result;
+
+ // Use a property on the element directly when it is not a DOM element,
+ // or when there is no matching style property that exists.
+ if ( tween.elem.nodeType !== 1 ||
+ tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) {
+ return tween.elem[ tween.prop ];
+ }
+
+ // Passing an empty string as a 3rd parameter to .css will automatically
+ // attempt a parseFloat and fallback to a string if the parse fails.
+ // Simple values such as "10px" are parsed to Float;
+ // complex values such as "rotate(1rad)" are returned as-is.
+ result = jQuery.css( tween.elem, tween.prop, "" );
+
+ // Empty strings, null, undefined and "auto" are converted to 0.
+ return !result || result === "auto" ? 0 : result;
+ },
+ set: function( tween ) {
+
+ // Use step hook for back compat.
+ // Use cssHook if its there.
+ // Use .style if available and use plain properties where available.
+ if ( jQuery.fx.step[ tween.prop ] ) {
+ jQuery.fx.step[ tween.prop ]( tween );
+ } else if ( tween.elem.nodeType === 1 &&
+ ( tween.elem.style[ jQuery.cssProps[ tween.prop ] ] != null ||
+ jQuery.cssHooks[ tween.prop ] ) ) {
+ jQuery.style( tween.elem, tween.prop, tween.now + tween.unit );
+ } else {
+ tween.elem[ tween.prop ] = tween.now;
+ }
+ }
+ }
+};
+
+// Support: IE <=9 only
+// Panic based approach to setting things on disconnected nodes
+Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = {
+ set: function( tween ) {
+ if ( tween.elem.nodeType && tween.elem.parentNode ) {
+ tween.elem[ tween.prop ] = tween.now;
+ }
+ }
+};
+
+jQuery.easing = {
+ linear: function( p ) {
+ return p;
+ },
+ swing: function( p ) {
+ return 0.5 - Math.cos( p * Math.PI ) / 2;
+ },
+ _default: "swing"
+};
+
+jQuery.fx = Tween.prototype.init;
+
+// Back compat <1.8 extension point
+jQuery.fx.step = {};
+
+
+
+
+var
+ fxNow, inProgress,
+ rfxtypes = /^(?:toggle|show|hide)$/,
+ rrun = /queueHooks$/;
+
+function schedule() {
+ if ( inProgress ) {
+ if ( document.hidden === false && window.requestAnimationFrame ) {
+ window.requestAnimationFrame( schedule );
+ } else {
+ window.setTimeout( schedule, jQuery.fx.interval );
+ }
+
+ jQuery.fx.tick();
+ }
+}
+
+// Animations created synchronously will run synchronously
+function createFxNow() {
+ window.setTimeout( function() {
+ fxNow = undefined;
+ } );
+ return ( fxNow = jQuery.now() );
+}
+
+// Generate parameters to create a standard animation
+function genFx( type, includeWidth ) {
+ var which,
+ i = 0,
+ attrs = { height: type };
+
+ // If we include width, step value is 1 to do all cssExpand values,
+ // otherwise step value is 2 to skip over Left and Right
+ includeWidth = includeWidth ? 1 : 0;
+ for ( ; i < 4; i += 2 - includeWidth ) {
+ which = cssExpand[ i ];
+ attrs[ "margin" + which ] = attrs[ "padding" + which ] = type;
+ }
+
+ if ( includeWidth ) {
+ attrs.opacity = attrs.width = type;
+ }
+
+ return attrs;
+}
+
+function createTween( value, prop, animation ) {
+ var tween,
+ collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ),
+ index = 0,
+ length = collection.length;
+ for ( ; index < length; index++ ) {
+ if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) {
+
+ // We're done with this property
+ return tween;
+ }
+ }
+}
+
+function defaultPrefilter( elem, props, opts ) {
+ var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display,
+ isBox = "width" in props || "height" in props,
+ anim = this,
+ orig = {},
+ style = elem.style,
+ hidden = elem.nodeType && isHiddenWithinTree( elem ),
+ dataShow = dataPriv.get( elem, "fxshow" );
+
+ // Queue-skipping animations hijack the fx hooks
+ if ( !opts.queue ) {
+ hooks = jQuery._queueHooks( elem, "fx" );
+ if ( hooks.unqueued == null ) {
+ hooks.unqueued = 0;
+ oldfire = hooks.empty.fire;
+ hooks.empty.fire = function() {
+ if ( !hooks.unqueued ) {
+ oldfire();
+ }
+ };
+ }
+ hooks.unqueued++;
+
+ anim.always( function() {
+
+ // Ensure the complete handler is called before this completes
+ anim.always( function() {
+ hooks.unqueued--;
+ if ( !jQuery.queue( elem, "fx" ).length ) {
+ hooks.empty.fire();
+ }
+ } );
+ } );
+ }
+
+ // Detect show/hide animations
+ for ( prop in props ) {
+ value = props[ prop ];
+ if ( rfxtypes.test( value ) ) {
+ delete props[ prop ];
+ toggle = toggle || value === "toggle";
+ if ( value === ( hidden ? "hide" : "show" ) ) {
+
+ // Pretend to be hidden if this is a "show" and
+ // there is still data from a stopped show/hide
+ if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) {
+ hidden = true;
+
+ // Ignore all other no-op show/hide data
+ } else {
+ continue;
+ }
+ }
+ orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop );
+ }
+ }
+
+ // Bail out if this is a no-op like .hide().hide()
+ propTween = !jQuery.isEmptyObject( props );
+ if ( !propTween && jQuery.isEmptyObject( orig ) ) {
+ return;
+ }
+
+ // Restrict "overflow" and "display" styles during box animations
+ if ( isBox && elem.nodeType === 1 ) {
+
+ // Support: IE <=9 - 11, Edge 12 - 13
+ // Record all 3 overflow attributes because IE does not infer the shorthand
+ // from identically-valued overflowX and overflowY
+ opts.overflow = [ style.overflow, style.overflowX, style.overflowY ];
+
+ // Identify a display type, preferring old show/hide data over the CSS cascade
+ restoreDisplay = dataShow && dataShow.display;
+ if ( restoreDisplay == null ) {
+ restoreDisplay = dataPriv.get( elem, "display" );
+ }
+ display = jQuery.css( elem, "display" );
+ if ( display === "none" ) {
+ if ( restoreDisplay ) {
+ display = restoreDisplay;
+ } else {
+
+ // Get nonempty value(s) by temporarily forcing visibility
+ showHide( [ elem ], true );
+ restoreDisplay = elem.style.display || restoreDisplay;
+ display = jQuery.css( elem, "display" );
+ showHide( [ elem ] );
+ }
+ }
+
+ // Animate inline elements as inline-block
+ if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) {
+ if ( jQuery.css( elem, "float" ) === "none" ) {
+
+ // Restore the original display value at the end of pure show/hide animations
+ if ( !propTween ) {
+ anim.done( function() {
+ style.display = restoreDisplay;
+ } );
+ if ( restoreDisplay == null ) {
+ display = style.display;
+ restoreDisplay = display === "none" ? "" : display;
+ }
+ }
+ style.display = "inline-block";
+ }
+ }
+ }
+
+ if ( opts.overflow ) {
+ style.overflow = "hidden";
+ anim.always( function() {
+ style.overflow = opts.overflow[ 0 ];
+ style.overflowX = opts.overflow[ 1 ];
+ style.overflowY = opts.overflow[ 2 ];
+ } );
+ }
+
+ // Implement show/hide animations
+ propTween = false;
+ for ( prop in orig ) {
+
+ // General show/hide setup for this element animation
+ if ( !propTween ) {
+ if ( dataShow ) {
+ if ( "hidden" in dataShow ) {
+ hidden = dataShow.hidden;
+ }
+ } else {
+ dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } );
+ }
+
+ // Store hidden/visible for toggle so `.stop().toggle()` "reverses"
+ if ( toggle ) {
+ dataShow.hidden = !hidden;
+ }
+
+ // Show elements before animating them
+ if ( hidden ) {
+ showHide( [ elem ], true );
+ }
+
+ /* eslint-disable no-loop-func */
+
+ anim.done( function() {
+
+ /* eslint-enable no-loop-func */
+
+ // The final step of a "hide" animation is actually hiding the element
+ if ( !hidden ) {
+ showHide( [ elem ] );
+ }
+ dataPriv.remove( elem, "fxshow" );
+ for ( prop in orig ) {
+ jQuery.style( elem, prop, orig[ prop ] );
+ }
+ } );
+ }
+
+ // Per-property setup
+ propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim );
+ if ( !( prop in dataShow ) ) {
+ dataShow[ prop ] = propTween.start;
+ if ( hidden ) {
+ propTween.end = propTween.start;
+ propTween.start = 0;
+ }
+ }
+ }
+}
+
+function propFilter( props, specialEasing ) {
+ var index, name, easing, value, hooks;
+
+ // camelCase, specialEasing and expand cssHook pass
+ for ( index in props ) {
+ name = jQuery.camelCase( index );
+ easing = specialEasing[ name ];
+ value = props[ index ];
+ if ( Array.isArray( value ) ) {
+ easing = value[ 1 ];
+ value = props[ index ] = value[ 0 ];
+ }
+
+ if ( index !== name ) {
+ props[ name ] = value;
+ delete props[ index ];
+ }
+
+ hooks = jQuery.cssHooks[ name ];
+ if ( hooks && "expand" in hooks ) {
+ value = hooks.expand( value );
+ delete props[ name ];
+
+ // Not quite $.extend, this won't overwrite existing keys.
+ // Reusing 'index' because we have the correct "name"
+ for ( index in value ) {
+ if ( !( index in props ) ) {
+ props[ index ] = value[ index ];
+ specialEasing[ index ] = easing;
+ }
+ }
+ } else {
+ specialEasing[ name ] = easing;
+ }
+ }
+}
+
+function Animation( elem, properties, options ) {
+ var result,
+ stopped,
+ index = 0,
+ length = Animation.prefilters.length,
+ deferred = jQuery.Deferred().always( function() {
+
+ // Don't match elem in the :animated selector
+ delete tick.elem;
+ } ),
+ tick = function() {
+ if ( stopped ) {
+ return false;
+ }
+ var currentTime = fxNow || createFxNow(),
+ remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ),
+
+ // Support: Android 2.3 only
+ // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497)
+ temp = remaining / animation.duration || 0,
+ percent = 1 - temp,
+ index = 0,
+ length = animation.tweens.length;
+
+ for ( ; index < length; index++ ) {
+ animation.tweens[ index ].run( percent );
+ }
+
+ deferred.notifyWith( elem, [ animation, percent, remaining ] );
+
+ // If there's more to do, yield
+ if ( percent < 1 && length ) {
+ return remaining;
+ }
+
+ // If this was an empty animation, synthesize a final progress notification
+ if ( !length ) {
+ deferred.notifyWith( elem, [ animation, 1, 0 ] );
+ }
+
+ // Resolve the animation and report its conclusion
+ deferred.resolveWith( elem, [ animation ] );
+ return false;
+ },
+ animation = deferred.promise( {
+ elem: elem,
+ props: jQuery.extend( {}, properties ),
+ opts: jQuery.extend( true, {
+ specialEasing: {},
+ easing: jQuery.easing._default
+ }, options ),
+ originalProperties: properties,
+ originalOptions: options,
+ startTime: fxNow || createFxNow(),
+ duration: options.duration,
+ tweens: [],
+ createTween: function( prop, end ) {
+ var tween = jQuery.Tween( elem, animation.opts, prop, end,
+ animation.opts.specialEasing[ prop ] || animation.opts.easing );
+ animation.tweens.push( tween );
+ return tween;
+ },
+ stop: function( gotoEnd ) {
+ var index = 0,
+
+ // If we are going to the end, we want to run all the tweens
+ // otherwise we skip this part
+ length = gotoEnd ? animation.tweens.length : 0;
+ if ( stopped ) {
+ return this;
+ }
+ stopped = true;
+ for ( ; index < length; index++ ) {
+ animation.tweens[ index ].run( 1 );
+ }
+
+ // Resolve when we played the last frame; otherwise, reject
+ if ( gotoEnd ) {
+ deferred.notifyWith( elem, [ animation, 1, 0 ] );
+ deferred.resolveWith( elem, [ animation, gotoEnd ] );
+ } else {
+ deferred.rejectWith( elem, [ animation, gotoEnd ] );
+ }
+ return this;
+ }
+ } ),
+ props = animation.props;
+
+ propFilter( props, animation.opts.specialEasing );
+
+ for ( ; index < length; index++ ) {
+ result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts );
+ if ( result ) {
+ if ( jQuery.isFunction( result.stop ) ) {
+ jQuery._queueHooks( animation.elem, animation.opts.queue ).stop =
+ jQuery.proxy( result.stop, result );
+ }
+ return result;
+ }
+ }
+
+ jQuery.map( props, createTween, animation );
+
+ if ( jQuery.isFunction( animation.opts.start ) ) {
+ animation.opts.start.call( elem, animation );
+ }
+
+ // Attach callbacks from options
+ animation
+ .progress( animation.opts.progress )
+ .done( animation.opts.done, animation.opts.complete )
+ .fail( animation.opts.fail )
+ .always( animation.opts.always );
+
+ jQuery.fx.timer(
+ jQuery.extend( tick, {
+ elem: elem,
+ anim: animation,
+ queue: animation.opts.queue
+ } )
+ );
+
+ return animation;
+}
+
+jQuery.Animation = jQuery.extend( Animation, {
+
+ tweeners: {
+ "*": [ function( prop, value ) {
+ var tween = this.createTween( prop, value );
+ adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween );
+ return tween;
+ } ]
+ },
+
+ tweener: function( props, callback ) {
+ if ( jQuery.isFunction( props ) ) {
+ callback = props;
+ props = [ "*" ];
+ } else {
+ props = props.match( rnothtmlwhite );
+ }
+
+ var prop,
+ index = 0,
+ length = props.length;
+
+ for ( ; index < length; index++ ) {
+ prop = props[ index ];
+ Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || [];
+ Animation.tweeners[ prop ].unshift( callback );
+ }
+ },
+
+ prefilters: [ defaultPrefilter ],
+
+ prefilter: function( callback, prepend ) {
+ if ( prepend ) {
+ Animation.prefilters.unshift( callback );
+ } else {
+ Animation.prefilters.push( callback );
+ }
+ }
+} );
+
+jQuery.speed = function( speed, easing, fn ) {
+ var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : {
+ complete: fn || !fn && easing ||
+ jQuery.isFunction( speed ) && speed,
+ duration: speed,
+ easing: fn && easing || easing && !jQuery.isFunction( easing ) && easing
+ };
+
+ // Go to the end state if fx are off
+ if ( jQuery.fx.off ) {
+ opt.duration = 0;
+
+ } else {
+ if ( typeof opt.duration !== "number" ) {
+ if ( opt.duration in jQuery.fx.speeds ) {
+ opt.duration = jQuery.fx.speeds[ opt.duration ];
+
+ } else {
+ opt.duration = jQuery.fx.speeds._default;
+ }
+ }
+ }
+
+ // Normalize opt.queue - true/undefined/null -> "fx"
+ if ( opt.queue == null || opt.queue === true ) {
+ opt.queue = "fx";
+ }
+
+ // Queueing
+ opt.old = opt.complete;
+
+ opt.complete = function() {
+ if ( jQuery.isFunction( opt.old ) ) {
+ opt.old.call( this );
+ }
+
+ if ( opt.queue ) {
+ jQuery.dequeue( this, opt.queue );
+ }
+ };
+
+ return opt;
+};
+
+jQuery.fn.extend( {
+ fadeTo: function( speed, to, easing, callback ) {
+
+ // Show any hidden elements after setting opacity to 0
+ return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show()
+
+ // Animate to the value specified
+ .end().animate( { opacity: to }, speed, easing, callback );
+ },
+ animate: function( prop, speed, easing, callback ) {
+ var empty = jQuery.isEmptyObject( prop ),
+ optall = jQuery.speed( speed, easing, callback ),
+ doAnimation = function() {
+
+ // Operate on a copy of prop so per-property easing won't be lost
+ var anim = Animation( this, jQuery.extend( {}, prop ), optall );
+
+ // Empty animations, or finishing resolves immediately
+ if ( empty || dataPriv.get( this, "finish" ) ) {
+ anim.stop( true );
+ }
+ };
+ doAnimation.finish = doAnimation;
+
+ return empty || optall.queue === false ?
+ this.each( doAnimation ) :
+ this.queue( optall.queue, doAnimation );
+ },
+ stop: function( type, clearQueue, gotoEnd ) {
+ var stopQueue = function( hooks ) {
+ var stop = hooks.stop;
+ delete hooks.stop;
+ stop( gotoEnd );
+ };
+
+ if ( typeof type !== "string" ) {
+ gotoEnd = clearQueue;
+ clearQueue = type;
+ type = undefined;
+ }
+ if ( clearQueue && type !== false ) {
+ this.queue( type || "fx", [] );
+ }
+
+ return this.each( function() {
+ var dequeue = true,
+ index = type != null && type + "queueHooks",
+ timers = jQuery.timers,
+ data = dataPriv.get( this );
+
+ if ( index ) {
+ if ( data[ index ] && data[ index ].stop ) {
+ stopQueue( data[ index ] );
+ }
+ } else {
+ for ( index in data ) {
+ if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) {
+ stopQueue( data[ index ] );
+ }
+ }
+ }
+
+ for ( index = timers.length; index--; ) {
+ if ( timers[ index ].elem === this &&
+ ( type == null || timers[ index ].queue === type ) ) {
+
+ timers[ index ].anim.stop( gotoEnd );
+ dequeue = false;
+ timers.splice( index, 1 );
+ }
+ }
+
+ // Start the next in the queue if the last step wasn't forced.
+ // Timers currently will call their complete callbacks, which
+ // will dequeue but only if they were gotoEnd.
+ if ( dequeue || !gotoEnd ) {
+ jQuery.dequeue( this, type );
+ }
+ } );
+ },
+ finish: function( type ) {
+ if ( type !== false ) {
+ type = type || "fx";
+ }
+ return this.each( function() {
+ var index,
+ data = dataPriv.get( this ),
+ queue = data[ type + "queue" ],
+ hooks = data[ type + "queueHooks" ],
+ timers = jQuery.timers,
+ length = queue ? queue.length : 0;
+
+ // Enable finishing flag on private data
+ data.finish = true;
+
+ // Empty the queue first
+ jQuery.queue( this, type, [] );
+
+ if ( hooks && hooks.stop ) {
+ hooks.stop.call( this, true );
+ }
+
+ // Look for any active animations, and finish them
+ for ( index = timers.length; index--; ) {
+ if ( timers[ index ].elem === this && timers[ index ].queue === type ) {
+ timers[ index ].anim.stop( true );
+ timers.splice( index, 1 );
+ }
+ }
+
+ // Look for any animations in the old queue and finish them
+ for ( index = 0; index < length; index++ ) {
+ if ( queue[ index ] && queue[ index ].finish ) {
+ queue[ index ].finish.call( this );
+ }
+ }
+
+ // Turn off finishing flag
+ delete data.finish;
+ } );
+ }
+} );
+
+jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) {
+ var cssFn = jQuery.fn[ name ];
+ jQuery.fn[ name ] = function( speed, easing, callback ) {
+ return speed == null || typeof speed === "boolean" ?
+ cssFn.apply( this, arguments ) :
+ this.animate( genFx( name, true ), speed, easing, callback );
+ };
+} );
+
+// Generate shortcuts for custom animations
+jQuery.each( {
+ slideDown: genFx( "show" ),
+ slideUp: genFx( "hide" ),
+ slideToggle: genFx( "toggle" ),
+ fadeIn: { opacity: "show" },
+ fadeOut: { opacity: "hide" },
+ fadeToggle: { opacity: "toggle" }
+}, function( name, props ) {
+ jQuery.fn[ name ] = function( speed, easing, callback ) {
+ return this.animate( props, speed, easing, callback );
+ };
+} );
+
+jQuery.timers = [];
+jQuery.fx.tick = function() {
+ var timer,
+ i = 0,
+ timers = jQuery.timers;
+
+ fxNow = jQuery.now();
+
+ for ( ; i < timers.length; i++ ) {
+ timer = timers[ i ];
+
+ // Run the timer and safely remove it when done (allowing for external removal)
+ if ( !timer() && timers[ i ] === timer ) {
+ timers.splice( i--, 1 );
+ }
+ }
+
+ if ( !timers.length ) {
+ jQuery.fx.stop();
+ }
+ fxNow = undefined;
+};
+
+jQuery.fx.timer = function( timer ) {
+ jQuery.timers.push( timer );
+ jQuery.fx.start();
+};
+
+jQuery.fx.interval = 13;
+jQuery.fx.start = function() {
+ if ( inProgress ) {
+ return;
+ }
+
+ inProgress = true;
+ schedule();
+};
+
+jQuery.fx.stop = function() {
+ inProgress = null;
+};
+
+jQuery.fx.speeds = {
+ slow: 600,
+ fast: 200,
+
+ // Default speed
+ _default: 400
+};
+
+
+// Based off of the plugin by Clint Helfers, with permission.
+// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/
+jQuery.fn.delay = function( time, type ) {
+ time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time;
+ type = type || "fx";
+
+ return this.queue( type, function( next, hooks ) {
+ var timeout = window.setTimeout( next, time );
+ hooks.stop = function() {
+ window.clearTimeout( timeout );
+ };
+ } );
+};
+
+
+( function() {
+ var input = document.createElement( "input" ),
+ select = document.createElement( "select" ),
+ opt = select.appendChild( document.createElement( "option" ) );
+
+ input.type = "checkbox";
+
+ // Support: Android <=4.3 only
+ // Default value for a checkbox should be "on"
+ support.checkOn = input.value !== "";
+
+ // Support: IE <=11 only
+ // Must access selectedIndex to make default options select
+ support.optSelected = opt.selected;
+
+ // Support: IE <=11 only
+ // An input loses its value after becoming a radio
+ input = document.createElement( "input" );
+ input.value = "t";
+ input.type = "radio";
+ support.radioValue = input.value === "t";
+} )();
+
+
+var boolHook,
+ attrHandle = jQuery.expr.attrHandle;
+
+jQuery.fn.extend( {
+ attr: function( name, value ) {
+ return access( this, jQuery.attr, name, value, arguments.length > 1 );
+ },
+
+ removeAttr: function( name ) {
+ return this.each( function() {
+ jQuery.removeAttr( this, name );
+ } );
+ }
+} );
+
+jQuery.extend( {
+ attr: function( elem, name, value ) {
+ var ret, hooks,
+ nType = elem.nodeType;
+
+ // Don't get/set attributes on text, comment and attribute nodes
+ if ( nType === 3 || nType === 8 || nType === 2 ) {
+ return;
+ }
+
+ // Fallback to prop when attributes are not supported
+ if ( typeof elem.getAttribute === "undefined" ) {
+ return jQuery.prop( elem, name, value );
+ }
+
+ // Attribute hooks are determined by the lowercase version
+ // Grab necessary hook if one is defined
+ if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {
+ hooks = jQuery.attrHooks[ name.toLowerCase() ] ||
+ ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined );
+ }
+
+ if ( value !== undefined ) {
+ if ( value === null ) {
+ jQuery.removeAttr( elem, name );
+ return;
+ }
+
+ if ( hooks && "set" in hooks &&
+ ( ret = hooks.set( elem, value, name ) ) !== undefined ) {
+ return ret;
+ }
+
+ elem.setAttribute( name, value + "" );
+ return value;
+ }
+
+ if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {
+ return ret;
+ }
+
+ ret = jQuery.find.attr( elem, name );
+
+ // Non-existent attributes return null, we normalize to undefined
+ return ret == null ? undefined : ret;
+ },
+
+ attrHooks: {
+ type: {
+ set: function( elem, value ) {
+ if ( !support.radioValue && value === "radio" &&
+ nodeName( elem, "input" ) ) {
+ var val = elem.value;
+ elem.setAttribute( "type", value );
+ if ( val ) {
+ elem.value = val;
+ }
+ return value;
+ }
+ }
+ }
+ },
+
+ removeAttr: function( elem, value ) {
+ var name,
+ i = 0,
+
+ // Attribute names can contain non-HTML whitespace characters
+ // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
+ attrNames = value && value.match( rnothtmlwhite );
+
+ if ( attrNames && elem.nodeType === 1 ) {
+ while ( ( name = attrNames[ i++ ] ) ) {
+ elem.removeAttribute( name );
+ }
+ }
+ }
+} );
+
+// Hooks for boolean attributes
+boolHook = {
+ set: function( elem, value, name ) {
+ if ( value === false ) {
+
+ // Remove boolean attributes when set to false
+ jQuery.removeAttr( elem, name );
+ } else {
+ elem.setAttribute( name, name );
+ }
+ return name;
+ }
+};
+
+jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) {
+ var getter = attrHandle[ name ] || jQuery.find.attr;
+
+ attrHandle[ name ] = function( elem, name, isXML ) {
+ var ret, handle,
+ lowercaseName = name.toLowerCase();
+
+ if ( !isXML ) {
+
+ // Avoid an infinite loop by temporarily removing this function from the getter
+ handle = attrHandle[ lowercaseName ];
+ attrHandle[ lowercaseName ] = ret;
+ ret = getter( elem, name, isXML ) != null ?
+ lowercaseName :
+ null;
+ attrHandle[ lowercaseName ] = handle;
+ }
+ return ret;
+ };
+} );
+
+
+
+
+var rfocusable = /^(?:input|select|textarea|button)$/i,
+ rclickable = /^(?:a|area)$/i;
+
+jQuery.fn.extend( {
+ prop: function( name, value ) {
+ return access( this, jQuery.prop, name, value, arguments.length > 1 );
+ },
+
+ removeProp: function( name ) {
+ return this.each( function() {
+ delete this[ jQuery.propFix[ name ] || name ];
+ } );
+ }
+} );
+
+jQuery.extend( {
+ prop: function( elem, name, value ) {
+ var ret, hooks,
+ nType = elem.nodeType;
+
+ // Don't get/set properties on text, comment and attribute nodes
+ if ( nType === 3 || nType === 8 || nType === 2 ) {
+ return;
+ }
+
+ if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {
+
+ // Fix name and attach hooks
+ name = jQuery.propFix[ name ] || name;
+ hooks = jQuery.propHooks[ name ];
+ }
+
+ if ( value !== undefined ) {
+ if ( hooks && "set" in hooks &&
+ ( ret = hooks.set( elem, value, name ) ) !== undefined ) {
+ return ret;
+ }
+
+ return ( elem[ name ] = value );
+ }
+
+ if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {
+ return ret;
+ }
+
+ return elem[ name ];
+ },
+
+ propHooks: {
+ tabIndex: {
+ get: function( elem ) {
+
+ // Support: IE <=9 - 11 only
+ // elem.tabIndex doesn't always return the
+ // correct value when it hasn't been explicitly set
+ // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/
+ // Use proper attribute retrieval(#12072)
+ var tabindex = jQuery.find.attr( elem, "tabindex" );
+
+ if ( tabindex ) {
+ return parseInt( tabindex, 10 );
+ }
+
+ if (
+ rfocusable.test( elem.nodeName ) ||
+ rclickable.test( elem.nodeName ) &&
+ elem.href
+ ) {
+ return 0;
+ }
+
+ return -1;
+ }
+ }
+ },
+
+ propFix: {
+ "for": "htmlFor",
+ "class": "className"
+ }
+} );
+
+// Support: IE <=11 only
+// Accessing the selectedIndex property
+// forces the browser to respect setting selected
+// on the option
+// The getter ensures a default option is selected
+// when in an optgroup
+// eslint rule "no-unused-expressions" is disabled for this code
+// since it considers such accessions noop
+if ( !support.optSelected ) {
+ jQuery.propHooks.selected = {
+ get: function( elem ) {
+
+ /* eslint no-unused-expressions: "off" */
+
+ var parent = elem.parentNode;
+ if ( parent && parent.parentNode ) {
+ parent.parentNode.selectedIndex;
+ }
+ return null;
+ },
+ set: function( elem ) {
+
+ /* eslint no-unused-expressions: "off" */
+
+ var parent = elem.parentNode;
+ if ( parent ) {
+ parent.selectedIndex;
+
+ if ( parent.parentNode ) {
+ parent.parentNode.selectedIndex;
+ }
+ }
+ }
+ };
+}
+
+jQuery.each( [
+ "tabIndex",
+ "readOnly",
+ "maxLength",
+ "cellSpacing",
+ "cellPadding",
+ "rowSpan",
+ "colSpan",
+ "useMap",
+ "frameBorder",
+ "contentEditable"
+], function() {
+ jQuery.propFix[ this.toLowerCase() ] = this;
+} );
+
+
+
+
+ // Strip and collapse whitespace according to HTML spec
+ // https://html.spec.whatwg.org/multipage/infrastructure.html#strip-and-collapse-whitespace
+ function stripAndCollapse( value ) {
+ var tokens = value.match( rnothtmlwhite ) || [];
+ return tokens.join( " " );
+ }
+
+
+function getClass( elem ) {
+ return elem.getAttribute && elem.getAttribute( "class" ) || "";
+}
+
+jQuery.fn.extend( {
+ addClass: function( value ) {
+ var classes, elem, cur, curValue, clazz, j, finalValue,
+ i = 0;
+
+ if ( jQuery.isFunction( value ) ) {
+ return this.each( function( j ) {
+ jQuery( this ).addClass( value.call( this, j, getClass( this ) ) );
+ } );
+ }
+
+ if ( typeof value === "string" && value ) {
+ classes = value.match( rnothtmlwhite ) || [];
+
+ while ( ( elem = this[ i++ ] ) ) {
+ curValue = getClass( elem );
+ cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " );
+
+ if ( cur ) {
+ j = 0;
+ while ( ( clazz = classes[ j++ ] ) ) {
+ if ( cur.indexOf( " " + clazz + " " ) < 0 ) {
+ cur += clazz + " ";
+ }
+ }
+
+ // Only assign if different to avoid unneeded rendering.
+ finalValue = stripAndCollapse( cur );
+ if ( curValue !== finalValue ) {
+ elem.setAttribute( "class", finalValue );
+ }
+ }
+ }
+ }
+
+ return this;
+ },
+
+ removeClass: function( value ) {
+ var classes, elem, cur, curValue, clazz, j, finalValue,
+ i = 0;
+
+ if ( jQuery.isFunction( value ) ) {
+ return this.each( function( j ) {
+ jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) );
+ } );
+ }
+
+ if ( !arguments.length ) {
+ return this.attr( "class", "" );
+ }
+
+ if ( typeof value === "string" && value ) {
+ classes = value.match( rnothtmlwhite ) || [];
+
+ while ( ( elem = this[ i++ ] ) ) {
+ curValue = getClass( elem );
+
+ // This expression is here for better compressibility (see addClass)
+ cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " );
+
+ if ( cur ) {
+ j = 0;
+ while ( ( clazz = classes[ j++ ] ) ) {
+
+ // Remove *all* instances
+ while ( cur.indexOf( " " + clazz + " " ) > -1 ) {
+ cur = cur.replace( " " + clazz + " ", " " );
+ }
+ }
+
+ // Only assign if different to avoid unneeded rendering.
+ finalValue = stripAndCollapse( cur );
+ if ( curValue !== finalValue ) {
+ elem.setAttribute( "class", finalValue );
+ }
+ }
+ }
+ }
+
+ return this;
+ },
+
+ toggleClass: function( value, stateVal ) {
+ var type = typeof value;
+
+ if ( typeof stateVal === "boolean" && type === "string" ) {
+ return stateVal ? this.addClass( value ) : this.removeClass( value );
+ }
+
+ if ( jQuery.isFunction( value ) ) {
+ return this.each( function( i ) {
+ jQuery( this ).toggleClass(
+ value.call( this, i, getClass( this ), stateVal ),
+ stateVal
+ );
+ } );
+ }
+
+ return this.each( function() {
+ var className, i, self, classNames;
+
+ if ( type === "string" ) {
+
+ // Toggle individual class names
+ i = 0;
+ self = jQuery( this );
+ classNames = value.match( rnothtmlwhite ) || [];
+
+ while ( ( className = classNames[ i++ ] ) ) {
+
+ // Check each className given, space separated list
+ if ( self.hasClass( className ) ) {
+ self.removeClass( className );
+ } else {
+ self.addClass( className );
+ }
+ }
+
+ // Toggle whole class name
+ } else if ( value === undefined || type === "boolean" ) {
+ className = getClass( this );
+ if ( className ) {
+
+ // Store className if set
+ dataPriv.set( this, "__className__", className );
+ }
+
+ // If the element has a class name or if we're passed `false`,
+ // then remove the whole classname (if there was one, the above saved it).
+ // Otherwise bring back whatever was previously saved (if anything),
+ // falling back to the empty string if nothing was stored.
+ if ( this.setAttribute ) {
+ this.setAttribute( "class",
+ className || value === false ?
+ "" :
+ dataPriv.get( this, "__className__" ) || ""
+ );
+ }
+ }
+ } );
+ },
+
+ hasClass: function( selector ) {
+ var className, elem,
+ i = 0;
+
+ className = " " + selector + " ";
+ while ( ( elem = this[ i++ ] ) ) {
+ if ( elem.nodeType === 1 &&
+ ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+} );
+
+
+
+
+var rreturn = /\r/g;
+
+jQuery.fn.extend( {
+ val: function( value ) {
+ var hooks, ret, isFunction,
+ elem = this[ 0 ];
+
+ if ( !arguments.length ) {
+ if ( elem ) {
+ hooks = jQuery.valHooks[ elem.type ] ||
+ jQuery.valHooks[ elem.nodeName.toLowerCase() ];
+
+ if ( hooks &&
+ "get" in hooks &&
+ ( ret = hooks.get( elem, "value" ) ) !== undefined
+ ) {
+ return ret;
+ }
+
+ ret = elem.value;
+
+ // Handle most common string cases
+ if ( typeof ret === "string" ) {
+ return ret.replace( rreturn, "" );
+ }
+
+ // Handle cases where value is null/undef or number
+ return ret == null ? "" : ret;
+ }
+
+ return;
+ }
+
+ isFunction = jQuery.isFunction( value );
+
+ return this.each( function( i ) {
+ var val;
+
+ if ( this.nodeType !== 1 ) {
+ return;
+ }
+
+ if ( isFunction ) {
+ val = value.call( this, i, jQuery( this ).val() );
+ } else {
+ val = value;
+ }
+
+ // Treat null/undefined as ""; convert numbers to string
+ if ( val == null ) {
+ val = "";
+
+ } else if ( typeof val === "number" ) {
+ val += "";
+
+ } else if ( Array.isArray( val ) ) {
+ val = jQuery.map( val, function( value ) {
+ return value == null ? "" : value + "";
+ } );
+ }
+
+ hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ];
+
+ // If set returns undefined, fall back to normal setting
+ if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) {
+ this.value = val;
+ }
+ } );
+ }
+} );
+
+jQuery.extend( {
+ valHooks: {
+ option: {
+ get: function( elem ) {
+
+ var val = jQuery.find.attr( elem, "value" );
+ return val != null ?
+ val :
+
+ // Support: IE <=10 - 11 only
+ // option.text throws exceptions (#14686, #14858)
+ // Strip and collapse whitespace
+ // https://html.spec.whatwg.org/#strip-and-collapse-whitespace
+ stripAndCollapse( jQuery.text( elem ) );
+ }
+ },
+ select: {
+ get: function( elem ) {
+ var value, option, i,
+ options = elem.options,
+ index = elem.selectedIndex,
+ one = elem.type === "select-one",
+ values = one ? null : [],
+ max = one ? index + 1 : options.length;
+
+ if ( index < 0 ) {
+ i = max;
+
+ } else {
+ i = one ? index : 0;
+ }
+
+ // Loop through all the selected options
+ for ( ; i < max; i++ ) {
+ option = options[ i ];
+
+ // Support: IE <=9 only
+ // IE8-9 doesn't update selected after form reset (#2551)
+ if ( ( option.selected || i === index ) &&
+
+ // Don't return options that are disabled or in a disabled optgroup
+ !option.disabled &&
+ ( !option.parentNode.disabled ||
+ !nodeName( option.parentNode, "optgroup" ) ) ) {
+
+ // Get the specific value for the option
+ value = jQuery( option ).val();
+
+ // We don't need an array for one selects
+ if ( one ) {
+ return value;
+ }
+
+ // Multi-Selects return an array
+ values.push( value );
+ }
+ }
+
+ return values;
+ },
+
+ set: function( elem, value ) {
+ var optionSet, option,
+ options = elem.options,
+ values = jQuery.makeArray( value ),
+ i = options.length;
+
+ while ( i-- ) {
+ option = options[ i ];
+
+ /* eslint-disable no-cond-assign */
+
+ if ( option.selected =
+ jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1
+ ) {
+ optionSet = true;
+ }
+
+ /* eslint-enable no-cond-assign */
+ }
+
+ // Force browsers to behave consistently when non-matching value is set
+ if ( !optionSet ) {
+ elem.selectedIndex = -1;
+ }
+ return values;
+ }
+ }
+ }
+} );
+
+// Radios and checkboxes getter/setter
+jQuery.each( [ "radio", "checkbox" ], function() {
+ jQuery.valHooks[ this ] = {
+ set: function( elem, value ) {
+ if ( Array.isArray( value ) ) {
+ return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 );
+ }
+ }
+ };
+ if ( !support.checkOn ) {
+ jQuery.valHooks[ this ].get = function( elem ) {
+ return elem.getAttribute( "value" ) === null ? "on" : elem.value;
+ };
+ }
+} );
+
+
+
+
+// Return jQuery for attributes-only inclusion
+
+
+var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/;
+
+jQuery.extend( jQuery.event, {
+
+ trigger: function( event, data, elem, onlyHandlers ) {
+
+ var i, cur, tmp, bubbleType, ontype, handle, special,
+ eventPath = [ elem || document ],
+ type = hasOwn.call( event, "type" ) ? event.type : event,
+ namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : [];
+
+ cur = tmp = elem = elem || document;
+
+ // Don't do events on text and comment nodes
+ if ( elem.nodeType === 3 || elem.nodeType === 8 ) {
+ return;
+ }
+
+ // focus/blur morphs to focusin/out; ensure we're not firing them right now
+ if ( rfocusMorph.test( type + jQuery.event.triggered ) ) {
+ return;
+ }
+
+ if ( type.indexOf( "." ) > -1 ) {
+
+ // Namespaced trigger; create a regexp to match event type in handle()
+ namespaces = type.split( "." );
+ type = namespaces.shift();
+ namespaces.sort();
+ }
+ ontype = type.indexOf( ":" ) < 0 && "on" + type;
+
+ // Caller can pass in a jQuery.Event object, Object, or just an event type string
+ event = event[ jQuery.expando ] ?
+ event :
+ new jQuery.Event( type, typeof event === "object" && event );
+
+ // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true)
+ event.isTrigger = onlyHandlers ? 2 : 3;
+ event.namespace = namespaces.join( "." );
+ event.rnamespace = event.namespace ?
+ new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) :
+ null;
+
+ // Clean up the event in case it is being reused
+ event.result = undefined;
+ if ( !event.target ) {
+ event.target = elem;
+ }
+
+ // Clone any incoming data and prepend the event, creating the handler arg list
+ data = data == null ?
+ [ event ] :
+ jQuery.makeArray( data, [ event ] );
+
+ // Allow special events to draw outside the lines
+ special = jQuery.event.special[ type ] || {};
+ if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) {
+ return;
+ }
+
+ // Determine event propagation path in advance, per W3C events spec (#9951)
+ // Bubble up to document, then to window; watch for a global ownerDocument var (#9724)
+ if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) {
+
+ bubbleType = special.delegateType || type;
+ if ( !rfocusMorph.test( bubbleType + type ) ) {
+ cur = cur.parentNode;
+ }
+ for ( ; cur; cur = cur.parentNode ) {
+ eventPath.push( cur );
+ tmp = cur;
+ }
+
+ // Only add window if we got to document (e.g., not plain obj or detached DOM)
+ if ( tmp === ( elem.ownerDocument || document ) ) {
+ eventPath.push( tmp.defaultView || tmp.parentWindow || window );
+ }
+ }
+
+ // Fire handlers on the event path
+ i = 0;
+ while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) {
+
+ event.type = i > 1 ?
+ bubbleType :
+ special.bindType || type;
+
+ // jQuery handler
+ handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] &&
+ dataPriv.get( cur, "handle" );
+ if ( handle ) {
+ handle.apply( cur, data );
+ }
+
+ // Native handler
+ handle = ontype && cur[ ontype ];
+ if ( handle && handle.apply && acceptData( cur ) ) {
+ event.result = handle.apply( cur, data );
+ if ( event.result === false ) {
+ event.preventDefault();
+ }
+ }
+ }
+ event.type = type;
+
+ // If nobody prevented the default action, do it now
+ if ( !onlyHandlers && !event.isDefaultPrevented() ) {
+
+ if ( ( !special._default ||
+ special._default.apply( eventPath.pop(), data ) === false ) &&
+ acceptData( elem ) ) {
+
+ // Call a native DOM method on the target with the same name as the event.
+ // Don't do default actions on window, that's where global variables be (#6170)
+ if ( ontype && jQuery.isFunction( elem[ type ] ) && !jQuery.isWindow( elem ) ) {
+
+ // Don't re-trigger an onFOO event when we call its FOO() method
+ tmp = elem[ ontype ];
+
+ if ( tmp ) {
+ elem[ ontype ] = null;
+ }
+
+ // Prevent re-triggering of the same event, since we already bubbled it above
+ jQuery.event.triggered = type;
+ elem[ type ]();
+ jQuery.event.triggered = undefined;
+
+ if ( tmp ) {
+ elem[ ontype ] = tmp;
+ }
+ }
+ }
+ }
+
+ return event.result;
+ },
+
+ // Piggyback on a donor event to simulate a different one
+ // Used only for `focus(in | out)` events
+ simulate: function( type, elem, event ) {
+ var e = jQuery.extend(
+ new jQuery.Event(),
+ event,
+ {
+ type: type,
+ isSimulated: true
+ }
+ );
+
+ jQuery.event.trigger( e, null, elem );
+ }
+
+} );
+
+jQuery.fn.extend( {
+
+ trigger: function( type, data ) {
+ return this.each( function() {
+ jQuery.event.trigger( type, data, this );
+ } );
+ },
+ triggerHandler: function( type, data ) {
+ var elem = this[ 0 ];
+ if ( elem ) {
+ return jQuery.event.trigger( type, data, elem, true );
+ }
+ }
+} );
+
+
+jQuery.each( ( "blur focus focusin focusout resize scroll click dblclick " +
+ "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " +
+ "change select submit keydown keypress keyup contextmenu" ).split( " " ),
+ function( i, name ) {
+
+ // Handle event binding
+ jQuery.fn[ name ] = function( data, fn ) {
+ return arguments.length > 0 ?
+ this.on( name, null, data, fn ) :
+ this.trigger( name );
+ };
+} );
+
+jQuery.fn.extend( {
+ hover: function( fnOver, fnOut ) {
+ return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver );
+ }
+} );
+
+
+
+
+support.focusin = "onfocusin" in window;
+
+
+// Support: Firefox <=44
+// Firefox doesn't have focus(in | out) events
+// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787
+//
+// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1
+// focus(in | out) events fire after focus & blur events,
+// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order
+// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857
+if ( !support.focusin ) {
+ jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) {
+
+ // Attach a single capturing handler on the document while someone wants focusin/focusout
+ var handler = function( event ) {
+ jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) );
+ };
+
+ jQuery.event.special[ fix ] = {
+ setup: function() {
+ var doc = this.ownerDocument || this,
+ attaches = dataPriv.access( doc, fix );
+
+ if ( !attaches ) {
+ doc.addEventListener( orig, handler, true );
+ }
+ dataPriv.access( doc, fix, ( attaches || 0 ) + 1 );
+ },
+ teardown: function() {
+ var doc = this.ownerDocument || this,
+ attaches = dataPriv.access( doc, fix ) - 1;
+
+ if ( !attaches ) {
+ doc.removeEventListener( orig, handler, true );
+ dataPriv.remove( doc, fix );
+
+ } else {
+ dataPriv.access( doc, fix, attaches );
+ }
+ }
+ };
+ } );
+}
+var location = window.location;
+
+var nonce = jQuery.now();
+
+var rquery = ( /\?/ );
+
+
+
+// Cross-browser xml parsing
+jQuery.parseXML = function( data ) {
+ var xml;
+ if ( !data || typeof data !== "string" ) {
+ return null;
+ }
+
+ // Support: IE 9 - 11 only
+ // IE throws on parseFromString with invalid input.
+ try {
+ xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" );
+ } catch ( e ) {
+ xml = undefined;
+ }
+
+ if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) {
+ jQuery.error( "Invalid XML: " + data );
+ }
+ return xml;
+};
+
+
+var
+ rbracket = /\[\]$/,
+ rCRLF = /\r?\n/g,
+ rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i,
+ rsubmittable = /^(?:input|select|textarea|keygen)/i;
+
+function buildParams( prefix, obj, traditional, add ) {
+ var name;
+
+ if ( Array.isArray( obj ) ) {
+
+ // Serialize array item.
+ jQuery.each( obj, function( i, v ) {
+ if ( traditional || rbracket.test( prefix ) ) {
+
+ // Treat each array item as a scalar.
+ add( prefix, v );
+
+ } else {
+
+ // Item is non-scalar (array or object), encode its numeric index.
+ buildParams(
+ prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]",
+ v,
+ traditional,
+ add
+ );
+ }
+ } );
+
+ } else if ( !traditional && jQuery.type( obj ) === "object" ) {
+
+ // Serialize object item.
+ for ( name in obj ) {
+ buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add );
+ }
+
+ } else {
+
+ // Serialize scalar item.
+ add( prefix, obj );
+ }
+}
+
+// Serialize an array of form elements or a set of
+// key/values into a query string
+jQuery.param = function( a, traditional ) {
+ var prefix,
+ s = [],
+ add = function( key, valueOrFunction ) {
+
+ // If value is a function, invoke it and use its return value
+ var value = jQuery.isFunction( valueOrFunction ) ?
+ valueOrFunction() :
+ valueOrFunction;
+
+ s[ s.length ] = encodeURIComponent( key ) + "=" +
+ encodeURIComponent( value == null ? "" : value );
+ };
+
+ // If an array was passed in, assume that it is an array of form elements.
+ if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) {
+
+ // Serialize the form elements
+ jQuery.each( a, function() {
+ add( this.name, this.value );
+ } );
+
+ } else {
+
+ // If traditional, encode the "old" way (the way 1.3.2 or older
+ // did it), otherwise encode params recursively.
+ for ( prefix in a ) {
+ buildParams( prefix, a[ prefix ], traditional, add );
+ }
+ }
+
+ // Return the resulting serialization
+ return s.join( "&" );
+};
+
+jQuery.fn.extend( {
+ serialize: function() {
+ return jQuery.param( this.serializeArray() );
+ },
+ serializeArray: function() {
+ return this.map( function() {
+
+ // Can add propHook for "elements" to filter or add form elements
+ var elements = jQuery.prop( this, "elements" );
+ return elements ? jQuery.makeArray( elements ) : this;
+ } )
+ .filter( function() {
+ var type = this.type;
+
+ // Use .is( ":disabled" ) so that fieldset[disabled] works
+ return this.name && !jQuery( this ).is( ":disabled" ) &&
+ rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) &&
+ ( this.checked || !rcheckableType.test( type ) );
+ } )
+ .map( function( i, elem ) {
+ var val = jQuery( this ).val();
+
+ if ( val == null ) {
+ return null;
+ }
+
+ if ( Array.isArray( val ) ) {
+ return jQuery.map( val, function( val ) {
+ return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
+ } );
+ }
+
+ return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
+ } ).get();
+ }
+} );
+
+
+var
+ r20 = /%20/g,
+ rhash = /#.*$/,
+ rantiCache = /([?&])_=[^&]*/,
+ rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg,
+
+ // #7653, #8125, #8152: local protocol detection
+ rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/,
+ rnoContent = /^(?:GET|HEAD)$/,
+ rprotocol = /^\/\//,
+
+ /* Prefilters
+ * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example)
+ * 2) These are called:
+ * - BEFORE asking for a transport
+ * - AFTER param serialization (s.data is a string if s.processData is true)
+ * 3) key is the dataType
+ * 4) the catchall symbol "*" can be used
+ * 5) execution will start with transport dataType and THEN continue down to "*" if needed
+ */
+ prefilters = {},
+
+ /* Transports bindings
+ * 1) key is the dataType
+ * 2) the catchall symbol "*" can be used
+ * 3) selection will start with transport dataType and THEN go to "*" if needed
+ */
+ transports = {},
+
+ // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression
+ allTypes = "*/".concat( "*" ),
+
+ // Anchor tag for parsing the document origin
+ originAnchor = document.createElement( "a" );
+ originAnchor.href = location.href;
+
+// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport
+function addToPrefiltersOrTransports( structure ) {
+
+ // dataTypeExpression is optional and defaults to "*"
+ return function( dataTypeExpression, func ) {
+
+ if ( typeof dataTypeExpression !== "string" ) {
+ func = dataTypeExpression;
+ dataTypeExpression = "*";
+ }
+
+ var dataType,
+ i = 0,
+ dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || [];
+
+ if ( jQuery.isFunction( func ) ) {
+
+ // For each dataType in the dataTypeExpression
+ while ( ( dataType = dataTypes[ i++ ] ) ) {
+
+ // Prepend if requested
+ if ( dataType[ 0 ] === "+" ) {
+ dataType = dataType.slice( 1 ) || "*";
+ ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func );
+
+ // Otherwise append
+ } else {
+ ( structure[ dataType ] = structure[ dataType ] || [] ).push( func );
+ }
+ }
+ }
+ };
+}
+
+// Base inspection function for prefilters and transports
+function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) {
+
+ var inspected = {},
+ seekingTransport = ( structure === transports );
+
+ function inspect( dataType ) {
+ var selected;
+ inspected[ dataType ] = true;
+ jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) {
+ var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR );
+ if ( typeof dataTypeOrTransport === "string" &&
+ !seekingTransport && !inspected[ dataTypeOrTransport ] ) {
+
+ options.dataTypes.unshift( dataTypeOrTransport );
+ inspect( dataTypeOrTransport );
+ return false;
+ } else if ( seekingTransport ) {
+ return !( selected = dataTypeOrTransport );
+ }
+ } );
+ return selected;
+ }
+
+ return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" );
+}
+
+// A special extend for ajax options
+// that takes "flat" options (not to be deep extended)
+// Fixes #9887
+function ajaxExtend( target, src ) {
+ var key, deep,
+ flatOptions = jQuery.ajaxSettings.flatOptions || {};
+
+ for ( key in src ) {
+ if ( src[ key ] !== undefined ) {
+ ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ];
+ }
+ }
+ if ( deep ) {
+ jQuery.extend( true, target, deep );
+ }
+
+ return target;
+}
+
+/* Handles responses to an ajax request:
+ * - finds the right dataType (mediates between content-type and expected dataType)
+ * - returns the corresponding response
+ */
+function ajaxHandleResponses( s, jqXHR, responses ) {
+
+ var ct, type, finalDataType, firstDataType,
+ contents = s.contents,
+ dataTypes = s.dataTypes;
+
+ // Remove auto dataType and get content-type in the process
+ while ( dataTypes[ 0 ] === "*" ) {
+ dataTypes.shift();
+ if ( ct === undefined ) {
+ ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" );
+ }
+ }
+
+ // Check if we're dealing with a known content-type
+ if ( ct ) {
+ for ( type in contents ) {
+ if ( contents[ type ] && contents[ type ].test( ct ) ) {
+ dataTypes.unshift( type );
+ break;
+ }
+ }
+ }
+
+ // Check to see if we have a response for the expected dataType
+ if ( dataTypes[ 0 ] in responses ) {
+ finalDataType = dataTypes[ 0 ];
+ } else {
+
+ // Try convertible dataTypes
+ for ( type in responses ) {
+ if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) {
+ finalDataType = type;
+ break;
+ }
+ if ( !firstDataType ) {
+ firstDataType = type;
+ }
+ }
+
+ // Or just use first one
+ finalDataType = finalDataType || firstDataType;
+ }
+
+ // If we found a dataType
+ // We add the dataType to the list if needed
+ // and return the corresponding response
+ if ( finalDataType ) {
+ if ( finalDataType !== dataTypes[ 0 ] ) {
+ dataTypes.unshift( finalDataType );
+ }
+ return responses[ finalDataType ];
+ }
+}
+
+/* Chain conversions given the request and the original response
+ * Also sets the responseXXX fields on the jqXHR instance
+ */
+function ajaxConvert( s, response, jqXHR, isSuccess ) {
+ var conv2, current, conv, tmp, prev,
+ converters = {},
+
+ // Work with a copy of dataTypes in case we need to modify it for conversion
+ dataTypes = s.dataTypes.slice();
+
+ // Create converters map with lowercased keys
+ if ( dataTypes[ 1 ] ) {
+ for ( conv in s.converters ) {
+ converters[ conv.toLowerCase() ] = s.converters[ conv ];
+ }
+ }
+
+ current = dataTypes.shift();
+
+ // Convert to each sequential dataType
+ while ( current ) {
+
+ if ( s.responseFields[ current ] ) {
+ jqXHR[ s.responseFields[ current ] ] = response;
+ }
+
+ // Apply the dataFilter if provided
+ if ( !prev && isSuccess && s.dataFilter ) {
+ response = s.dataFilter( response, s.dataType );
+ }
+
+ prev = current;
+ current = dataTypes.shift();
+
+ if ( current ) {
+
+ // There's only work to do if current dataType is non-auto
+ if ( current === "*" ) {
+
+ current = prev;
+
+ // Convert response if prev dataType is non-auto and differs from current
+ } else if ( prev !== "*" && prev !== current ) {
+
+ // Seek a direct converter
+ conv = converters[ prev + " " + current ] || converters[ "* " + current ];
+
+ // If none found, seek a pair
+ if ( !conv ) {
+ for ( conv2 in converters ) {
+
+ // If conv2 outputs current
+ tmp = conv2.split( " " );
+ if ( tmp[ 1 ] === current ) {
+
+ // If prev can be converted to accepted input
+ conv = converters[ prev + " " + tmp[ 0 ] ] ||
+ converters[ "* " + tmp[ 0 ] ];
+ if ( conv ) {
+
+ // Condense equivalence converters
+ if ( conv === true ) {
+ conv = converters[ conv2 ];
+
+ // Otherwise, insert the intermediate dataType
+ } else if ( converters[ conv2 ] !== true ) {
+ current = tmp[ 0 ];
+ dataTypes.unshift( tmp[ 1 ] );
+ }
+ break;
+ }
+ }
+ }
+ }
+
+ // Apply converter (if not an equivalence)
+ if ( conv !== true ) {
+
+ // Unless errors are allowed to bubble, catch and return them
+ if ( conv && s.throws ) {
+ response = conv( response );
+ } else {
+ try {
+ response = conv( response );
+ } catch ( e ) {
+ return {
+ state: "parsererror",
+ error: conv ? e : "No conversion from " + prev + " to " + current
+ };
+ }
+ }
+ }
+ }
+ }
+ }
+
+ return { state: "success", data: response };
+}
+
+jQuery.extend( {
+
+ // Counter for holding the number of active queries
+ active: 0,
+
+ // Last-Modified header cache for next request
+ lastModified: {},
+ etag: {},
+
+ ajaxSettings: {
+ url: location.href,
+ type: "GET",
+ isLocal: rlocalProtocol.test( location.protocol ),
+ global: true,
+ processData: true,
+ async: true,
+ contentType: "application/x-www-form-urlencoded; charset=UTF-8",
+
+ /*
+ timeout: 0,
+ data: null,
+ dataType: null,
+ username: null,
+ password: null,
+ cache: null,
+ throws: false,
+ traditional: false,
+ headers: {},
+ */
+
+ accepts: {
+ "*": allTypes,
+ text: "text/plain",
+ html: "text/html",
+ xml: "application/xml, text/xml",
+ json: "application/json, text/javascript"
+ },
+
+ contents: {
+ xml: /\bxml\b/,
+ html: /\bhtml/,
+ json: /\bjson\b/
+ },
+
+ responseFields: {
+ xml: "responseXML",
+ text: "responseText",
+ json: "responseJSON"
+ },
+
+ // Data converters
+ // Keys separate source (or catchall "*") and destination types with a single space
+ converters: {
+
+ // Convert anything to text
+ "* text": String,
+
+ // Text to html (true = no transformation)
+ "text html": true,
+
+ // Evaluate text as a json expression
+ "text json": JSON.parse,
+
+ // Parse text as xml
+ "text xml": jQuery.parseXML
+ },
+
+ // For options that shouldn't be deep extended:
+ // you can add your own custom options here if
+ // and when you create one that shouldn't be
+ // deep extended (see ajaxExtend)
+ flatOptions: {
+ url: true,
+ context: true
+ }
+ },
+
+ // Creates a full fledged settings object into target
+ // with both ajaxSettings and settings fields.
+ // If target is omitted, writes into ajaxSettings.
+ ajaxSetup: function( target, settings ) {
+ return settings ?
+
+ // Building a settings object
+ ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) :
+
+ // Extending ajaxSettings
+ ajaxExtend( jQuery.ajaxSettings, target );
+ },
+
+ ajaxPrefilter: addToPrefiltersOrTransports( prefilters ),
+ ajaxTransport: addToPrefiltersOrTransports( transports ),
+
+ // Main method
+ ajax: function( url, options ) {
+
+ // If url is an object, simulate pre-1.5 signature
+ if ( typeof url === "object" ) {
+ options = url;
+ url = undefined;
+ }
+
+ // Force options to be an object
+ options = options || {};
+
+ var transport,
+
+ // URL without anti-cache param
+ cacheURL,
+
+ // Response headers
+ responseHeadersString,
+ responseHeaders,
+
+ // timeout handle
+ timeoutTimer,
+
+ // Url cleanup var
+ urlAnchor,
+
+ // Request state (becomes false upon send and true upon completion)
+ completed,
+
+ // To know if global events are to be dispatched
+ fireGlobals,
+
+ // Loop variable
+ i,
+
+ // uncached part of the url
+ uncached,
+
+ // Create the final options object
+ s = jQuery.ajaxSetup( {}, options ),
+
+ // Callbacks context
+ callbackContext = s.context || s,
+
+ // Context for global events is callbackContext if it is a DOM node or jQuery collection
+ globalEventContext = s.context &&
+ ( callbackContext.nodeType || callbackContext.jquery ) ?
+ jQuery( callbackContext ) :
+ jQuery.event,
+
+ // Deferreds
+ deferred = jQuery.Deferred(),
+ completeDeferred = jQuery.Callbacks( "once memory" ),
+
+ // Status-dependent callbacks
+ statusCode = s.statusCode || {},
+
+ // Headers (they are sent all at once)
+ requestHeaders = {},
+ requestHeadersNames = {},
+
+ // Default abort message
+ strAbort = "canceled",
+
+ // Fake xhr
+ jqXHR = {
+ readyState: 0,
+
+ // Builds headers hashtable if needed
+ getResponseHeader: function( key ) {
+ var match;
+ if ( completed ) {
+ if ( !responseHeaders ) {
+ responseHeaders = {};
+ while ( ( match = rheaders.exec( responseHeadersString ) ) ) {
+ responseHeaders[ match[ 1 ].toLowerCase() ] = match[ 2 ];
+ }
+ }
+ match = responseHeaders[ key.toLowerCase() ];
+ }
+ return match == null ? null : match;
+ },
+
+ // Raw string
+ getAllResponseHeaders: function() {
+ return completed ? responseHeadersString : null;
+ },
+
+ // Caches the header
+ setRequestHeader: function( name, value ) {
+ if ( completed == null ) {
+ name = requestHeadersNames[ name.toLowerCase() ] =
+ requestHeadersNames[ name.toLowerCase() ] || name;
+ requestHeaders[ name ] = value;
+ }
+ return this;
+ },
+
+ // Overrides response content-type header
+ overrideMimeType: function( type ) {
+ if ( completed == null ) {
+ s.mimeType = type;
+ }
+ return this;
+ },
+
+ // Status-dependent callbacks
+ statusCode: function( map ) {
+ var code;
+ if ( map ) {
+ if ( completed ) {
+
+ // Execute the appropriate callbacks
+ jqXHR.always( map[ jqXHR.status ] );
+ } else {
+
+ // Lazy-add the new callbacks in a way that preserves old ones
+ for ( code in map ) {
+ statusCode[ code ] = [ statusCode[ code ], map[ code ] ];
+ }
+ }
+ }
+ return this;
+ },
+
+ // Cancel the request
+ abort: function( statusText ) {
+ var finalText = statusText || strAbort;
+ if ( transport ) {
+ transport.abort( finalText );
+ }
+ done( 0, finalText );
+ return this;
+ }
+ };
+
+ // Attach deferreds
+ deferred.promise( jqXHR );
+
+ // Add protocol if not provided (prefilters might expect it)
+ // Handle falsy url in the settings object (#10093: consistency with old signature)
+ // We also use the url parameter if available
+ s.url = ( ( url || s.url || location.href ) + "" )
+ .replace( rprotocol, location.protocol + "//" );
+
+ // Alias method option to type as per ticket #12004
+ s.type = options.method || options.type || s.method || s.type;
+
+ // Extract dataTypes list
+ s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ];
+
+ // A cross-domain request is in order when the origin doesn't match the current origin.
+ if ( s.crossDomain == null ) {
+ urlAnchor = document.createElement( "a" );
+
+ // Support: IE <=8 - 11, Edge 12 - 13
+ // IE throws exception on accessing the href property if url is malformed,
+ // e.g. http://example.com:80x/
+ try {
+ urlAnchor.href = s.url;
+
+ // Support: IE <=8 - 11 only
+ // Anchor's host property isn't correctly set when s.url is relative
+ urlAnchor.href = urlAnchor.href;
+ s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !==
+ urlAnchor.protocol + "//" + urlAnchor.host;
+ } catch ( e ) {
+
+ // If there is an error parsing the URL, assume it is crossDomain,
+ // it can be rejected by the transport if it is invalid
+ s.crossDomain = true;
+ }
+ }
+
+ // Convert data if not already a string
+ if ( s.data && s.processData && typeof s.data !== "string" ) {
+ s.data = jQuery.param( s.data, s.traditional );
+ }
+
+ // Apply prefilters
+ inspectPrefiltersOrTransports( prefilters, s, options, jqXHR );
+
+ // If request was aborted inside a prefilter, stop there
+ if ( completed ) {
+ return jqXHR;
+ }
+
+ // We can fire global events as of now if asked to
+ // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118)
+ fireGlobals = jQuery.event && s.global;
+
+ // Watch for a new set of requests
+ if ( fireGlobals && jQuery.active++ === 0 ) {
+ jQuery.event.trigger( "ajaxStart" );
+ }
+
+ // Uppercase the type
+ s.type = s.type.toUpperCase();
+
+ // Determine if request has content
+ s.hasContent = !rnoContent.test( s.type );
+
+ // Save the URL in case we're toying with the If-Modified-Since
+ // and/or If-None-Match header later on
+ // Remove hash to simplify url manipulation
+ cacheURL = s.url.replace( rhash, "" );
+
+ // More options handling for requests with no content
+ if ( !s.hasContent ) {
+
+ // Remember the hash so we can put it back
+ uncached = s.url.slice( cacheURL.length );
+
+ // If data is available, append data to url
+ if ( s.data ) {
+ cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data;
+
+ // #9682: remove data so that it's not used in an eventual retry
+ delete s.data;
+ }
+
+ // Add or update anti-cache param if needed
+ if ( s.cache === false ) {
+ cacheURL = cacheURL.replace( rantiCache, "$1" );
+ uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached;
+ }
+
+ // Put hash and anti-cache on the URL that will be requested (gh-1732)
+ s.url = cacheURL + uncached;
+
+ // Change '%20' to '+' if this is encoded form body content (gh-2658)
+ } else if ( s.data && s.processData &&
+ ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) {
+ s.data = s.data.replace( r20, "+" );
+ }
+
+ // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+ if ( s.ifModified ) {
+ if ( jQuery.lastModified[ cacheURL ] ) {
+ jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] );
+ }
+ if ( jQuery.etag[ cacheURL ] ) {
+ jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] );
+ }
+ }
+
+ // Set the correct header, if data is being sent
+ if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) {
+ jqXHR.setRequestHeader( "Content-Type", s.contentType );
+ }
+
+ // Set the Accepts header for the server, depending on the dataType
+ jqXHR.setRequestHeader(
+ "Accept",
+ s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ?
+ s.accepts[ s.dataTypes[ 0 ] ] +
+ ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) :
+ s.accepts[ "*" ]
+ );
+
+ // Check for headers option
+ for ( i in s.headers ) {
+ jqXHR.setRequestHeader( i, s.headers[ i ] );
+ }
+
+ // Allow custom headers/mimetypes and early abort
+ if ( s.beforeSend &&
+ ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) {
+
+ // Abort if not done already and return
+ return jqXHR.abort();
+ }
+
+ // Aborting is no longer a cancellation
+ strAbort = "abort";
+
+ // Install callbacks on deferreds
+ completeDeferred.add( s.complete );
+ jqXHR.done( s.success );
+ jqXHR.fail( s.error );
+
+ // Get transport
+ transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR );
+
+ // If no transport, we auto-abort
+ if ( !transport ) {
+ done( -1, "No Transport" );
+ } else {
+ jqXHR.readyState = 1;
+
+ // Send global event
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] );
+ }
+
+ // If request was aborted inside ajaxSend, stop there
+ if ( completed ) {
+ return jqXHR;
+ }
+
+ // Timeout
+ if ( s.async && s.timeout > 0 ) {
+ timeoutTimer = window.setTimeout( function() {
+ jqXHR.abort( "timeout" );
+ }, s.timeout );
+ }
+
+ try {
+ completed = false;
+ transport.send( requestHeaders, done );
+ } catch ( e ) {
+
+ // Rethrow post-completion exceptions
+ if ( completed ) {
+ throw e;
+ }
+
+ // Propagate others as results
+ done( -1, e );
+ }
+ }
+
+ // Callback for when everything is done
+ function done( status, nativeStatusText, responses, headers ) {
+ var isSuccess, success, error, response, modified,
+ statusText = nativeStatusText;
+
+ // Ignore repeat invocations
+ if ( completed ) {
+ return;
+ }
+
+ completed = true;
+
+ // Clear timeout if it exists
+ if ( timeoutTimer ) {
+ window.clearTimeout( timeoutTimer );
+ }
+
+ // Dereference transport for early garbage collection
+ // (no matter how long the jqXHR object will be used)
+ transport = undefined;
+
+ // Cache response headers
+ responseHeadersString = headers || "";
+
+ // Set readyState
+ jqXHR.readyState = status > 0 ? 4 : 0;
+
+ // Determine if successful
+ isSuccess = status >= 200 && status < 300 || status === 304;
+
+ // Get response data
+ if ( responses ) {
+ response = ajaxHandleResponses( s, jqXHR, responses );
+ }
+
+ // Convert no matter what (that way responseXXX fields are always set)
+ response = ajaxConvert( s, response, jqXHR, isSuccess );
+
+ // If successful, handle type chaining
+ if ( isSuccess ) {
+
+ // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+ if ( s.ifModified ) {
+ modified = jqXHR.getResponseHeader( "Last-Modified" );
+ if ( modified ) {
+ jQuery.lastModified[ cacheURL ] = modified;
+ }
+ modified = jqXHR.getResponseHeader( "etag" );
+ if ( modified ) {
+ jQuery.etag[ cacheURL ] = modified;
+ }
+ }
+
+ // if no content
+ if ( status === 204 || s.type === "HEAD" ) {
+ statusText = "nocontent";
+
+ // if not modified
+ } else if ( status === 304 ) {
+ statusText = "notmodified";
+
+ // If we have data, let's convert it
+ } else {
+ statusText = response.state;
+ success = response.data;
+ error = response.error;
+ isSuccess = !error;
+ }
+ } else {
+
+ // Extract error from statusText and normalize for non-aborts
+ error = statusText;
+ if ( status || !statusText ) {
+ statusText = "error";
+ if ( status < 0 ) {
+ status = 0;
+ }
+ }
+ }
+
+ // Set data for the fake xhr object
+ jqXHR.status = status;
+ jqXHR.statusText = ( nativeStatusText || statusText ) + "";
+
+ // Success/Error
+ if ( isSuccess ) {
+ deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] );
+ } else {
+ deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] );
+ }
+
+ // Status-dependent callbacks
+ jqXHR.statusCode( statusCode );
+ statusCode = undefined;
+
+ if ( fireGlobals ) {
+ globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError",
+ [ jqXHR, s, isSuccess ? success : error ] );
+ }
+
+ // Complete
+ completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] );
+
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] );
+
+ // Handle the global AJAX counter
+ if ( !( --jQuery.active ) ) {
+ jQuery.event.trigger( "ajaxStop" );
+ }
+ }
+ }
+
+ return jqXHR;
+ },
+
+ getJSON: function( url, data, callback ) {
+ return jQuery.get( url, data, callback, "json" );
+ },
+
+ getScript: function( url, callback ) {
+ return jQuery.get( url, undefined, callback, "script" );
+ }
+} );
+
+jQuery.each( [ "get", "post" ], function( i, method ) {
+ jQuery[ method ] = function( url, data, callback, type ) {
+
+ // Shift arguments if data argument was omitted
+ if ( jQuery.isFunction( data ) ) {
+ type = type || callback;
+ callback = data;
+ data = undefined;
+ }
+
+ // The url can be an options object (which then must have .url)
+ return jQuery.ajax( jQuery.extend( {
+ url: url,
+ type: method,
+ dataType: type,
+ data: data,
+ success: callback
+ }, jQuery.isPlainObject( url ) && url ) );
+ };
+} );
+
+
+jQuery._evalUrl = function( url ) {
+ return jQuery.ajax( {
+ url: url,
+
+ // Make this explicit, since user can override this through ajaxSetup (#11264)
+ type: "GET",
+ dataType: "script",
+ cache: true,
+ async: false,
+ global: false,
+ "throws": true
+ } );
+};
+
+
+jQuery.fn.extend( {
+ wrapAll: function( html ) {
+ var wrap;
+
+ if ( this[ 0 ] ) {
+ if ( jQuery.isFunction( html ) ) {
+ html = html.call( this[ 0 ] );
+ }
+
+ // The elements to wrap the target around
+ wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true );
+
+ if ( this[ 0 ].parentNode ) {
+ wrap.insertBefore( this[ 0 ] );
+ }
+
+ wrap.map( function() {
+ var elem = this;
+
+ while ( elem.firstElementChild ) {
+ elem = elem.firstElementChild;
+ }
+
+ return elem;
+ } ).append( this );
+ }
+
+ return this;
+ },
+
+ wrapInner: function( html ) {
+ if ( jQuery.isFunction( html ) ) {
+ return this.each( function( i ) {
+ jQuery( this ).wrapInner( html.call( this, i ) );
+ } );
+ }
+
+ return this.each( function() {
+ var self = jQuery( this ),
+ contents = self.contents();
+
+ if ( contents.length ) {
+ contents.wrapAll( html );
+
+ } else {
+ self.append( html );
+ }
+ } );
+ },
+
+ wrap: function( html ) {
+ var isFunction = jQuery.isFunction( html );
+
+ return this.each( function( i ) {
+ jQuery( this ).wrapAll( isFunction ? html.call( this, i ) : html );
+ } );
+ },
+
+ unwrap: function( selector ) {
+ this.parent( selector ).not( "body" ).each( function() {
+ jQuery( this ).replaceWith( this.childNodes );
+ } );
+ return this;
+ }
+} );
+
+
+jQuery.expr.pseudos.hidden = function( elem ) {
+ return !jQuery.expr.pseudos.visible( elem );
+};
+jQuery.expr.pseudos.visible = function( elem ) {
+ return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length );
+};
+
+
+
+
+jQuery.ajaxSettings.xhr = function() {
+ try {
+ return new window.XMLHttpRequest();
+ } catch ( e ) {}
+};
+
+var xhrSuccessStatus = {
+
+ // File protocol always yields status code 0, assume 200
+ 0: 200,
+
+ // Support: IE <=9 only
+ // #1450: sometimes IE returns 1223 when it should be 204
+ 1223: 204
+ },
+ xhrSupported = jQuery.ajaxSettings.xhr();
+
+support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported );
+support.ajax = xhrSupported = !!xhrSupported;
+
+jQuery.ajaxTransport( function( options ) {
+ var callback, errorCallback;
+
+ // Cross domain only allowed if supported through XMLHttpRequest
+ if ( support.cors || xhrSupported && !options.crossDomain ) {
+ return {
+ send: function( headers, complete ) {
+ var i,
+ xhr = options.xhr();
+
+ xhr.open(
+ options.type,
+ options.url,
+ options.async,
+ options.username,
+ options.password
+ );
+
+ // Apply custom fields if provided
+ if ( options.xhrFields ) {
+ for ( i in options.xhrFields ) {
+ xhr[ i ] = options.xhrFields[ i ];
+ }
+ }
+
+ // Override mime type if needed
+ if ( options.mimeType && xhr.overrideMimeType ) {
+ xhr.overrideMimeType( options.mimeType );
+ }
+
+ // X-Requested-With header
+ // For cross-domain requests, seeing as conditions for a preflight are
+ // akin to a jigsaw puzzle, we simply never set it to be sure.
+ // (it can always be set on a per-request basis or even using ajaxSetup)
+ // For same-domain requests, won't change header if already provided.
+ if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) {
+ headers[ "X-Requested-With" ] = "XMLHttpRequest";
+ }
+
+ // Set headers
+ for ( i in headers ) {
+ xhr.setRequestHeader( i, headers[ i ] );
+ }
+
+ // Callback
+ callback = function( type ) {
+ return function() {
+ if ( callback ) {
+ callback = errorCallback = xhr.onload =
+ xhr.onerror = xhr.onabort = xhr.onreadystatechange = null;
+
+ if ( type === "abort" ) {
+ xhr.abort();
+ } else if ( type === "error" ) {
+
+ // Support: IE <=9 only
+ // On a manual native abort, IE9 throws
+ // errors on any property access that is not readyState
+ if ( typeof xhr.status !== "number" ) {
+ complete( 0, "error" );
+ } else {
+ complete(
+
+ // File: protocol always yields status 0; see #8605, #14207
+ xhr.status,
+ xhr.statusText
+ );
+ }
+ } else {
+ complete(
+ xhrSuccessStatus[ xhr.status ] || xhr.status,
+ xhr.statusText,
+
+ // Support: IE <=9 only
+ // IE9 has no XHR2 but throws on binary (trac-11426)
+ // For XHR2 non-text, let the caller handle it (gh-2498)
+ ( xhr.responseType || "text" ) !== "text" ||
+ typeof xhr.responseText !== "string" ?
+ { binary: xhr.response } :
+ { text: xhr.responseText },
+ xhr.getAllResponseHeaders()
+ );
+ }
+ }
+ };
+ };
+
+ // Listen to events
+ xhr.onload = callback();
+ errorCallback = xhr.onerror = callback( "error" );
+
+ // Support: IE 9 only
+ // Use onreadystatechange to replace onabort
+ // to handle uncaught aborts
+ if ( xhr.onabort !== undefined ) {
+ xhr.onabort = errorCallback;
+ } else {
+ xhr.onreadystatechange = function() {
+
+ // Check readyState before timeout as it changes
+ if ( xhr.readyState === 4 ) {
+
+ // Allow onerror to be called first,
+ // but that will not handle a native abort
+ // Also, save errorCallback to a variable
+ // as xhr.onerror cannot be accessed
+ window.setTimeout( function() {
+ if ( callback ) {
+ errorCallback();
+ }
+ } );
+ }
+ };
+ }
+
+ // Create the abort callback
+ callback = callback( "abort" );
+
+ try {
+
+ // Do send the request (this may raise an exception)
+ xhr.send( options.hasContent && options.data || null );
+ } catch ( e ) {
+
+ // #14683: Only rethrow if this hasn't been notified as an error yet
+ if ( callback ) {
+ throw e;
+ }
+ }
+ },
+
+ abort: function() {
+ if ( callback ) {
+ callback();
+ }
+ }
+ };
+ }
+} );
+
+
+
+
+// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432)
+jQuery.ajaxPrefilter( function( s ) {
+ if ( s.crossDomain ) {
+ s.contents.script = false;
+ }
+} );
+
+// Install script dataType
+jQuery.ajaxSetup( {
+ accepts: {
+ script: "text/javascript, application/javascript, " +
+ "application/ecmascript, application/x-ecmascript"
+ },
+ contents: {
+ script: /\b(?:java|ecma)script\b/
+ },
+ converters: {
+ "text script": function( text ) {
+ jQuery.globalEval( text );
+ return text;
+ }
+ }
+} );
+
+// Handle cache's special case and crossDomain
+jQuery.ajaxPrefilter( "script", function( s ) {
+ if ( s.cache === undefined ) {
+ s.cache = false;
+ }
+ if ( s.crossDomain ) {
+ s.type = "GET";
+ }
+} );
+
+// Bind script tag hack transport
+jQuery.ajaxTransport( "script", function( s ) {
+
+ // This transport only deals with cross domain requests
+ if ( s.crossDomain ) {
+ var script, callback;
+ return {
+ send: function( _, complete ) {
+ script = jQuery( "<script>" ).prop( {
+ charset: s.scriptCharset,
+ src: s.url
+ } ).on(
+ "load error",
+ callback = function( evt ) {
+ script.remove();
+ callback = null;
+ if ( evt ) {
+ complete( evt.type === "error" ? 404 : 200, evt.type );
+ }
+ }
+ );
+
+ // Use native DOM manipulation to avoid our domManip AJAX trickery
+ document.head.appendChild( script[ 0 ] );
+ },
+ abort: function() {
+ if ( callback ) {
+ callback();
+ }
+ }
+ };
+ }
+} );
+
+
+
+
+var oldCallbacks = [],
+ rjsonp = /(=)\?(?=&|$)|\?\?/;
+
+// Default jsonp settings
+jQuery.ajaxSetup( {
+ jsonp: "callback",
+ jsonpCallback: function() {
+ var callback = oldCallbacks.pop() || ( jQuery.expando + "_" + ( nonce++ ) );
+ this[ callback ] = true;
+ return callback;
+ }
+} );
+
+// Detect, normalize options and install callbacks for jsonp requests
+jQuery.ajaxPrefilter( "json jsonp", function( s, originalSettings, jqXHR ) {
+
+ var callbackName, overwritten, responseContainer,
+ jsonProp = s.jsonp !== false && ( rjsonp.test( s.url ) ?
+ "url" :
+ typeof s.data === "string" &&
+ ( s.contentType || "" )
+ .indexOf( "application/x-www-form-urlencoded" ) === 0 &&
+ rjsonp.test( s.data ) && "data"
+ );
+
+ // Handle iff the expected data type is "jsonp" or we have a parameter to set
+ if ( jsonProp || s.dataTypes[ 0 ] === "jsonp" ) {
+
+ // Get callback name, remembering preexisting value associated with it
+ callbackName = s.jsonpCallback = jQuery.isFunction( s.jsonpCallback ) ?
+ s.jsonpCallback() :
+ s.jsonpCallback;
+
+ // Insert callback into url or form data
+ if ( jsonProp ) {
+ s[ jsonProp ] = s[ jsonProp ].replace( rjsonp, "$1" + callbackName );
+ } else if ( s.jsonp !== false ) {
+ s.url += ( rquery.test( s.url ) ? "&" : "?" ) + s.jsonp + "=" + callbackName;
+ }
+
+ // Use data converter to retrieve json after script execution
+ s.converters[ "script json" ] = function() {
+ if ( !responseContainer ) {
+ jQuery.error( callbackName + " was not called" );
+ }
+ return responseContainer[ 0 ];
+ };
+
+ // Force json dataType
+ s.dataTypes[ 0 ] = "json";
+
+ // Install callback
+ overwritten = window[ callbackName ];
+ window[ callbackName ] = function() {
+ responseContainer = arguments;
+ };
+
+ // Clean-up function (fires after converters)
+ jqXHR.always( function() {
+
+ // If previous value didn't exist - remove it
+ if ( overwritten === undefined ) {
+ jQuery( window ).removeProp( callbackName );
+
+ // Otherwise restore preexisting value
+ } else {
+ window[ callbackName ] = overwritten;
+ }
+
+ // Save back as free
+ if ( s[ callbackName ] ) {
+
+ // Make sure that re-using the options doesn't screw things around
+ s.jsonpCallback = originalSettings.jsonpCallback;
+
+ // Save the callback name for future use
+ oldCallbacks.push( callbackName );
+ }
+
+ // Call if it was a function and we have a response
+ if ( responseContainer && jQuery.isFunction( overwritten ) ) {
+ overwritten( responseContainer[ 0 ] );
+ }
+
+ responseContainer = overwritten = undefined;
+ } );
+
+ // Delegate to script
+ return "script";
+ }
+} );
+
+
+
+
+// Support: Safari 8 only
+// In Safari 8 documents created via document.implementation.createHTMLDocument
+// collapse sibling forms: the second one becomes a child of the first one.
+// Because of that, this security measure has to be disabled in Safari 8.
+// https://bugs.webkit.org/show_bug.cgi?id=137337
+support.createHTMLDocument = ( function() {
+ var body = document.implementation.createHTMLDocument( "" ).body;
+ body.innerHTML = "<form></form><form></form>";
+ return body.childNodes.length === 2;
+} )();
+
+
+// Argument "data" should be string of html
+// context (optional): If specified, the fragment will be created in this context,
+// defaults to document
+// keepScripts (optional): If true, will include scripts passed in the html string
+jQuery.parseHTML = function( data, context, keepScripts ) {
+ if ( typeof data !== "string" ) {
+ return [];
+ }
+ if ( typeof context === "boolean" ) {
+ keepScripts = context;
+ context = false;
+ }
+
+ var base, parsed, scripts;
+
+ if ( !context ) {
+
+ // Stop scripts or inline event handlers from being executed immediately
+ // by using document.implementation
+ if ( support.createHTMLDocument ) {
+ context = document.implementation.createHTMLDocument( "" );
+
+ // Set the base href for the created document
+ // so any parsed elements with URLs
+ // are based on the document's URL (gh-2965)
+ base = context.createElement( "base" );
+ base.href = document.location.href;
+ context.head.appendChild( base );
+ } else {
+ context = document;
+ }
+ }
+
+ parsed = rsingleTag.exec( data );
+ scripts = !keepScripts && [];
+
+ // Single tag
+ if ( parsed ) {
+ return [ context.createElement( parsed[ 1 ] ) ];
+ }
+
+ parsed = buildFragment( [ data ], context, scripts );
+
+ if ( scripts && scripts.length ) {
+ jQuery( scripts ).remove();
+ }
+
+ return jQuery.merge( [], parsed.childNodes );
+};
+
+
+/**
+ * Load a url into a page
+ */
+jQuery.fn.load = function( url, params, callback ) {
+ var selector, type, response,
+ self = this,
+ off = url.indexOf( " " );
+
+ if ( off > -1 ) {
+ selector = stripAndCollapse( url.slice( off ) );
+ url = url.slice( 0, off );
+ }
+
+ // If it's a function
+ if ( jQuery.isFunction( params ) ) {
+
+ // We assume that it's the callback
+ callback = params;
+ params = undefined;
+
+ // Otherwise, build a param string
+ } else if ( params && typeof params === "object" ) {
+ type = "POST";
+ }
+
+ // If we have elements to modify, make the request
+ if ( self.length > 0 ) {
+ jQuery.ajax( {
+ url: url,
+
+ // If "type" variable is undefined, then "GET" method will be used.
+ // Make value of this field explicit since
+ // user can override it through ajaxSetup method
+ type: type || "GET",
+ dataType: "html",
+ data: params
+ } ).done( function( responseText ) {
+
+ // Save response for use in complete callback
+ response = arguments;
+
+ self.html( selector ?
+
+ // If a selector was specified, locate the right elements in a dummy div
+ // Exclude scripts to avoid IE 'Permission Denied' errors
+ jQuery( "<div>" ).append( jQuery.parseHTML( responseText ) ).find( selector ) :
+
+ // Otherwise use the full result
+ responseText );
+
+ // If the request succeeds, this function gets "data", "status", "jqXHR"
+ // but they are ignored because response was set above.
+ // If it fails, this function gets "jqXHR", "status", "error"
+ } ).always( callback && function( jqXHR, status ) {
+ self.each( function() {
+ callback.apply( this, response || [ jqXHR.responseText, status, jqXHR ] );
+ } );
+ } );
+ }
+
+ return this;
+};
+
+
+
+
+// Attach a bunch of functions for handling common AJAX events
+jQuery.each( [
+ "ajaxStart",
+ "ajaxStop",
+ "ajaxComplete",
+ "ajaxError",
+ "ajaxSuccess",
+ "ajaxSend"
+], function( i, type ) {
+ jQuery.fn[ type ] = function( fn ) {
+ return this.on( type, fn );
+ };
+} );
+
+
+
+
+jQuery.expr.pseudos.animated = function( elem ) {
+ return jQuery.grep( jQuery.timers, function( fn ) {
+ return elem === fn.elem;
+ } ).length;
+};
+
+
+
+
+jQuery.offset = {
+ setOffset: function( elem, options, i ) {
+ var curPosition, curLeft, curCSSTop, curTop, curOffset, curCSSLeft, calculatePosition,
+ position = jQuery.css( elem, "position" ),
+ curElem = jQuery( elem ),
+ props = {};
+
+ // Set position first, in-case top/left are set even on static elem
+ if ( position === "static" ) {
+ elem.style.position = "relative";
+ }
+
+ curOffset = curElem.offset();
+ curCSSTop = jQuery.css( elem, "top" );
+ curCSSLeft = jQuery.css( elem, "left" );
+ calculatePosition = ( position === "absolute" || position === "fixed" ) &&
+ ( curCSSTop + curCSSLeft ).indexOf( "auto" ) > -1;
+
+ // Need to be able to calculate position if either
+ // top or left is auto and position is either absolute or fixed
+ if ( calculatePosition ) {
+ curPosition = curElem.position();
+ curTop = curPosition.top;
+ curLeft = curPosition.left;
+
+ } else {
+ curTop = parseFloat( curCSSTop ) || 0;
+ curLeft = parseFloat( curCSSLeft ) || 0;
+ }
+
+ if ( jQuery.isFunction( options ) ) {
+
+ // Use jQuery.extend here to allow modification of coordinates argument (gh-1848)
+ options = options.call( elem, i, jQuery.extend( {}, curOffset ) );
+ }
+
+ if ( options.top != null ) {
+ props.top = ( options.top - curOffset.top ) + curTop;
+ }
+ if ( options.left != null ) {
+ props.left = ( options.left - curOffset.left ) + curLeft;
+ }
+
+ if ( "using" in options ) {
+ options.using.call( elem, props );
+
+ } else {
+ curElem.css( props );
+ }
+ }
+};
+
+jQuery.fn.extend( {
+ offset: function( options ) {
+
+ // Preserve chaining for setter
+ if ( arguments.length ) {
+ return options === undefined ?
+ this :
+ this.each( function( i ) {
+ jQuery.offset.setOffset( this, options, i );
+ } );
+ }
+
+ var doc, docElem, rect, win,
+ elem = this[ 0 ];
+
+ if ( !elem ) {
+ return;
+ }
+
+ // Return zeros for disconnected and hidden (display: none) elements (gh-2310)
+ // Support: IE <=11 only
+ // Running getBoundingClientRect on a
+ // disconnected node in IE throws an error
+ if ( !elem.getClientRects().length ) {
+ return { top: 0, left: 0 };
+ }
+
+ rect = elem.getBoundingClientRect();
+
+ doc = elem.ownerDocument;
+ docElem = doc.documentElement;
+ win = doc.defaultView;
+
+ return {
+ top: rect.top + win.pageYOffset - docElem.clientTop,
+ left: rect.left + win.pageXOffset - docElem.clientLeft
+ };
+ },
+
+ position: function() {
+ if ( !this[ 0 ] ) {
+ return;
+ }
+
+ var offsetParent, offset,
+ elem = this[ 0 ],
+ parentOffset = { top: 0, left: 0 };
+
+ // Fixed elements are offset from window (parentOffset = {top:0, left: 0},
+ // because it is its only offset parent
+ if ( jQuery.css( elem, "position" ) === "fixed" ) {
+
+ // Assume getBoundingClientRect is there when computed position is fixed
+ offset = elem.getBoundingClientRect();
+
+ } else {
+
+ // Get *real* offsetParent
+ offsetParent = this.offsetParent();
+
+ // Get correct offsets
+ offset = this.offset();
+ if ( !nodeName( offsetParent[ 0 ], "html" ) ) {
+ parentOffset = offsetParent.offset();
+ }
+
+ // Add offsetParent borders
+ parentOffset = {
+ top: parentOffset.top + jQuery.css( offsetParent[ 0 ], "borderTopWidth", true ),
+ left: parentOffset.left + jQuery.css( offsetParent[ 0 ], "borderLeftWidth", true )
+ };
+ }
+
+ // Subtract parent offsets and element margins
+ return {
+ top: offset.top - parentOffset.top - jQuery.css( elem, "marginTop", true ),
+ left: offset.left - parentOffset.left - jQuery.css( elem, "marginLeft", true )
+ };
+ },
+
+ // This method will return documentElement in the following cases:
+ // 1) For the element inside the iframe without offsetParent, this method will return
+ // documentElement of the parent window
+ // 2) For the hidden or detached element
+ // 3) For body or html element, i.e. in case of the html node - it will return itself
+ //
+ // but those exceptions were never presented as a real life use-cases
+ // and might be considered as more preferable results.
+ //
+ // This logic, however, is not guaranteed and can change at any point in the future
+ offsetParent: function() {
+ return this.map( function() {
+ var offsetParent = this.offsetParent;
+
+ while ( offsetParent && jQuery.css( offsetParent, "position" ) === "static" ) {
+ offsetParent = offsetParent.offsetParent;
+ }
+
+ return offsetParent || documentElement;
+ } );
+ }
+} );
+
+// Create scrollLeft and scrollTop methods
+jQuery.each( { scrollLeft: "pageXOffset", scrollTop: "pageYOffset" }, function( method, prop ) {
+ var top = "pageYOffset" === prop;
+
+ jQuery.fn[ method ] = function( val ) {
+ return access( this, function( elem, method, val ) {
+
+ // Coalesce documents and windows
+ var win;
+ if ( jQuery.isWindow( elem ) ) {
+ win = elem;
+ } else if ( elem.nodeType === 9 ) {
+ win = elem.defaultView;
+ }
+
+ if ( val === undefined ) {
+ return win ? win[ prop ] : elem[ method ];
+ }
+
+ if ( win ) {
+ win.scrollTo(
+ !top ? val : win.pageXOffset,
+ top ? val : win.pageYOffset
+ );
+
+ } else {
+ elem[ method ] = val;
+ }
+ }, method, val, arguments.length );
+ };
+} );
+
+// Support: Safari <=7 - 9.1, Chrome <=37 - 49
+// Add the top/left cssHooks using jQuery.fn.position
+// Webkit bug: https://bugs.webkit.org/show_bug.cgi?id=29084
+// Blink bug: https://bugs.chromium.org/p/chromium/issues/detail?id=589347
+// getComputedStyle returns percent when specified for top/left/bottom/right;
+// rather than make the css module depend on the offset module, just check for it here
+jQuery.each( [ "top", "left" ], function( i, prop ) {
+ jQuery.cssHooks[ prop ] = addGetHookIf( support.pixelPosition,
+ function( elem, computed ) {
+ if ( computed ) {
+ computed = curCSS( elem, prop );
+
+ // If curCSS returns percentage, fallback to offset
+ return rnumnonpx.test( computed ) ?
+ jQuery( elem ).position()[ prop ] + "px" :
+ computed;
+ }
+ }
+ );
+} );
+
+
+// Create innerHeight, innerWidth, height, width, outerHeight and outerWidth methods
+jQuery.each( { Height: "height", Width: "width" }, function( name, type ) {
+ jQuery.each( { padding: "inner" + name, content: type, "": "outer" + name },
+ function( defaultExtra, funcName ) {
+
+ // Margin is only for outerHeight, outerWidth
+ jQuery.fn[ funcName ] = function( margin, value ) {
+ var chainable = arguments.length && ( defaultExtra || typeof margin !== "boolean" ),
+ extra = defaultExtra || ( margin === true || value === true ? "margin" : "border" );
+
+ return access( this, function( elem, type, value ) {
+ var doc;
+
+ if ( jQuery.isWindow( elem ) ) {
+
+ // $( window ).outerWidth/Height return w/h including scrollbars (gh-1729)
+ return funcName.indexOf( "outer" ) === 0 ?
+ elem[ "inner" + name ] :
+ elem.document.documentElement[ "client" + name ];
+ }
+
+ // Get document width or height
+ if ( elem.nodeType === 9 ) {
+ doc = elem.documentElement;
+
+ // Either scroll[Width/Height] or offset[Width/Height] or client[Width/Height],
+ // whichever is greatest
+ return Math.max(
+ elem.body[ "scroll" + name ], doc[ "scroll" + name ],
+ elem.body[ "offset" + name ], doc[ "offset" + name ],
+ doc[ "client" + name ]
+ );
+ }
+
+ return value === undefined ?
+
+ // Get width or height on the element, requesting but not forcing parseFloat
+ jQuery.css( elem, type, extra ) :
+
+ // Set width or height on the element
+ jQuery.style( elem, type, value, extra );
+ }, type, chainable ? margin : undefined, chainable );
+ };
+ } );
+} );
+
+
+jQuery.fn.extend( {
+
+ bind: function( types, data, fn ) {
+ return this.on( types, null, data, fn );
+ },
+ unbind: function( types, fn ) {
+ return this.off( types, null, fn );
+ },
+
+ delegate: function( selector, types, data, fn ) {
+ return this.on( types, selector, data, fn );
+ },
+ undelegate: function( selector, types, fn ) {
+
+ // ( namespace ) or ( selector, types [, fn] )
+ return arguments.length === 1 ?
+ this.off( selector, "**" ) :
+ this.off( types, selector || "**", fn );
+ }
+} );
+
+jQuery.holdReady = function( hold ) {
+ if ( hold ) {
+ jQuery.readyWait++;
+ } else {
+ jQuery.ready( true );
+ }
+};
+jQuery.isArray = Array.isArray;
+jQuery.parseJSON = JSON.parse;
+jQuery.nodeName = nodeName;
+
+
+
+
+// Register as a named AMD module, since jQuery can be concatenated with other
+// files that may use define, but not via a proper concatenation script that
+// understands anonymous AMD modules. A named AMD is safest and most robust
+// way to register. Lowercase jquery is used because AMD module names are
+// derived from file names, and jQuery is normally delivered in a lowercase
+// file name. Do this after creating the global so that if an AMD module wants
+// to call noConflict to hide this version of jQuery, it will work.
+
+// Note that for maximum portability, libraries that are not jQuery should
+// declare themselves as anonymous modules, and avoid setting a global if an
+// AMD loader is present. jQuery is a special case. For more information, see
+// https://github.com/jrburke/requirejs/wiki/Updating-existing-libraries#wiki-anon
+
+if ( typeof define === "function" && define.amd ) {
+ define( "jquery", [], function() {
+ return jQuery;
+ } );
+}
+
+
+
+
+var
+
+ // Map over jQuery in case of overwrite
+ _jQuery = window.jQuery,
+
+ // Map over the $ in case of overwrite
+ _$ = window.$;
+
+jQuery.noConflict = function( deep ) {
+ if ( window.$ === jQuery ) {
+ window.$ = _$;
+ }
+
+ if ( deep && window.jQuery === jQuery ) {
+ window.jQuery = _jQuery;
+ }
+
+ return jQuery;
+};
+
+// Expose jQuery and $ identifiers, even in AMD
+// (#7102#comment:10, https://github.com/jquery/jquery/pull/557)
+// and CommonJS for browser emulators (#13566)
+if ( !noGlobal ) {
+ window.jQuery = window.$ = jQuery;
+}
+
+
+
+
+return jQuery;
+} );
diff --git a/docs/latest/_static/jquery.js b/docs/latest/_static/jquery.js
index ab28a24..644d35e 100644
--- a/docs/latest/_static/jquery.js
+++ b/docs/latest/_static/jquery.js
@@ -1,4 +1,4 @@
-/*! jQuery v1.11.1 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */
-!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.1",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(o,"ms-").replace(p,q)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=r(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(n,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(r(Object(a))?m.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=r(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),m.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(arguments)))},e.guid=a.guid=a.guid||m.guid++,e):void 0},now:function(){return+new Date},support:k}),m.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function r(a){var b=a.length,c=m.type(a);return"function"===c||m.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var s=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+-new Date,v=a.document,w=0,x=0,y=gb(),z=gb(),A=gb(),B=function(a,b){return a===b&&(l=!0),0},C="undefined",D=1<<31,E={}.hasOwnProperty,F=[],G=F.pop,H=F.push,I=F.push,J=F.slice,K=F.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},L="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",N="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",O=N.replace("w","w#"),P="\\["+M+"*("+N+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+O+"))|)"+M+"*\\]",Q=":("+N+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+P+")*)|.*)\\)|)",R=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),S=new RegExp("^"+M+"*,"+M+"*"),T=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp("="+M+"*([^\\]'\"]*?)"+M+"*\\]","g"),V=new RegExp(Q),W=new RegExp("^"+O+"$"),X={ID:new RegExp("^#("+N+")"),CLASS:new RegExp("^\\.("+N+")"),TAG:new RegExp("^("+N.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+Q),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+L+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/^(?:input|select|textarea|button)$/i,Z=/^h\d$/i,$=/^[^{]+\{\s*\[native \w/,_=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ab=/[+~]/,bb=/'|\\/g,cb=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),db=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{I.apply(F=J.call(v.childNodes),v.childNodes),F[v.childNodes.length].nodeType}catch(eb){I={apply:F.length?function(a,b){H.apply(a,J.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fb(a,b,d,e){var f,h,j,k,l,o,r,s,w,x;if((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,d=d||[],!a||"string"!=typeof a)return d;if(1!==(k=b.nodeType)&&9!==k)return[];if(p&&!e){if(f=_.exec(a))if(j=f[1]){if(9===k){if(h=b.getElementById(j),!h||!h.parentNode)return d;if(h.id===j)return d.push(h),d}else if(b.ownerDocument&&(h=b.ownerDocument.getElementById(j))&&t(b,h)&&h.id===j)return d.push(h),d}else{if(f[2])return I.apply(d,b.getElementsByTagName(a)),d;if((j=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return I.apply(d,b.getElementsByClassName(j)),d}if(c.qsa&&(!q||!q.test(a))){if(s=r=u,w=b,x=9===k&&a,1===k&&"object"!==b.nodeName.toLowerCase()){o=g(a),(r=b.getAttribute("id"))?s=r.replace(bb,"\\$&"):b.setAttribute("id",s),s="[id='"+s+"'] ",l=o.length;while(l--)o[l]=s+qb(o[l]);w=ab.test(a)&&ob(b.parentNode)||b,x=o.join(",")}if(x)try{return I.apply(d,w.querySelectorAll(x)),d}catch(y){}finally{r||b.removeAttribute("id")}}}return i(a.replace(R,"$1"),b,d,e)}function gb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function hb(a){return a[u]=!0,a}function ib(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function jb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function kb(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||D)-(~a.sourceIndex||D);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function lb(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function mb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function nb(a){return hb(function(b){return b=+b,hb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function ob(a){return a&&typeof a.getElementsByTagName!==C&&a}c=fb.support={},f=fb.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fb.setDocument=function(a){var b,e=a?a.ownerDocument||a:v,g=e.defaultView;return e!==n&&9===e.nodeType&&e.documentElement?(n=e,o=e.documentElement,p=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){m()},!1):g.attachEvent&&g.attachEvent("onunload",function(){m()})),c.attributes=ib(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ib(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=$.test(e.getElementsByClassName)&&ib(function(a){return a.innerHTML="<div class='a'></div><div class='a i'></div>",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=ib(function(a){return o.appendChild(a).id=u,!e.getElementsByName||!e.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==C&&p){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){var c=typeof a.getAttributeNode!==C&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==C?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return typeof b.getElementsByClassName!==C&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=$.test(e.querySelectorAll))&&(ib(function(a){a.innerHTML="<select msallowclip=''><option selected=''></option></select>",a.querySelectorAll("[msallowclip^='']").length&&q.push("[*^$]="+M+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+M+"*(?:value|"+L+")"),a.querySelectorAll(":checked").length||q.push(":checked")}),ib(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+M+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=$.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ib(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",Q)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=$.test(o.compareDocumentPosition),t=b||$.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===v&&t(v,a)?-1:b===e||b.ownerDocument===v&&t(v,b)?1:k?K.call(k,a)-K.call(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],i=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:k?K.call(k,a)-K.call(k,b):0;if(f===g)return kb(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)i.unshift(c);while(h[d]===i[d])d++;return d?kb(h[d],i[d]):h[d]===v?-1:i[d]===v?1:0},e):n},fb.matches=function(a,b){return fb(a,null,null,b)},fb.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(U,"='$1']"),!(!c.matchesSelector||!p||r&&r.test(b)||q&&q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fb(b,n,null,[a]).length>0},fb.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fb.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&E.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fb.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fb.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=fb.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fb.selectors={cacheLength:50,createPseudo:hb,match:X,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(cb,db),a[3]=(a[3]||a[4]||a[5]||"").replace(cb,db),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fb.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fb.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return X.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&V.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(cb,db).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+M+")"+a+"("+M+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==C&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fb.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){k=q[u]||(q[u]={}),j=k[a]||[],n=j[0]===w&&j[1],m=j[0]===w&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[w,n,m];break}}else if(s&&(j=(b[u]||(b[u]={}))[a])&&j[0]===w)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(s&&((l[u]||(l[u]={}))[a]=[w,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fb.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?hb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=K.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:hb(function(a){var b=[],c=[],d=h(a.replace(R,"$1"));return d[u]?hb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:hb(function(a){return function(b){return fb(a,b).length>0}}),contains:hb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:hb(function(a){return W.test(a||"")||fb.error("unsupported lang: "+a),a=a.replace(cb,db).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Z.test(a.nodeName)},input:function(a){return Y.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:nb(function(){return[0]}),last:nb(function(a,b){return[b-1]}),eq:nb(function(a,b,c){return[0>c?c+b:c]}),even:nb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:nb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:nb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:nb(function(a,b,c){for(var d=0>c?c+b:c;++d<b;)a.push(d);return a})}},d.pseudos.nth=d.pseudos.eq;for(b in{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})d.pseudos[b]=lb(b);for(b in{submit:!0,reset:!0})d.pseudos[b]=mb(b);function pb(){}pb.prototype=d.filters=d.pseudos,d.setFilters=new pb,g=fb.tokenize=function(a,b){var c,e,f,g,h,i,j,k=z[a+" "];if(k)return b?0:k.slice(0);h=a,i=[],j=d.preFilter;while(h){(!c||(e=S.exec(h)))&&(e&&(h=h.slice(e[0].length)||h),i.push(f=[])),c=!1,(e=T.exec(h))&&(c=e.shift(),f.push({value:c,type:e[0].replace(R," ")}),h=h.slice(c.length));for(g in d.filter)!(e=X[g].exec(h))||j[g]&&!(e=j[g](e))||(c=e.shift(),f.push({value:c,type:g,matches:e}),h=h.slice(c.length));if(!c)break}return b?h.length:h?fb.error(a):z(a,i).slice(0)};function qb(a){for(var b=0,c=a.length,d="";c>b;b++)d+=a[b].value;return d}function rb(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(i=b[u]||(b[u]={}),(h=i[d])&&h[0]===w&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function sb(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function tb(a,b,c){for(var d=0,e=b.length;e>d;d++)fb(a,b[d],c);return c}function ub(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function vb(a,b,c,d,e,f){return d&&!d[u]&&(d=vb(d)),e&&!e[u]&&(e=vb(e,f)),hb(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||tb(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ub(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ub(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?K.call(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ub(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):I.apply(g,r)})}function wb(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=rb(function(a){return a===b},h,!0),l=rb(function(a){return K.call(b,a)>-1},h,!0),m=[function(a,c,d){return!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d))}];f>i;i++)if(c=d.relative[a[i].type])m=[rb(sb(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return vb(i>1&&sb(m),i>1&&qb(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(R,"$1"),c,e>i&&wb(a.slice(i,e)),f>e&&wb(a=a.slice(e)),f>e&&qb(a))}m.push(c)}return sb(m)}function xb(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,m,o,p=0,q="0",r=f&&[],s=[],t=j,u=f||e&&d.find.TAG("*",k),v=w+=null==t?1:Math.random()||.1,x=u.length;for(k&&(j=g!==n&&g);q!==x&&null!=(l=u[q]);q++){if(e&&l){m=0;while(o=a[m++])if(o(l,g,h)){i.push(l);break}k&&(w=v)}c&&((l=!o&&l)&&p--,f&&r.push(l))}if(p+=q,c&&q!==p){m=0;while(o=b[m++])o(r,s,g,h);if(f){if(p>0)while(q--)r[q]||s[q]||(s[q]=G.call(i));s=ub(s)}I.apply(i,s),k&&!f&&s.length>0&&p+b.length>1&&fb.uniqueSort(i)}return k&&(w=v,j=t),r};return c?hb(f):f}return h=fb.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wb(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xb(e,d)),f.selector=a}return f},i=fb.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(cb,db),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=X.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(cb,db),ab.test(j[0].type)&&ob(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qb(j),!a)return I.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,ab.test(a)&&ob(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ib(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ib(function(a){return a.innerHTML="<a href='#'></a>","#"===a.firstChild.getAttribute("href")})||jb("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ib(function(a){return a.innerHTML="<input/>",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||jb("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ib(function(a){return null==a.getAttribute("disabled")})||jb(L,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fb}(a);m.find=s,m.expr=s.selectors,m.expr[":"]=m.expr.pseudos,m.unique=s.uniqueSort,m.text=s.getText,m.isXMLDoc=s.isXML,m.contains=s.contains;var t=m.expr.match.needsContext,u=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,v=/^.[^:#\[\.,]*$/;function w(a,b,c){if(m.isFunction(b))return m.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return m.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(v.test(b))return m.filter(b,a,c);b=m.filter(b,a)}return m.grep(a,function(a){return m.inArray(a,b)>=0!==c})}m.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?m.find.matchesSelector(d,a)?[d]:[]:m.find.matches(a,m.grep(b,function(a){return 1===a.nodeType}))},m.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(m(a).filter(function(){for(b=0;e>b;b++)if(m.contains(d[b],this))return!0}));for(b=0;e>b;b++)m.find(a,d[b],c);return c=this.pushStack(e>1?m.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(w(this,a||[],!1))},not:function(a){return this.pushStack(w(this,a||[],!0))},is:function(a){return!!w(this,"string"==typeof a&&t.test(a)?m(a):a||[],!1).length}});var x,y=a.document,z=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,A=m.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:z.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||x).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof m?b[0]:b,m.merge(this,m.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:y,!0)),u.test(c[1])&&m.isPlainObject(b))for(c in b)m.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}if(d=y.getElementById(c[2]),d&&d.parentNode){if(d.id!==c[2])return x.find(a);this.length=1,this[0]=d}return this.context=y,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):m.isFunction(a)?"undefined"!=typeof x.ready?x.ready(a):a(m):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),m.makeArray(a,this))};A.prototype=m.fn,x=m(y);var B=/^(?:parents|prev(?:Until|All))/,C={children:!0,contents:!0,next:!0,prev:!0};m.extend({dir:function(a,b,c){var d=[],e=a[b];while(e&&9!==e.nodeType&&(void 0===c||1!==e.nodeType||!m(e).is(c)))1===e.nodeType&&d.push(e),e=e[b];return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),m.fn.extend({has:function(a){var b,c=m(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(m.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=t.test(a)||"string"!=typeof a?m(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&m.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?m.unique(f):f)},index:function(a){return a?"string"==typeof a?m.inArray(this[0],m(a)):m.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(m.unique(m.merge(this.get(),m(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function D(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}m.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return m.dir(a,"parentNode")},parentsUntil:function(a,b,c){return m.dir(a,"parentNode",c)},next:function(a){return D(a,"nextSibling")},prev:function(a){return D(a,"previousSibling")},nextAll:function(a){return m.dir(a,"nextSibling")},prevAll:function(a){return m.dir(a,"previousSibling")},nextUntil:function(a,b,c){return m.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return m.dir(a,"previousSibling",c)},siblings:function(a){return m.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return m.sibling(a.firstChild)},contents:function(a){return m.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:m.merge([],a.childNodes)}},function(a,b){m.fn[a]=function(c,d){var e=m.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=m.filter(d,e)),this.length>1&&(C[a]||(e=m.unique(e)),B.test(a)&&(e=e.reverse())),this.pushStack(e)}});var E=/\S+/g,F={};function G(a){var b=F[a]={};return m.each(a.match(E)||[],function(a,c){b[c]=!0}),b}m.Callbacks=function(a){a="string"==typeof a?F[a]||G(a):m.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(c=a.memory&&l,d=!0,f=g||0,g=0,e=h.length,b=!0;h&&e>f;f++)if(h[f].apply(l[0],l[1])===!1&&a.stopOnFalse){c=!1;break}b=!1,h&&(i?i.length&&j(i.shift()):c?h=[]:k.disable())},k={add:function(){if(h){var d=h.length;!function f(b){m.each(b,function(b,c){var d=m.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&f(c)})}(arguments),b?e=h.length:c&&(g=d,j(c))}return this},remove:function(){return h&&m.each(arguments,function(a,c){var d;while((d=m.inArray(c,h,d))>-1)h.splice(d,1),b&&(e>=d&&e--,f>=d&&f--)}),this},has:function(a){return a?m.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],e=0,this},disable:function(){return h=i=c=void 0,this},disabled:function(){return!h},lock:function(){return i=void 0,c||k.disable(),this},locked:function(){return!i},fireWith:function(a,c){return!h||d&&!i||(c=c||[],c=[a,c.slice?c.slice():c],b?i.push(c):j(c)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!d}};return k},m.extend({Deferred:function(a){var b=[["resolve","done",m.Callbacks("once memory"),"resolved"],["reject","fail",m.Callbacks("once memory"),"rejected"],["notify","progress",m.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return m.Deferred(function(c){m.each(b,function(b,f){var g=m.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&m.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?m.extend(a,d):d}},e={};return d.pipe=d.then,m.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&m.isFunction(a.promise)?e:0,g=1===f?a:m.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&m.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var H;m.fn.ready=function(a){return m.ready.promise().done(a),this},m.extend({isReady:!1,readyWait:1,holdReady:function(a){a?m.readyWait++:m.ready(!0)},ready:function(a){if(a===!0?!--m.readyWait:!m.isReady){if(!y.body)return setTimeout(m.ready);m.isReady=!0,a!==!0&&--m.readyWait>0||(H.resolveWith(y,[m]),m.fn.triggerHandler&&(m(y).triggerHandler("ready"),m(y).off("ready")))}}});function I(){y.addEventListener?(y.removeEventListener("DOMContentLoaded",J,!1),a.removeEventListener("load",J,!1)):(y.detachEvent("onreadystatechange",J),a.detachEvent("onload",J))}function J(){(y.addEventListener||"load"===event.type||"complete"===y.readyState)&&(I(),m.ready())}m.ready.promise=function(b){if(!H)if(H=m.Deferred(),"complete"===y.readyState)setTimeout(m.ready);else if(y.addEventListener)y.addEventListener("DOMContentLoaded",J,!1),a.addEventListener("load",J,!1);else{y.attachEvent("onreadystatechange",J),a.attachEvent("onload",J);var c=!1;try{c=null==a.frameElement&&y.documentElement}catch(d){}c&&c.doScroll&&!function e(){if(!m.isReady){try{c.doScroll("left")}catch(a){return setTimeout(e,50)}I(),m.ready()}}()}return H.promise(b)};var K="undefined",L;for(L in m(k))break;k.ownLast="0"!==L,k.inlineBlockNeedsLayout=!1,m(function(){var a,b,c,d;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1",k.inlineBlockNeedsLayout=a=3===b.offsetWidth,a&&(c.style.zoom=1)),c.removeChild(d))}),function(){var a=y.createElement("div");if(null==k.deleteExpando){k.deleteExpando=!0;try{delete a.test}catch(b){k.deleteExpando=!1}}a=null}(),m.acceptData=function(a){var b=m.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b};var M=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,N=/([A-Z])/g;function O(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(N,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:M.test(c)?m.parseJSON(c):c}catch(e){}m.data(a,b,c)}else c=void 0}return c}function P(a){var b;for(b in a)if(("data"!==b||!m.isEmptyObject(a[b]))&&"toJSON"!==b)return!1;return!0}function Q(a,b,d,e){if(m.acceptData(a)){var f,g,h=m.expando,i=a.nodeType,j=i?m.cache:a,k=i?a[h]:a[h]&&h;
-if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||m.guid++:h),j[k]||(j[k]=i?{}:{toJSON:m.noop}),("object"==typeof b||"function"==typeof b)&&(e?j[k]=m.extend(j[k],b):j[k].data=m.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[m.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[m.camelCase(b)])):f=g,f}}function R(a,b,c){if(m.acceptData(a)){var d,e,f=a.nodeType,g=f?m.cache:a,h=f?a[m.expando]:m.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){m.isArray(b)?b=b.concat(m.map(b,m.camelCase)):b in d?b=[b]:(b=m.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!P(d):!m.isEmptyObject(d))return}(c||(delete g[h].data,P(g[h])))&&(f?m.cleanData([a],!0):k.deleteExpando||g!=g.window?delete g[h]:g[h]=null)}}}m.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?m.cache[a[m.expando]]:a[m.expando],!!a&&!P(a)},data:function(a,b,c){return Q(a,b,c)},removeData:function(a,b){return R(a,b)},_data:function(a,b,c){return Q(a,b,c,!0)},_removeData:function(a,b){return R(a,b,!0)}}),m.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=m.data(f),1===f.nodeType&&!m._data(f,"parsedAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=m.camelCase(d.slice(5)),O(f,d,e[d])));m._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){m.data(this,a)}):arguments.length>1?this.each(function(){m.data(this,a,b)}):f?O(f,a,m.data(f,a)):void 0},removeData:function(a){return this.each(function(){m.removeData(this,a)})}}),m.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=m._data(a,b),c&&(!d||m.isArray(c)?d=m._data(a,b,m.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=m.queue(a,b),d=c.length,e=c.shift(),f=m._queueHooks(a,b),g=function(){m.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return m._data(a,c)||m._data(a,c,{empty:m.Callbacks("once memory").add(function(){m._removeData(a,b+"queue"),m._removeData(a,c)})})}}),m.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.length<c?m.queue(this[0],a):void 0===b?this:this.each(function(){var c=m.queue(this,a,b);m._queueHooks(this,a),"fx"===a&&"inprogress"!==c[0]&&m.dequeue(this,a)})},dequeue:function(a){return this.each(function(){m.dequeue(this,a)})},clearQueue:function(a){return this.queue(a||"fx",[])},promise:function(a,b){var c,d=1,e=m.Deferred(),f=this,g=this.length,h=function(){--d||e.resolveWith(f,[f])};"string"!=typeof a&&(b=a,a=void 0),a=a||"fx";while(g--)c=m._data(f[g],a+"queueHooks"),c&&c.empty&&(d++,c.empty.add(h));return h(),e.promise(b)}});var S=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,T=["Top","Right","Bottom","Left"],U=function(a,b){return a=b||a,"none"===m.css(a,"display")||!m.contains(a.ownerDocument,a)},V=m.access=function(a,b,c,d,e,f,g){var h=0,i=a.length,j=null==c;if("object"===m.type(c)){e=!0;for(h in c)m.access(a,b,h,c[h],!0,f,g)}else if(void 0!==d&&(e=!0,m.isFunction(d)||(g=!0),j&&(g?(b.call(a,d),b=null):(j=b,b=function(a,b,c){return j.call(m(a),c)})),b))for(;i>h;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},W=/^(?:checkbox|radio)$/i;!function(){var a=y.createElement("input"),b=y.createElement("div"),c=y.createDocumentFragment();if(b.innerHTML=" <link/><table></table><a href='/a'>a</a><input type='checkbox'/>",k.leadingWhitespace=3===b.firstChild.nodeType,k.tbody=!b.getElementsByTagName("tbody").length,k.htmlSerialize=!!b.getElementsByTagName("link").length,k.html5Clone="<:nav></:nav>"!==y.createElement("nav").cloneNode(!0).outerHTML,a.type="checkbox",a.checked=!0,c.appendChild(a),k.appendChecked=a.checked,b.innerHTML="<textarea>x</textarea>",k.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue,c.appendChild(b),b.innerHTML="<input type='radio' checked='checked' name='t'/>",k.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,k.noCloneEvent=!0,b.attachEvent&&(b.attachEvent("onclick",function(){k.noCloneEvent=!1}),b.cloneNode(!0).click()),null==k.deleteExpando){k.deleteExpando=!0;try{delete b.test}catch(d){k.deleteExpando=!1}}}(),function(){var b,c,d=y.createElement("div");for(b in{submit:!0,change:!0,focusin:!0})c="on"+b,(k[b+"Bubbles"]=c in a)||(d.setAttribute(c,"t"),k[b+"Bubbles"]=d.attributes[c].expando===!1);d=null}();var X=/^(?:input|select|textarea)$/i,Y=/^key/,Z=/^(?:mouse|pointer|contextmenu)|click/,$=/^(?:focusinfocus|focusoutblur)$/,_=/^([^.]*)(?:\.(.+)|)$/;function ab(){return!0}function bb(){return!1}function cb(){try{return y.activeElement}catch(a){}}m.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m._data(a);if(r){c.handler&&(i=c,c=i.handler,e=i.selector),c.guid||(c.guid=m.guid++),(g=r.events)||(g=r.events={}),(k=r.handle)||(k=r.handle=function(a){return typeof m===K||a&&m.event.triggered===a.type?void 0:m.event.dispatch.apply(k.elem,arguments)},k.elem=a),b=(b||"").match(E)||[""],h=b.length;while(h--)f=_.exec(b[h])||[],o=q=f[1],p=(f[2]||"").split(".").sort(),o&&(j=m.event.special[o]||{},o=(e?j.delegateType:j.bindType)||o,j=m.event.special[o]||{},l=m.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&m.expr.match.needsContext.test(e),namespace:p.join(".")},i),(n=g[o])||(n=g[o]=[],n.delegateCount=0,j.setup&&j.setup.call(a,d,p,k)!==!1||(a.addEventListener?a.addEventListener(o,k,!1):a.attachEvent&&a.attachEvent("on"+o,k))),j.add&&(j.add.call(a,l),l.handler.guid||(l.handler.guid=c.guid)),e?n.splice(n.delegateCount++,0,l):n.push(l),m.event.global[o]=!0);a=null}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m.hasData(a)&&m._data(a);if(r&&(k=r.events)){b=(b||"").match(E)||[""],j=b.length;while(j--)if(h=_.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=m.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,n=k[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),i=f=n.length;while(f--)g=n[f],!e&&q!==g.origType||c&&c.guid!==g.guid||h&&!h.test(g.namespace)||d&&d!==g.selector&&("**"!==d||!g.selector)||(n.splice(f,1),g.selector&&n.delegateCount--,l.remove&&l.remove.call(a,g));i&&!n.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||m.removeEvent(a,o,r.handle),delete k[o])}else for(o in k)m.event.remove(a,o+b[j],c,d,!0);m.isEmptyObject(k)&&(delete r.handle,m._removeData(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,l,n,o=[d||y],p=j.call(b,"type")?b.type:b,q=j.call(b,"namespace")?b.namespace.split("."):[];if(h=l=d=d||y,3!==d.nodeType&&8!==d.nodeType&&!$.test(p+m.event.triggered)&&(p.indexOf(".")>=0&&(q=p.split("."),p=q.shift(),q.sort()),g=p.indexOf(":")<0&&"on"+p,b=b[m.expando]?b:new m.Event(p,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=q.join("."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:m.makeArray(c,[b]),k=m.event.special[p]||{},e||!k.trigger||k.trigger.apply(d,c)!==!1)){if(!e&&!k.noBubble&&!m.isWindow(d)){for(i=k.delegateType||p,$.test(i+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),l=h;l===(d.ownerDocument||y)&&o.push(l.defaultView||l.parentWindow||a)}n=0;while((h=o[n++])&&!b.isPropagationStopped())b.type=n>1?i:k.bindType||p,f=(m._data(h,"events")||{})[b.type]&&m._data(h,"handle"),f&&f.apply(h,c),f=g&&h[g],f&&f.apply&&m.acceptData(h)&&(b.result=f.apply(h,c),b.result===!1&&b.preventDefault());if(b.type=p,!e&&!b.isDefaultPrevented()&&(!k._default||k._default.apply(o.pop(),c)===!1)&&m.acceptData(d)&&g&&d[p]&&!m.isWindow(d)){l=d[g],l&&(d[g]=null),m.event.triggered=p;try{d[p]()}catch(r){}m.event.triggered=void 0,l&&(d[g]=l)}return b.result}},dispatch:function(a){a=m.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(m._data(this,"events")||{})[a.type]||[],k=m.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=m.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,g=0;while((e=f.handlers[g++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(e.namespace))&&(a.handleObj=e,a.data=e.data,c=((m.event.special[e.origType]||{}).handle||e.handler).apply(f.elem,i),void 0!==c&&(a.result=c)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!=this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(e=[],f=0;h>f;f++)d=b[f],c=d.selector+" ",void 0===e[c]&&(e[c]=d.needsContext?m(c,this).index(i)>=0:m.find(c,this,null,[i]).length),e[c]&&e.push(d);e.length&&g.push({elem:i,handlers:e})}return h<b.length&&g.push({elem:this,handlers:b.slice(h)}),g},fix:function(a){if(a[m.expando])return a;var b,c,d,e=a.type,f=a,g=this.fixHooks[e];g||(this.fixHooks[e]=g=Z.test(e)?this.mouseHooks:Y.test(e)?this.keyHooks:{}),d=g.props?this.props.concat(g.props):this.props,a=new m.Event(f),b=d.length;while(b--)c=d[b],a[c]=f[c];return a.target||(a.target=f.srcElement||y),3===a.target.nodeType&&(a.target=a.target.parentNode),a.metaKey=!!a.metaKey,g.filter?g.filter(a,f):a},props:"altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "),fixHooks:{},keyHooks:{props:"char charCode key keyCode".split(" "),filter:function(a,b){return null==a.which&&(a.which=null!=b.charCode?b.charCode:b.keyCode),a}},mouseHooks:{props:"button buttons clientX clientY fromElement offsetX offsetY pageX pageY screenX screenY toElement".split(" "),filter:function(a,b){var c,d,e,f=b.button,g=b.fromElement;return null==a.pageX&&null!=b.clientX&&(d=a.target.ownerDocument||y,e=d.documentElement,c=d.body,a.pageX=b.clientX+(e&&e.scrollLeft||c&&c.scrollLeft||0)-(e&&e.clientLeft||c&&c.clientLeft||0),a.pageY=b.clientY+(e&&e.scrollTop||c&&c.scrollTop||0)-(e&&e.clientTop||c&&c.clientTop||0)),!a.relatedTarget&&g&&(a.relatedTarget=g===a.target?b.toElement:g),a.which||void 0===f||(a.which=1&f?1:2&f?3:4&f?2:0),a}},special:{load:{noBubble:!0},focus:{trigger:function(){if(this!==cb()&&this.focus)try{return this.focus(),!1}catch(a){}},delegateType:"focusin"},blur:{trigger:function(){return this===cb()&&this.blur?(this.blur(),!1):void 0},delegateType:"focusout"},click:{trigger:function(){return m.nodeName(this,"input")&&"checkbox"===this.type&&this.click?(this.click(),!1):void 0},_default:function(a){return m.nodeName(a.target,"a")}},beforeunload:{postDispatch:function(a){void 0!==a.result&&a.originalEvent&&(a.originalEvent.returnValue=a.result)}}},simulate:function(a,b,c,d){var e=m.extend(new m.Event,c,{type:a,isSimulated:!0,originalEvent:{}});d?m.event.trigger(e,null,b):m.event.dispatch.call(b,e),e.isDefaultPrevented()&&c.preventDefault()}},m.removeEvent=y.removeEventListener?function(a,b,c){a.removeEventListener&&a.removeEventListener(b,c,!1)}:function(a,b,c){var d="on"+b;a.detachEvent&&(typeof a[d]===K&&(a[d]=null),a.detachEvent(d,c))},m.Event=function(a,b){return this instanceof m.Event?(a&&a.type?(this.originalEvent=a,this.type=a.type,this.isDefaultPrevented=a.defaultPrevented||void 0===a.defaultPrevented&&a.returnValue===!1?ab:bb):this.type=a,b&&m.extend(this,b),this.timeStamp=a&&a.timeStamp||m.now(),void(this[m.expando]=!0)):new m.Event(a,b)},m.Event.prototype={isDefaultPrevented:bb,isPropagationStopped:bb,isImmediatePropagationStopped:bb,preventDefault:function(){var a=this.originalEvent;this.isDefaultPrevented=ab,a&&(a.preventDefault?a.preventDefault():a.returnValue=!1)},stopPropagation:function(){var a=this.originalEvent;this.isPropagationStopped=ab,a&&(a.stopPropagation&&a.stopPropagation(),a.cancelBubble=!0)},stopImmediatePropagation:function(){var a=this.originalEvent;this.isImmediatePropagationStopped=ab,a&&a.stopImmediatePropagation&&a.stopImmediatePropagation(),this.stopPropagation()}},m.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(a,b){m.event.special[a]={delegateType:b,bindType:b,handle:function(a){var c,d=this,e=a.relatedTarget,f=a.handleObj;return(!e||e!==d&&!m.contains(d,e))&&(a.type=f.origType,c=f.handler.apply(this,arguments),a.type=b),c}}}),k.submitBubbles||(m.event.special.submit={setup:function(){return m.nodeName(this,"form")?!1:void m.event.add(this,"click._submit keypress._submit",function(a){var b=a.target,c=m.nodeName(b,"input")||m.nodeName(b,"button")?b.form:void 0;c&&!m._data(c,"submitBubbles")&&(m.event.add(c,"submit._submit",function(a){a._submit_bubble=!0}),m._data(c,"submitBubbles",!0))})},postDispatch:function(a){a._submit_bubble&&(delete a._submit_bubble,this.parentNode&&!a.isTrigger&&m.event.simulate("submit",this.parentNode,a,!0))},teardown:function(){return m.nodeName(this,"form")?!1:void m.event.remove(this,"._submit")}}),k.changeBubbles||(m.event.special.change={setup:function(){return X.test(this.nodeName)?(("checkbox"===this.type||"radio"===this.type)&&(m.event.add(this,"propertychange._change",function(a){"checked"===a.originalEvent.propertyName&&(this._just_changed=!0)}),m.event.add(this,"click._change",function(a){this._just_changed&&!a.isTrigger&&(this._just_changed=!1),m.event.simulate("change",this,a,!0)})),!1):void m.event.add(this,"beforeactivate._change",function(a){var b=a.target;X.test(b.nodeName)&&!m._data(b,"changeBubbles")&&(m.event.add(b,"change._change",function(a){!this.parentNode||a.isSimulated||a.isTrigger||m.event.simulate("change",this.parentNode,a,!0)}),m._data(b,"changeBubbles",!0))})},handle:function(a){var b=a.target;return this!==b||a.isSimulated||a.isTrigger||"radio"!==b.type&&"checkbox"!==b.type?a.handleObj.handler.apply(this,arguments):void 0},teardown:function(){return m.event.remove(this,"._change"),!X.test(this.nodeName)}}),k.focusinBubbles||m.each({focus:"focusin",blur:"focusout"},function(a,b){var c=function(a){m.event.simulate(b,a.target,m.event.fix(a),!0)};m.event.special[b]={setup:function(){var d=this.ownerDocument||this,e=m._data(d,b);e||d.addEventListener(a,c,!0),m._data(d,b,(e||0)+1)},teardown:function(){var d=this.ownerDocument||this,e=m._data(d,b)-1;e?m._data(d,b,e):(d.removeEventListener(a,c,!0),m._removeData(d,b))}}}),m.fn.extend({on:function(a,b,c,d,e){var f,g;if("object"==typeof a){"string"!=typeof b&&(c=c||b,b=void 0);for(f in a)this.on(f,b,c,a[f],e);return this}if(null==c&&null==d?(d=b,c=b=void 0):null==d&&("string"==typeof b?(d=c,c=void 0):(d=c,c=b,b=void 0)),d===!1)d=bb;else if(!d)return this;return 1===e&&(g=d,d=function(a){return m().off(a),g.apply(this,arguments)},d.guid=g.guid||(g.guid=m.guid++)),this.each(function(){m.event.add(this,a,d,c,b)})},one:function(a,b,c,d){return this.on(a,b,c,d,1)},off:function(a,b,c){var d,e;if(a&&a.preventDefault&&a.handleObj)return d=a.handleObj,m(a.delegateTarget).off(d.namespace?d.origType+"."+d.namespace:d.origType,d.selector,d.handler),this;if("object"==typeof a){for(e in a)this.off(e,b,a[e]);return this}return(b===!1||"function"==typeof b)&&(c=b,b=void 0),c===!1&&(c=bb),this.each(function(){m.event.remove(this,a,c,b)})},trigger:function(a,b){return this.each(function(){m.event.trigger(a,b,this)})},triggerHandler:function(a,b){var c=this[0];return c?m.event.trigger(a,b,c,!0):void 0}});function db(a){var b=eb.split("|"),c=a.createDocumentFragment();if(c.createElement)while(b.length)c.createElement(b.pop());return c}var eb="abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",fb=/ jQuery\d+="(?:null|\d+)"/g,gb=new RegExp("<(?:"+eb+")[\\s/>]","i"),hb=/^\s+/,ib=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,jb=/<([\w:]+)/,kb=/<tbody/i,lb=/<|&#?\w+;/,mb=/<(?:script|style|link)/i,nb=/checked\s*(?:[^=]|=\s*.checked.)/i,ob=/^$|\/(?:java|ecma)script/i,pb=/^true\/(.*)/,qb=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g,rb={option:[1,"<select multiple='multiple'>","</select>"],legend:[1,"<fieldset>","</fieldset>"],area:[1,"<map>","</map>"],param:[1,"<object>","</object>"],thead:[1,"<table>","</table>"],tr:[2,"<table><tbody>","</tbody></table>"],col:[2,"<table><tbody></tbody><colgroup>","</colgroup></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:k.htmlSerialize?[0,"",""]:[1,"X<div>","</div>"]},sb=db(y),tb=sb.appendChild(y.createElement("div"));rb.optgroup=rb.option,rb.tbody=rb.tfoot=rb.colgroup=rb.caption=rb.thead,rb.th=rb.td;function ub(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==K?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==K?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||m.nodeName(d,b)?f.push(d):m.merge(f,ub(d,b));return void 0===b||b&&m.nodeName(a,b)?m.merge([a],f):f}function vb(a){W.test(a.type)&&(a.defaultChecked=a.checked)}function wb(a,b){return m.nodeName(a,"table")&&m.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function xb(a){return a.type=(null!==m.find.attr(a,"type"))+"/"+a.type,a}function yb(a){var b=pb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function zb(a,b){for(var c,d=0;null!=(c=a[d]);d++)m._data(c,"globalEval",!b||m._data(b[d],"globalEval"))}function Ab(a,b){if(1===b.nodeType&&m.hasData(a)){var c,d,e,f=m._data(a),g=m._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)m.event.add(b,c,h[c][d])}g.data&&(g.data=m.extend({},g.data))}}function Bb(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!k.noCloneEvent&&b[m.expando]){e=m._data(b);for(d in e.events)m.removeEvent(b,d,e.handle);b.removeAttribute(m.expando)}"script"===c&&b.text!==a.text?(xb(b).text=a.text,yb(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),k.html5Clone&&a.innerHTML&&!m.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&W.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}m.extend({clone:function(a,b,c){var d,e,f,g,h,i=m.contains(a.ownerDocument,a);if(k.html5Clone||m.isXMLDoc(a)||!gb.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(tb.innerHTML=a.outerHTML,tb.removeChild(f=tb.firstChild)),!(k.noCloneEvent&&k.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||m.isXMLDoc(a)))for(d=ub(f),h=ub(a),g=0;null!=(e=h[g]);++g)d[g]&&Bb(e,d[g]);if(b)if(c)for(h=h||ub(a),d=d||ub(f),g=0;null!=(e=h[g]);g++)Ab(e,d[g]);else Ab(a,f);return d=ub(f,"script"),d.length>0&&zb(d,!i&&ub(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,l,n=a.length,o=db(b),p=[],q=0;n>q;q++)if(f=a[q],f||0===f)if("object"===m.type(f))m.merge(p,f.nodeType?[f]:f);else if(lb.test(f)){h=h||o.appendChild(b.createElement("div")),i=(jb.exec(f)||["",""])[1].toLowerCase(),l=rb[i]||rb._default,h.innerHTML=l[1]+f.replace(ib,"<$1></$2>")+l[2],e=l[0];while(e--)h=h.lastChild;if(!k.leadingWhitespace&&hb.test(f)&&p.push(b.createTextNode(hb.exec(f)[0])),!k.tbody){f="table"!==i||kb.test(f)?"<table>"!==l[1]||kb.test(f)?0:h:h.firstChild,e=f&&f.childNodes.length;while(e--)m.nodeName(j=f.childNodes[e],"tbody")&&!j.childNodes.length&&f.removeChild(j)}m.merge(p,h.childNodes),h.textContent="";while(h.firstChild)h.removeChild(h.firstChild);h=o.lastChild}else p.push(b.createTextNode(f));h&&o.removeChild(h),k.appendChecked||m.grep(ub(p,"input"),vb),q=0;while(f=p[q++])if((!d||-1===m.inArray(f,d))&&(g=m.contains(f.ownerDocument,f),h=ub(o.appendChild(f),"script"),g&&zb(h),c)){e=0;while(f=h[e++])ob.test(f.type||"")&&c.push(f)}return h=null,o},cleanData:function(a,b){for(var d,e,f,g,h=0,i=m.expando,j=m.cache,l=k.deleteExpando,n=m.event.special;null!=(d=a[h]);h++)if((b||m.acceptData(d))&&(f=d[i],g=f&&j[f])){if(g.events)for(e in g.events)n[e]?m.event.remove(d,e):m.removeEvent(d,e,g.handle);j[f]&&(delete j[f],l?delete d[i]:typeof d.removeAttribute!==K?d.removeAttribute(i):d[i]=null,c.push(f))}}}),m.fn.extend({text:function(a){return V(this,function(a){return void 0===a?m.text(this):this.empty().append((this[0]&&this[0].ownerDocument||y).createTextNode(a))},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?m.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||m.cleanData(ub(c)),c.parentNode&&(b&&m.contains(c.ownerDocument,c)&&zb(ub(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++){1===a.nodeType&&m.cleanData(ub(a,!1));while(a.firstChild)a.removeChild(a.firstChild);a.options&&m.nodeName(a,"select")&&(a.options.length=0)}return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return m.clone(this,a,b)})},html:function(a){return V(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a)return 1===b.nodeType?b.innerHTML.replace(fb,""):void 0;if(!("string"!=typeof a||mb.test(a)||!k.htmlSerialize&&gb.test(a)||!k.leadingWhitespace&&hb.test(a)||rb[(jb.exec(a)||["",""])[1].toLowerCase()])){a=a.replace(ib,"<$1></$2>");try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(m.cleanData(ub(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,m.cleanData(ub(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,l=this.length,n=this,o=l-1,p=a[0],q=m.isFunction(p);if(q||l>1&&"string"==typeof p&&!k.checkClone&&nb.test(p))return this.each(function(c){var d=n.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(l&&(i=m.buildFragment(a,this[0].ownerDocument,!1,this),c=i.firstChild,1===i.childNodes.length&&(i=c),c)){for(g=m.map(ub(i,"script"),xb),f=g.length;l>j;j++)d=i,j!==o&&(d=m.clone(d,!0,!0),f&&m.merge(g,ub(d,"script"))),b.call(this[j],d,j);if(f)for(h=g[g.length-1].ownerDocument,m.map(g,yb),j=0;f>j;j++)d=g[j],ob.test(d.type||"")&&!m._data(d,"globalEval")&&m.contains(h,d)&&(d.src?m._evalUrl&&m._evalUrl(d.src):m.globalEval((d.text||d.textContent||d.innerHTML||"").replace(qb,"")));i=c=null}return this}}),m.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){m.fn[a]=function(a){for(var c,d=0,e=[],g=m(a),h=g.length-1;h>=d;d++)c=d===h?this:this.clone(!0),m(g[d])[b](c),f.apply(e,c.get());return this.pushStack(e)}});var Cb,Db={};function Eb(b,c){var d,e=m(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:m.css(e[0],"display");return e.detach(),f}function Fb(a){var b=y,c=Db[a];return c||(c=Eb(a,b),"none"!==c&&c||(Cb=(Cb||m("<iframe frameborder='0' width='0' height='0'/>")).appendTo(b.documentElement),b=(Cb[0].contentWindow||Cb[0].contentDocument).document,b.write(),b.close(),c=Eb(a,b),Cb.detach()),Db[a]=c),c}!function(){var a;k.shrinkWrapBlocks=function(){if(null!=a)return a;a=!1;var b,c,d;return c=y.getElementsByTagName("body")[0],c&&c.style?(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;display:block;margin:0;border:0;padding:1px;width:1px;zoom:1",b.appendChild(y.createElement("div")).style.width="5px",a=3!==b.offsetWidth),c.removeChild(d),a):void 0}}();var Gb=/^margin/,Hb=new RegExp("^("+S+")(?!px)[a-z%]+$","i"),Ib,Jb,Kb=/^(top|right|bottom|left)$/;a.getComputedStyle?(Ib=function(a){return a.ownerDocument.defaultView.getComputedStyle(a,null)},Jb=function(a,b,c){var d,e,f,g,h=a.style;return c=c||Ib(a),g=c?c.getPropertyValue(b)||c[b]:void 0,c&&(""!==g||m.contains(a.ownerDocument,a)||(g=m.style(a,b)),Hb.test(g)&&Gb.test(b)&&(d=h.width,e=h.minWidth,f=h.maxWidth,h.minWidth=h.maxWidth=h.width=g,g=c.width,h.width=d,h.minWidth=e,h.maxWidth=f)),void 0===g?g:g+""}):y.documentElement.currentStyle&&(Ib=function(a){return a.currentStyle},Jb=function(a,b,c){var d,e,f,g,h=a.style;return c=c||Ib(a),g=c?c[b]:void 0,null==g&&h&&h[b]&&(g=h[b]),Hb.test(g)&&!Kb.test(b)&&(d=h.left,e=a.runtimeStyle,f=e&&e.left,f&&(e.left=a.currentStyle.left),h.left="fontSize"===b?"1em":g,g=h.pixelLeft+"px",h.left=d,f&&(e.left=f)),void 0===g?g:g+""||"auto"});function Lb(a,b){return{get:function(){var c=a();if(null!=c)return c?void delete this.get:(this.get=b).apply(this,arguments)}}}!function(){var b,c,d,e,f,g,h;if(b=y.createElement("div"),b.innerHTML=" <link/><table></table><a href='/a'>a</a><input type='checkbox'/>",d=b.getElementsByTagName("a")[0],c=d&&d.style){c.cssText="float:left;opacity:.5",k.opacity="0.5"===c.opacity,k.cssFloat=!!c.cssFloat,b.style.backgroundClip="content-box",b.cloneNode(!0).style.backgroundClip="",k.clearCloneStyle="content-box"===b.style.backgroundClip,k.boxSizing=""===c.boxSizing||""===c.MozBoxSizing||""===c.WebkitBoxSizing,m.extend(k,{reliableHiddenOffsets:function(){return null==g&&i(),g},boxSizingReliable:function(){return null==f&&i(),f},pixelPosition:function(){return null==e&&i(),e},reliableMarginRight:function(){return null==h&&i(),h}});function i(){var b,c,d,i;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),b.style.cssText="-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;display:block;margin-top:1%;top:1%;border:1px;padding:1px;width:4px;position:absolute",e=f=!1,h=!0,a.getComputedStyle&&(e="1%"!==(a.getComputedStyle(b,null)||{}).top,f="4px"===(a.getComputedStyle(b,null)||{width:"4px"}).width,i=b.appendChild(y.createElement("div")),i.style.cssText=b.style.cssText="-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;display:block;margin:0;border:0;padding:0",i.style.marginRight=i.style.width="0",b.style.width="1px",h=!parseFloat((a.getComputedStyle(i,null)||{}).marginRight)),b.innerHTML="<table><tr><td></td><td>t</td></tr></table>",i=b.getElementsByTagName("td"),i[0].style.cssText="margin:0;border:0;padding:0;display:none",g=0===i[0].offsetHeight,g&&(i[0].style.display="",i[1].style.display="none",g=0===i[0].offsetHeight),c.removeChild(d))}}}(),m.swap=function(a,b,c,d){var e,f,g={};for(f in b)g[f]=a.style[f],a.style[f]=b[f];e=c.apply(a,d||[]);for(f in b)a.style[f]=g[f];return e};var Mb=/alpha\([^)]*\)/i,Nb=/opacity\s*=\s*([^)]*)/,Ob=/^(none|table(?!-c[ea]).+)/,Pb=new RegExp("^("+S+")(.*)$","i"),Qb=new RegExp("^([+-])=("+S+")","i"),Rb={position:"absolute",visibility:"hidden",display:"block"},Sb={letterSpacing:"0",fontWeight:"400"},Tb=["Webkit","O","Moz","ms"];function Ub(a,b){if(b in a)return b;var c=b.charAt(0).toUpperCase()+b.slice(1),d=b,e=Tb.length;while(e--)if(b=Tb[e]+c,b in a)return b;return d}function Vb(a,b){for(var c,d,e,f=[],g=0,h=a.length;h>g;g++)d=a[g],d.style&&(f[g]=m._data(d,"olddisplay"),c=d.style.display,b?(f[g]||"none"!==c||(d.style.display=""),""===d.style.display&&U(d)&&(f[g]=m._data(d,"olddisplay",Fb(d.nodeName)))):(e=U(d),(c&&"none"!==c||!e)&&m._data(d,"olddisplay",e?c:m.css(d,"display"))));for(g=0;h>g;g++)d=a[g],d.style&&(b&&"none"!==d.style.display&&""!==d.style.display||(d.style.display=b?f[g]||"":"none"));return a}function Wb(a,b,c){var d=Pb.exec(b);return d?Math.max(0,d[1]-(c||0))+(d[2]||"px"):b}function Xb(a,b,c,d,e){for(var f=c===(d?"border":"content")?4:"width"===b?1:0,g=0;4>f;f+=2)"margin"===c&&(g+=m.css(a,c+T[f],!0,e)),d?("content"===c&&(g-=m.css(a,"padding"+T[f],!0,e)),"margin"!==c&&(g-=m.css(a,"border"+T[f]+"Width",!0,e))):(g+=m.css(a,"padding"+T[f],!0,e),"padding"!==c&&(g+=m.css(a,"border"+T[f]+"Width",!0,e)));return g}function Yb(a,b,c){var d=!0,e="width"===b?a.offsetWidth:a.offsetHeight,f=Ib(a),g=k.boxSizing&&"border-box"===m.css(a,"boxSizing",!1,f);if(0>=e||null==e){if(e=Jb(a,b,f),(0>e||null==e)&&(e=a.style[b]),Hb.test(e))return e;d=g&&(k.boxSizingReliable()||e===a.style[b]),e=parseFloat(e)||0}return e+Xb(a,b,c||(g?"border":"content"),d,f)+"px"}m.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=Jb(a,"opacity");return""===c?"1":c}}}},cssNumber:{columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":k.cssFloat?"cssFloat":"styleFloat"},style:function(a,b,c,d){if(a&&3!==a.nodeType&&8!==a.nodeType&&a.style){var e,f,g,h=m.camelCase(b),i=a.style;if(b=m.cssProps[h]||(m.cssProps[h]=Ub(i,h)),g=m.cssHooks[b]||m.cssHooks[h],void 0===c)return g&&"get"in g&&void 0!==(e=g.get(a,!1,d))?e:i[b];if(f=typeof c,"string"===f&&(e=Qb.exec(c))&&(c=(e[1]+1)*e[2]+parseFloat(m.css(a,b)),f="number"),null!=c&&c===c&&("number"!==f||m.cssNumber[h]||(c+="px"),k.clearCloneStyle||""!==c||0!==b.indexOf("background")||(i[b]="inherit"),!(g&&"set"in g&&void 0===(c=g.set(a,c,d)))))try{i[b]=c}catch(j){}}},css:function(a,b,c,d){var e,f,g,h=m.camelCase(b);return b=m.cssProps[h]||(m.cssProps[h]=Ub(a.style,h)),g=m.cssHooks[b]||m.cssHooks[h],g&&"get"in g&&(f=g.get(a,!0,c)),void 0===f&&(f=Jb(a,b,d)),"normal"===f&&b in Sb&&(f=Sb[b]),""===c||c?(e=parseFloat(f),c===!0||m.isNumeric(e)?e||0:f):f}}),m.each(["height","width"],function(a,b){m.cssHooks[b]={get:function(a,c,d){return c?Ob.test(m.css(a,"display"))&&0===a.offsetWidth?m.swap(a,Rb,function(){return Yb(a,b,d)}):Yb(a,b,d):void 0},set:function(a,c,d){var e=d&&Ib(a);return Wb(a,c,d?Xb(a,b,d,k.boxSizing&&"border-box"===m.css(a,"boxSizing",!1,e),e):0)}}}),k.opacity||(m.cssHooks.opacity={get:function(a,b){return Nb.test((b&&a.currentStyle?a.currentStyle.filter:a.style.filter)||"")?.01*parseFloat(RegExp.$1)+"":b?"1":""},set:function(a,b){var c=a.style,d=a.currentStyle,e=m.isNumeric(b)?"alpha(opacity="+100*b+")":"",f=d&&d.filter||c.filter||"";c.zoom=1,(b>=1||""===b)&&""===m.trim(f.replace(Mb,""))&&c.removeAttribute&&(c.removeAttribute("filter"),""===b||d&&!d.filter)||(c.filter=Mb.test(f)?f.replace(Mb,e):f+" "+e)}}),m.cssHooks.marginRight=Lb(k.reliableMarginRight,function(a,b){return b?m.swap(a,{display:"inline-block"},Jb,[a,"marginRight"]):void 0}),m.each({margin:"",padding:"",border:"Width"},function(a,b){m.cssHooks[a+b]={expand:function(c){for(var d=0,e={},f="string"==typeof c?c.split(" "):[c];4>d;d++)e[a+T[d]+b]=f[d]||f[d-2]||f[0];return e}},Gb.test(a)||(m.cssHooks[a+b].set=Wb)}),m.fn.extend({css:function(a,b){return V(this,function(a,b,c){var d,e,f={},g=0;if(m.isArray(b)){for(d=Ib(a),e=b.length;e>g;g++)f[b[g]]=m.css(a,b[g],!1,d);return f}return void 0!==c?m.style(a,b,c):m.css(a,b)},a,b,arguments.length>1)},show:function(){return Vb(this,!0)},hide:function(){return Vb(this)},toggle:function(a){return"boolean"==typeof a?a?this.show():this.hide():this.each(function(){U(this)?m(this).show():m(this).hide()})}});function Zb(a,b,c,d,e){return new Zb.prototype.init(a,b,c,d,e)}m.Tween=Zb,Zb.prototype={constructor:Zb,init:function(a,b,c,d,e,f){this.elem=a,this.prop=c,this.easing=e||"swing",this.options=b,this.start=this.now=this.cur(),this.end=d,this.unit=f||(m.cssNumber[c]?"":"px")
-},cur:function(){var a=Zb.propHooks[this.prop];return a&&a.get?a.get(this):Zb.propHooks._default.get(this)},run:function(a){var b,c=Zb.propHooks[this.prop];return this.pos=b=this.options.duration?m.easing[this.easing](a,this.options.duration*a,0,1,this.options.duration):a,this.now=(this.end-this.start)*b+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),c&&c.set?c.set(this):Zb.propHooks._default.set(this),this}},Zb.prototype.init.prototype=Zb.prototype,Zb.propHooks={_default:{get:function(a){var b;return null==a.elem[a.prop]||a.elem.style&&null!=a.elem.style[a.prop]?(b=m.css(a.elem,a.prop,""),b&&"auto"!==b?b:0):a.elem[a.prop]},set:function(a){m.fx.step[a.prop]?m.fx.step[a.prop](a):a.elem.style&&(null!=a.elem.style[m.cssProps[a.prop]]||m.cssHooks[a.prop])?m.style(a.elem,a.prop,a.now+a.unit):a.elem[a.prop]=a.now}}},Zb.propHooks.scrollTop=Zb.propHooks.scrollLeft={set:function(a){a.elem.nodeType&&a.elem.parentNode&&(a.elem[a.prop]=a.now)}},m.easing={linear:function(a){return a},swing:function(a){return.5-Math.cos(a*Math.PI)/2}},m.fx=Zb.prototype.init,m.fx.step={};var $b,_b,ac=/^(?:toggle|show|hide)$/,bc=new RegExp("^(?:([+-])=|)("+S+")([a-z%]*)$","i"),cc=/queueHooks$/,dc=[ic],ec={"*":[function(a,b){var c=this.createTween(a,b),d=c.cur(),e=bc.exec(b),f=e&&e[3]||(m.cssNumber[a]?"":"px"),g=(m.cssNumber[a]||"px"!==f&&+d)&&bc.exec(m.css(c.elem,a)),h=1,i=20;if(g&&g[3]!==f){f=f||g[3],e=e||[],g=+d||1;do h=h||".5",g/=h,m.style(c.elem,a,g+f);while(h!==(h=c.cur()/d)&&1!==h&&--i)}return e&&(g=c.start=+g||+d||0,c.unit=f,c.end=e[1]?g+(e[1]+1)*e[2]:+e[2]),c}]};function fc(){return setTimeout(function(){$b=void 0}),$b=m.now()}function gc(a,b){var c,d={height:a},e=0;for(b=b?1:0;4>e;e+=2-b)c=T[e],d["margin"+c]=d["padding"+c]=a;return b&&(d.opacity=d.width=a),d}function hc(a,b,c){for(var d,e=(ec[b]||[]).concat(ec["*"]),f=0,g=e.length;g>f;f++)if(d=e[f].call(c,b,a))return d}function ic(a,b,c){var d,e,f,g,h,i,j,l,n=this,o={},p=a.style,q=a.nodeType&&U(a),r=m._data(a,"fxshow");c.queue||(h=m._queueHooks(a,"fx"),null==h.unqueued&&(h.unqueued=0,i=h.empty.fire,h.empty.fire=function(){h.unqueued||i()}),h.unqueued++,n.always(function(){n.always(function(){h.unqueued--,m.queue(a,"fx").length||h.empty.fire()})})),1===a.nodeType&&("height"in b||"width"in b)&&(c.overflow=[p.overflow,p.overflowX,p.overflowY],j=m.css(a,"display"),l="none"===j?m._data(a,"olddisplay")||Fb(a.nodeName):j,"inline"===l&&"none"===m.css(a,"float")&&(k.inlineBlockNeedsLayout&&"inline"!==Fb(a.nodeName)?p.zoom=1:p.display="inline-block")),c.overflow&&(p.overflow="hidden",k.shrinkWrapBlocks()||n.always(function(){p.overflow=c.overflow[0],p.overflowX=c.overflow[1],p.overflowY=c.overflow[2]}));for(d in b)if(e=b[d],ac.exec(e)){if(delete b[d],f=f||"toggle"===e,e===(q?"hide":"show")){if("show"!==e||!r||void 0===r[d])continue;q=!0}o[d]=r&&r[d]||m.style(a,d)}else j=void 0;if(m.isEmptyObject(o))"inline"===("none"===j?Fb(a.nodeName):j)&&(p.display=j);else{r?"hidden"in r&&(q=r.hidden):r=m._data(a,"fxshow",{}),f&&(r.hidden=!q),q?m(a).show():n.done(function(){m(a).hide()}),n.done(function(){var b;m._removeData(a,"fxshow");for(b in o)m.style(a,b,o[b])});for(d in o)g=hc(q?r[d]:0,d,n),d in r||(r[d]=g.start,q&&(g.end=g.start,g.start="width"===d||"height"===d?1:0))}}function jc(a,b){var c,d,e,f,g;for(c in a)if(d=m.camelCase(c),e=b[d],f=a[c],m.isArray(f)&&(e=f[1],f=a[c]=f[0]),c!==d&&(a[d]=f,delete a[c]),g=m.cssHooks[d],g&&"expand"in g){f=g.expand(f),delete a[d];for(c in f)c in a||(a[c]=f[c],b[c]=e)}else b[d]=e}function kc(a,b,c){var d,e,f=0,g=dc.length,h=m.Deferred().always(function(){delete i.elem}),i=function(){if(e)return!1;for(var b=$b||fc(),c=Math.max(0,j.startTime+j.duration-b),d=c/j.duration||0,f=1-d,g=0,i=j.tweens.length;i>g;g++)j.tweens[g].run(f);return h.notifyWith(a,[j,f,c]),1>f&&i?c:(h.resolveWith(a,[j]),!1)},j=h.promise({elem:a,props:m.extend({},b),opts:m.extend(!0,{specialEasing:{}},c),originalProperties:b,originalOptions:c,startTime:$b||fc(),duration:c.duration,tweens:[],createTween:function(b,c){var d=m.Tween(a,j.opts,b,c,j.opts.specialEasing[b]||j.opts.easing);return j.tweens.push(d),d},stop:function(b){var c=0,d=b?j.tweens.length:0;if(e)return this;for(e=!0;d>c;c++)j.tweens[c].run(1);return b?h.resolveWith(a,[j,b]):h.rejectWith(a,[j,b]),this}}),k=j.props;for(jc(k,j.opts.specialEasing);g>f;f++)if(d=dc[f].call(j,a,k,j.opts))return d;return m.map(k,hc,j),m.isFunction(j.opts.start)&&j.opts.start.call(a,j),m.fx.timer(m.extend(i,{elem:a,anim:j,queue:j.opts.queue})),j.progress(j.opts.progress).done(j.opts.done,j.opts.complete).fail(j.opts.fail).always(j.opts.always)}m.Animation=m.extend(kc,{tweener:function(a,b){m.isFunction(a)?(b=a,a=["*"]):a=a.split(" ");for(var c,d=0,e=a.length;e>d;d++)c=a[d],ec[c]=ec[c]||[],ec[c].unshift(b)},prefilter:function(a,b){b?dc.unshift(a):dc.push(a)}}),m.speed=function(a,b,c){var d=a&&"object"==typeof a?m.extend({},a):{complete:c||!c&&b||m.isFunction(a)&&a,duration:a,easing:c&&b||b&&!m.isFunction(b)&&b};return d.duration=m.fx.off?0:"number"==typeof d.duration?d.duration:d.duration in m.fx.speeds?m.fx.speeds[d.duration]:m.fx.speeds._default,(null==d.queue||d.queue===!0)&&(d.queue="fx"),d.old=d.complete,d.complete=function(){m.isFunction(d.old)&&d.old.call(this),d.queue&&m.dequeue(this,d.queue)},d},m.fn.extend({fadeTo:function(a,b,c,d){return this.filter(U).css("opacity",0).show().end().animate({opacity:b},a,c,d)},animate:function(a,b,c,d){var e=m.isEmptyObject(a),f=m.speed(b,c,d),g=function(){var b=kc(this,m.extend({},a),f);(e||m._data(this,"finish"))&&b.stop(!0)};return g.finish=g,e||f.queue===!1?this.each(g):this.queue(f.queue,g)},stop:function(a,b,c){var d=function(a){var b=a.stop;delete a.stop,b(c)};return"string"!=typeof a&&(c=b,b=a,a=void 0),b&&a!==!1&&this.queue(a||"fx",[]),this.each(function(){var b=!0,e=null!=a&&a+"queueHooks",f=m.timers,g=m._data(this);if(e)g[e]&&g[e].stop&&d(g[e]);else for(e in g)g[e]&&g[e].stop&&cc.test(e)&&d(g[e]);for(e=f.length;e--;)f[e].elem!==this||null!=a&&f[e].queue!==a||(f[e].anim.stop(c),b=!1,f.splice(e,1));(b||!c)&&m.dequeue(this,a)})},finish:function(a){return a!==!1&&(a=a||"fx"),this.each(function(){var b,c=m._data(this),d=c[a+"queue"],e=c[a+"queueHooks"],f=m.timers,g=d?d.length:0;for(c.finish=!0,m.queue(this,a,[]),e&&e.stop&&e.stop.call(this,!0),b=f.length;b--;)f[b].elem===this&&f[b].queue===a&&(f[b].anim.stop(!0),f.splice(b,1));for(b=0;g>b;b++)d[b]&&d[b].finish&&d[b].finish.call(this);delete c.finish})}}),m.each(["toggle","show","hide"],function(a,b){var c=m.fn[b];m.fn[b]=function(a,d,e){return null==a||"boolean"==typeof a?c.apply(this,arguments):this.animate(gc(b,!0),a,d,e)}}),m.each({slideDown:gc("show"),slideUp:gc("hide"),slideToggle:gc("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){m.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),m.timers=[],m.fx.tick=function(){var a,b=m.timers,c=0;for($b=m.now();c<b.length;c++)a=b[c],a()||b[c]!==a||b.splice(c--,1);b.length||m.fx.stop(),$b=void 0},m.fx.timer=function(a){m.timers.push(a),a()?m.fx.start():m.timers.pop()},m.fx.interval=13,m.fx.start=function(){_b||(_b=setInterval(m.fx.tick,m.fx.interval))},m.fx.stop=function(){clearInterval(_b),_b=null},m.fx.speeds={slow:600,fast:200,_default:400},m.fn.delay=function(a,b){return a=m.fx?m.fx.speeds[a]||a:a,b=b||"fx",this.queue(b,function(b,c){var d=setTimeout(b,a);c.stop=function(){clearTimeout(d)}})},function(){var a,b,c,d,e;b=y.createElement("div"),b.setAttribute("className","t"),b.innerHTML=" <link/><table></table><a href='/a'>a</a><input type='checkbox'/>",d=b.getElementsByTagName("a")[0],c=y.createElement("select"),e=c.appendChild(y.createElement("option")),a=b.getElementsByTagName("input")[0],d.style.cssText="top:1px",k.getSetAttribute="t"!==b.className,k.style=/top/.test(d.getAttribute("style")),k.hrefNormalized="/a"===d.getAttribute("href"),k.checkOn=!!a.value,k.optSelected=e.selected,k.enctype=!!y.createElement("form").enctype,c.disabled=!0,k.optDisabled=!e.disabled,a=y.createElement("input"),a.setAttribute("value",""),k.input=""===a.getAttribute("value"),a.value="t",a.setAttribute("type","radio"),k.radioValue="t"===a.value}();var lc=/\r/g;m.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=m.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,m(this).val()):a,null==e?e="":"number"==typeof e?e+="":m.isArray(e)&&(e=m.map(e,function(a){return null==a?"":a+""})),b=m.valHooks[this.type]||m.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=m.valHooks[e.type]||m.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(lc,""):null==c?"":c)}}}),m.extend({valHooks:{option:{get:function(a){var b=m.find.attr(a,"value");return null!=b?b:m.trim(m.text(a))}},select:{get:function(a){for(var b,c,d=a.options,e=a.selectedIndex,f="select-one"===a.type||0>e,g=f?null:[],h=f?e+1:d.length,i=0>e?h:f?e:0;h>i;i++)if(c=d[i],!(!c.selected&&i!==e||(k.optDisabled?c.disabled:null!==c.getAttribute("disabled"))||c.parentNode.disabled&&m.nodeName(c.parentNode,"optgroup"))){if(b=m(c).val(),f)return b;g.push(b)}return g},set:function(a,b){var c,d,e=a.options,f=m.makeArray(b),g=e.length;while(g--)if(d=e[g],m.inArray(m.valHooks.option.get(d),f)>=0)try{d.selected=c=!0}catch(h){d.scrollHeight}else d.selected=!1;return c||(a.selectedIndex=-1),e}}}}),m.each(["radio","checkbox"],function(){m.valHooks[this]={set:function(a,b){return m.isArray(b)?a.checked=m.inArray(m(a).val(),b)>=0:void 0}},k.checkOn||(m.valHooks[this].get=function(a){return null===a.getAttribute("value")?"on":a.value})});var mc,nc,oc=m.expr.attrHandle,pc=/^(?:checked|selected)$/i,qc=k.getSetAttribute,rc=k.input;m.fn.extend({attr:function(a,b){return V(this,m.attr,a,b,arguments.length>1)},removeAttr:function(a){return this.each(function(){m.removeAttr(this,a)})}}),m.extend({attr:function(a,b,c){var d,e,f=a.nodeType;if(a&&3!==f&&8!==f&&2!==f)return typeof a.getAttribute===K?m.prop(a,b,c):(1===f&&m.isXMLDoc(a)||(b=b.toLowerCase(),d=m.attrHooks[b]||(m.expr.match.bool.test(b)?nc:mc)),void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=m.find.attr(a,b),null==e?void 0:e):null!==c?d&&"set"in d&&void 0!==(e=d.set(a,c,b))?e:(a.setAttribute(b,c+""),c):void m.removeAttr(a,b))},removeAttr:function(a,b){var c,d,e=0,f=b&&b.match(E);if(f&&1===a.nodeType)while(c=f[e++])d=m.propFix[c]||c,m.expr.match.bool.test(c)?rc&&qc||!pc.test(c)?a[d]=!1:a[m.camelCase("default-"+c)]=a[d]=!1:m.attr(a,c,""),a.removeAttribute(qc?c:d)},attrHooks:{type:{set:function(a,b){if(!k.radioValue&&"radio"===b&&m.nodeName(a,"input")){var c=a.value;return a.setAttribute("type",b),c&&(a.value=c),b}}}}}),nc={set:function(a,b,c){return b===!1?m.removeAttr(a,c):rc&&qc||!pc.test(c)?a.setAttribute(!qc&&m.propFix[c]||c,c):a[m.camelCase("default-"+c)]=a[c]=!0,c}},m.each(m.expr.match.bool.source.match(/\w+/g),function(a,b){var c=oc[b]||m.find.attr;oc[b]=rc&&qc||!pc.test(b)?function(a,b,d){var e,f;return d||(f=oc[b],oc[b]=e,e=null!=c(a,b,d)?b.toLowerCase():null,oc[b]=f),e}:function(a,b,c){return c?void 0:a[m.camelCase("default-"+b)]?b.toLowerCase():null}}),rc&&qc||(m.attrHooks.value={set:function(a,b,c){return m.nodeName(a,"input")?void(a.defaultValue=b):mc&&mc.set(a,b,c)}}),qc||(mc={set:function(a,b,c){var d=a.getAttributeNode(c);return d||a.setAttributeNode(d=a.ownerDocument.createAttribute(c)),d.value=b+="","value"===c||b===a.getAttribute(c)?b:void 0}},oc.id=oc.name=oc.coords=function(a,b,c){var d;return c?void 0:(d=a.getAttributeNode(b))&&""!==d.value?d.value:null},m.valHooks.button={get:function(a,b){var c=a.getAttributeNode(b);return c&&c.specified?c.value:void 0},set:mc.set},m.attrHooks.contenteditable={set:function(a,b,c){mc.set(a,""===b?!1:b,c)}},m.each(["width","height"],function(a,b){m.attrHooks[b]={set:function(a,c){return""===c?(a.setAttribute(b,"auto"),c):void 0}}})),k.style||(m.attrHooks.style={get:function(a){return a.style.cssText||void 0},set:function(a,b){return a.style.cssText=b+""}});var sc=/^(?:input|select|textarea|button|object)$/i,tc=/^(?:a|area)$/i;m.fn.extend({prop:function(a,b){return V(this,m.prop,a,b,arguments.length>1)},removeProp:function(a){return a=m.propFix[a]||a,this.each(function(){try{this[a]=void 0,delete this[a]}catch(b){}})}}),m.extend({propFix:{"for":"htmlFor","class":"className"},prop:function(a,b,c){var d,e,f,g=a.nodeType;if(a&&3!==g&&8!==g&&2!==g)return f=1!==g||!m.isXMLDoc(a),f&&(b=m.propFix[b]||b,e=m.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){var b=m.find.attr(a,"tabindex");return b?parseInt(b,10):sc.test(a.nodeName)||tc.test(a.nodeName)&&a.href?0:-1}}}}),k.hrefNormalized||m.each(["href","src"],function(a,b){m.propHooks[b]={get:function(a){return a.getAttribute(b,4)}}}),k.optSelected||(m.propHooks.selected={get:function(a){var b=a.parentNode;return b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex),null}}),m.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){m.propFix[this.toLowerCase()]=this}),k.enctype||(m.propFix.enctype="encoding");var uc=/[\t\r\n\f]/g;m.fn.extend({addClass:function(a){var b,c,d,e,f,g,h=0,i=this.length,j="string"==typeof a&&a;if(m.isFunction(a))return this.each(function(b){m(this).addClass(a.call(this,b,this.className))});if(j)for(b=(a||"").match(E)||[];i>h;h++)if(c=this[h],d=1===c.nodeType&&(c.className?(" "+c.className+" ").replace(uc," "):" ")){f=0;while(e=b[f++])d.indexOf(" "+e+" ")<0&&(d+=e+" ");g=m.trim(d),c.className!==g&&(c.className=g)}return this},removeClass:function(a){var b,c,d,e,f,g,h=0,i=this.length,j=0===arguments.length||"string"==typeof a&&a;if(m.isFunction(a))return this.each(function(b){m(this).removeClass(a.call(this,b,this.className))});if(j)for(b=(a||"").match(E)||[];i>h;h++)if(c=this[h],d=1===c.nodeType&&(c.className?(" "+c.className+" ").replace(uc," "):"")){f=0;while(e=b[f++])while(d.indexOf(" "+e+" ")>=0)d=d.replace(" "+e+" "," ");g=a?m.trim(d):"",c.className!==g&&(c.className=g)}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):this.each(m.isFunction(a)?function(c){m(this).toggleClass(a.call(this,c,this.className,b),b)}:function(){if("string"===c){var b,d=0,e=m(this),f=a.match(E)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else(c===K||"boolean"===c)&&(this.className&&m._data(this,"__className__",this.className),this.className=this.className||a===!1?"":m._data(this,"__className__")||"")})},hasClass:function(a){for(var b=" "+a+" ",c=0,d=this.length;d>c;c++)if(1===this[c].nodeType&&(" "+this[c].className+" ").replace(uc," ").indexOf(b)>=0)return!0;return!1}}),m.each("blur focus focusin focusout load resize scroll unload click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup error contextmenu".split(" "),function(a,b){m.fn[b]=function(a,c){return arguments.length>0?this.on(b,null,a,c):this.trigger(b)}}),m.fn.extend({hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)},bind:function(a,b,c){return this.on(a,null,b,c)},unbind:function(a,b){return this.off(a,null,b)},delegate:function(a,b,c,d){return this.on(b,a,c,d)},undelegate:function(a,b,c){return 1===arguments.length?this.off(a,"**"):this.off(b,a||"**",c)}});var vc=m.now(),wc=/\?/,xc=/(,)|(\[|{)|(}|])|"(?:[^"\\\r\n]|\\["\\\/bfnrt]|\\u[\da-fA-F]{4})*"\s*:?|true|false|null|-?(?!0\d)\d+(?:\.\d+|)(?:[eE][+-]?\d+|)/g;m.parseJSON=function(b){if(a.JSON&&a.JSON.parse)return a.JSON.parse(b+"");var c,d=null,e=m.trim(b+"");return e&&!m.trim(e.replace(xc,function(a,b,e,f){return c&&b&&(d=0),0===d?a:(c=e||b,d+=!f-!e,"")}))?Function("return "+e)():m.error("Invalid JSON: "+b)},m.parseXML=function(b){var c,d;if(!b||"string"!=typeof b)return null;try{a.DOMParser?(d=new DOMParser,c=d.parseFromString(b,"text/xml")):(c=new ActiveXObject("Microsoft.XMLDOM"),c.async="false",c.loadXML(b))}catch(e){c=void 0}return c&&c.documentElement&&!c.getElementsByTagName("parsererror").length||m.error("Invalid XML: "+b),c};var yc,zc,Ac=/#.*$/,Bc=/([?&])_=[^&]*/,Cc=/^(.*?):[ \t]*([^\r\n]*)\r?$/gm,Dc=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,Ec=/^(?:GET|HEAD)$/,Fc=/^\/\//,Gc=/^([\w.+-]+:)(?:\/\/(?:[^\/?#]*@|)([^\/?#:]*)(?::(\d+)|)|)/,Hc={},Ic={},Jc="*/".concat("*");try{zc=location.href}catch(Kc){zc=y.createElement("a"),zc.href="",zc=zc.href}yc=Gc.exec(zc.toLowerCase())||[];function Lc(a){return function(b,c){"string"!=typeof b&&(c=b,b="*");var d,e=0,f=b.toLowerCase().match(E)||[];if(m.isFunction(c))while(d=f[e++])"+"===d.charAt(0)?(d=d.slice(1)||"*",(a[d]=a[d]||[]).unshift(c)):(a[d]=a[d]||[]).push(c)}}function Mc(a,b,c,d){var e={},f=a===Ic;function g(h){var i;return e[h]=!0,m.each(a[h]||[],function(a,h){var j=h(b,c,d);return"string"!=typeof j||f||e[j]?f?!(i=j):void 0:(b.dataTypes.unshift(j),g(j),!1)}),i}return g(b.dataTypes[0])||!e["*"]&&g("*")}function Nc(a,b){var c,d,e=m.ajaxSettings.flatOptions||{};for(d in b)void 0!==b[d]&&((e[d]?a:c||(c={}))[d]=b[d]);return c&&m.extend(!0,a,c),a}function Oc(a,b,c){var d,e,f,g,h=a.contents,i=a.dataTypes;while("*"===i[0])i.shift(),void 0===e&&(e=a.mimeType||b.getResponseHeader("Content-Type"));if(e)for(g in h)if(h[g]&&h[g].test(e)){i.unshift(g);break}if(i[0]in c)f=i[0];else{for(g in c){if(!i[0]||a.converters[g+" "+i[0]]){f=g;break}d||(d=g)}f=f||d}return f?(f!==i[0]&&i.unshift(f),c[f]):void 0}function Pc(a,b,c,d){var e,f,g,h,i,j={},k=a.dataTypes.slice();if(k[1])for(g in a.converters)j[g.toLowerCase()]=a.converters[g];f=k.shift();while(f)if(a.responseFields[f]&&(c[a.responseFields[f]]=b),!i&&d&&a.dataFilter&&(b=a.dataFilter(b,a.dataType)),i=f,f=k.shift())if("*"===f)f=i;else if("*"!==i&&i!==f){if(g=j[i+" "+f]||j["* "+f],!g)for(e in j)if(h=e.split(" "),h[1]===f&&(g=j[i+" "+h[0]]||j["* "+h[0]])){g===!0?g=j[e]:j[e]!==!0&&(f=h[0],k.unshift(h[1]));break}if(g!==!0)if(g&&a["throws"])b=g(b);else try{b=g(b)}catch(l){return{state:"parsererror",error:g?l:"No conversion from "+i+" to "+f}}}return{state:"success",data:b}}m.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:zc,type:"GET",isLocal:Dc.test(yc[1]),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":Jc,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":m.parseJSON,"text xml":m.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(a,b){return b?Nc(Nc(a,m.ajaxSettings),b):Nc(m.ajaxSettings,a)},ajaxPrefilter:Lc(Hc),ajaxTransport:Lc(Ic),ajax:function(a,b){"object"==typeof a&&(b=a,a=void 0),b=b||{};var c,d,e,f,g,h,i,j,k=m.ajaxSetup({},b),l=k.context||k,n=k.context&&(l.nodeType||l.jquery)?m(l):m.event,o=m.Deferred(),p=m.Callbacks("once memory"),q=k.statusCode||{},r={},s={},t=0,u="canceled",v={readyState:0,getResponseHeader:function(a){var b;if(2===t){if(!j){j={};while(b=Cc.exec(f))j[b[1].toLowerCase()]=b[2]}b=j[a.toLowerCase()]}return null==b?null:b},getAllResponseHeaders:function(){return 2===t?f:null},setRequestHeader:function(a,b){var c=a.toLowerCase();return t||(a=s[c]=s[c]||a,r[a]=b),this},overrideMimeType:function(a){return t||(k.mimeType=a),this},statusCode:function(a){var b;if(a)if(2>t)for(b in a)q[b]=[q[b],a[b]];else v.always(a[v.status]);return this},abort:function(a){var b=a||u;return i&&i.abort(b),x(0,b),this}};if(o.promise(v).complete=p.add,v.success=v.done,v.error=v.fail,k.url=((a||k.url||zc)+"").replace(Ac,"").replace(Fc,yc[1]+"//"),k.type=b.method||b.type||k.method||k.type,k.dataTypes=m.trim(k.dataType||"*").toLowerCase().match(E)||[""],null==k.crossDomain&&(c=Gc.exec(k.url.toLowerCase()),k.crossDomain=!(!c||c[1]===yc[1]&&c[2]===yc[2]&&(c[3]||("http:"===c[1]?"80":"443"))===(yc[3]||("http:"===yc[1]?"80":"443")))),k.data&&k.processData&&"string"!=typeof k.data&&(k.data=m.param(k.data,k.traditional)),Mc(Hc,k,b,v),2===t)return v;h=k.global,h&&0===m.active++&&m.event.trigger("ajaxStart"),k.type=k.type.toUpperCase(),k.hasContent=!Ec.test(k.type),e=k.url,k.hasContent||(k.data&&(e=k.url+=(wc.test(e)?"&":"?")+k.data,delete k.data),k.cache===!1&&(k.url=Bc.test(e)?e.replace(Bc,"$1_="+vc++):e+(wc.test(e)?"&":"?")+"_="+vc++)),k.ifModified&&(m.lastModified[e]&&v.setRequestHeader("If-Modified-Since",m.lastModified[e]),m.etag[e]&&v.setRequestHeader("If-None-Match",m.etag[e])),(k.data&&k.hasContent&&k.contentType!==!1||b.contentType)&&v.setRequestHeader("Content-Type",k.contentType),v.setRequestHeader("Accept",k.dataTypes[0]&&k.accepts[k.dataTypes[0]]?k.accepts[k.dataTypes[0]]+("*"!==k.dataTypes[0]?", "+Jc+"; q=0.01":""):k.accepts["*"]);for(d in k.headers)v.setRequestHeader(d,k.headers[d]);if(k.beforeSend&&(k.beforeSend.call(l,v,k)===!1||2===t))return v.abort();u="abort";for(d in{success:1,error:1,complete:1})v[d](k[d]);if(i=Mc(Ic,k,b,v)){v.readyState=1,h&&n.trigger("ajaxSend",[v,k]),k.async&&k.timeout>0&&(g=setTimeout(function(){v.abort("timeout")},k.timeout));try{t=1,i.send(r,x)}catch(w){if(!(2>t))throw w;x(-1,w)}}else x(-1,"No Transport");function x(a,b,c,d){var j,r,s,u,w,x=b;2!==t&&(t=2,g&&clearTimeout(g),i=void 0,f=d||"",v.readyState=a>0?4:0,j=a>=200&&300>a||304===a,c&&(u=Oc(k,v,c)),u=Pc(k,u,v,j),j?(k.ifModified&&(w=v.getResponseHeader("Last-Modified"),w&&(m.lastModified[e]=w),w=v.getResponseHeader("etag"),w&&(m.etag[e]=w)),204===a||"HEAD"===k.type?x="nocontent":304===a?x="notmodified":(x=u.state,r=u.data,s=u.error,j=!s)):(s=x,(a||!x)&&(x="error",0>a&&(a=0))),v.status=a,v.statusText=(b||x)+"",j?o.resolveWith(l,[r,x,v]):o.rejectWith(l,[v,x,s]),v.statusCode(q),q=void 0,h&&n.trigger(j?"ajaxSuccess":"ajaxError",[v,k,j?r:s]),p.fireWith(l,[v,x]),h&&(n.trigger("ajaxComplete",[v,k]),--m.active||m.event.trigger("ajaxStop")))}return v},getJSON:function(a,b,c){return m.get(a,b,c,"json")},getScript:function(a,b){return m.get(a,void 0,b,"script")}}),m.each(["get","post"],function(a,b){m[b]=function(a,c,d,e){return m.isFunction(c)&&(e=e||d,d=c,c=void 0),m.ajax({url:a,type:b,dataType:e,data:c,success:d})}}),m.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(a,b){m.fn[b]=function(a){return this.on(b,a)}}),m._evalUrl=function(a){return m.ajax({url:a,type:"GET",dataType:"script",async:!1,global:!1,"throws":!0})},m.fn.extend({wrapAll:function(a){if(m.isFunction(a))return this.each(function(b){m(this).wrapAll(a.call(this,b))});if(this[0]){var b=m(a,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstChild&&1===a.firstChild.nodeType)a=a.firstChild;return a}).append(this)}return this},wrapInner:function(a){return this.each(m.isFunction(a)?function(b){m(this).wrapInner(a.call(this,b))}:function(){var b=m(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=m.isFunction(a);return this.each(function(c){m(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(){return this.parent().each(function(){m.nodeName(this,"body")||m(this).replaceWith(this.childNodes)}).end()}}),m.expr.filters.hidden=function(a){return a.offsetWidth<=0&&a.offsetHeight<=0||!k.reliableHiddenOffsets()&&"none"===(a.style&&a.style.display||m.css(a,"display"))},m.expr.filters.visible=function(a){return!m.expr.filters.hidden(a)};var Qc=/%20/g,Rc=/\[\]$/,Sc=/\r?\n/g,Tc=/^(?:submit|button|image|reset|file)$/i,Uc=/^(?:input|select|textarea|keygen)/i;function Vc(a,b,c,d){var e;if(m.isArray(b))m.each(b,function(b,e){c||Rc.test(a)?d(a,e):Vc(a+"["+("object"==typeof e?b:"")+"]",e,c,d)});else if(c||"object"!==m.type(b))d(a,b);else for(e in b)Vc(a+"["+e+"]",b[e],c,d)}m.param=function(a,b){var c,d=[],e=function(a,b){b=m.isFunction(b)?b():null==b?"":b,d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(b)};if(void 0===b&&(b=m.ajaxSettings&&m.ajaxSettings.traditional),m.isArray(a)||a.jquery&&!m.isPlainObject(a))m.each(a,function(){e(this.name,this.value)});else for(c in a)Vc(c,a[c],b,e);return d.join("&").replace(Qc,"+")},m.fn.extend({serialize:function(){return m.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var a=m.prop(this,"elements");return a?m.makeArray(a):this}).filter(function(){var a=this.type;return this.name&&!m(this).is(":disabled")&&Uc.test(this.nodeName)&&!Tc.test(a)&&(this.checked||!W.test(a))}).map(function(a,b){var c=m(this).val();return null==c?null:m.isArray(c)?m.map(c,function(a){return{name:b.name,value:a.replace(Sc,"\r\n")}}):{name:b.name,value:c.replace(Sc,"\r\n")}}).get()}}),m.ajaxSettings.xhr=void 0!==a.ActiveXObject?function(){return!this.isLocal&&/^(get|post|head|put|delete|options)$/i.test(this.type)&&Zc()||$c()}:Zc;var Wc=0,Xc={},Yc=m.ajaxSettings.xhr();a.ActiveXObject&&m(a).on("unload",function(){for(var a in Xc)Xc[a](void 0,!0)}),k.cors=!!Yc&&"withCredentials"in Yc,Yc=k.ajax=!!Yc,Yc&&m.ajaxTransport(function(a){if(!a.crossDomain||k.cors){var b;return{send:function(c,d){var e,f=a.xhr(),g=++Wc;if(f.open(a.type,a.url,a.async,a.username,a.password),a.xhrFields)for(e in a.xhrFields)f[e]=a.xhrFields[e];a.mimeType&&f.overrideMimeType&&f.overrideMimeType(a.mimeType),a.crossDomain||c["X-Requested-With"]||(c["X-Requested-With"]="XMLHttpRequest");for(e in c)void 0!==c[e]&&f.setRequestHeader(e,c[e]+"");f.send(a.hasContent&&a.data||null),b=function(c,e){var h,i,j;if(b&&(e||4===f.readyState))if(delete Xc[g],b=void 0,f.onreadystatechange=m.noop,e)4!==f.readyState&&f.abort();else{j={},h=f.status,"string"==typeof f.responseText&&(j.text=f.responseText);try{i=f.statusText}catch(k){i=""}h||!a.isLocal||a.crossDomain?1223===h&&(h=204):h=j.text?200:404}j&&d(h,i,j,f.getAllResponseHeaders())},a.async?4===f.readyState?setTimeout(b):f.onreadystatechange=Xc[g]=b:b()},abort:function(){b&&b(void 0,!0)}}}});function Zc(){try{return new a.XMLHttpRequest}catch(b){}}function $c(){try{return new a.ActiveXObject("Microsoft.XMLHTTP")}catch(b){}}m.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/(?:java|ecma)script/},converters:{"text script":function(a){return m.globalEval(a),a}}}),m.ajaxPrefilter("script",function(a){void 0===a.cache&&(a.cache=!1),a.crossDomain&&(a.type="GET",a.global=!1)}),m.ajaxTransport("script",function(a){if(a.crossDomain){var b,c=y.head||m("head")[0]||y.documentElement;return{send:function(d,e){b=y.createElement("script"),b.async=!0,a.scriptCharset&&(b.charset=a.scriptCharset),b.src=a.url,b.onload=b.onreadystatechange=function(a,c){(c||!b.readyState||/loaded|complete/.test(b.readyState))&&(b.onload=b.onreadystatechange=null,b.parentNode&&b.parentNode.removeChild(b),b=null,c||e(200,"success"))},c.insertBefore(b,c.firstChild)},abort:function(){b&&b.onload(void 0,!0)}}}});var _c=[],ad=/(=)\?(?=&|$)|\?\?/;m.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var a=_c.pop()||m.expando+"_"+vc++;return this[a]=!0,a}}),m.ajaxPrefilter("json jsonp",function(b,c,d){var e,f,g,h=b.jsonp!==!1&&(ad.test(b.url)?"url":"string"==typeof b.data&&!(b.contentType||"").indexOf("application/x-www-form-urlencoded")&&ad.test(b.data)&&"data");return h||"jsonp"===b.dataTypes[0]?(e=b.jsonpCallback=m.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,h?b[h]=b[h].replace(ad,"$1"+e):b.jsonp!==!1&&(b.url+=(wc.test(b.url)?"&":"?")+b.jsonp+"="+e),b.converters["script json"]=function(){return g||m.error(e+" was not called"),g[0]},b.dataTypes[0]="json",f=a[e],a[e]=function(){g=arguments},d.always(function(){a[e]=f,b[e]&&(b.jsonpCallback=c.jsonpCallback,_c.push(e)),g&&m.isFunction(f)&&f(g[0]),g=f=void 0}),"script"):void 0}),m.parseHTML=function(a,b,c){if(!a||"string"!=typeof a)return null;"boolean"==typeof b&&(c=b,b=!1),b=b||y;var d=u.exec(a),e=!c&&[];return d?[b.createElement(d[1])]:(d=m.buildFragment([a],b,e),e&&e.length&&m(e).remove(),m.merge([],d.childNodes))};var bd=m.fn.load;m.fn.load=function(a,b,c){if("string"!=typeof a&&bd)return bd.apply(this,arguments);var d,e,f,g=this,h=a.indexOf(" ");return h>=0&&(d=m.trim(a.slice(h,a.length)),a=a.slice(0,h)),m.isFunction(b)?(c=b,b=void 0):b&&"object"==typeof b&&(f="POST"),g.length>0&&m.ajax({url:a,type:f,dataType:"html",data:b}).done(function(a){e=arguments,g.html(d?m("<div>").append(m.parseHTML(a)).find(d):a)}).complete(c&&function(a,b){g.each(c,e||[a.responseText,b,a])}),this},m.expr.filters.animated=function(a){return m.grep(m.timers,function(b){return a===b.elem}).length};var cd=a.document.documentElement;function dd(a){return m.isWindow(a)?a:9===a.nodeType?a.defaultView||a.parentWindow:!1}m.offset={setOffset:function(a,b,c){var d,e,f,g,h,i,j,k=m.css(a,"position"),l=m(a),n={};"static"===k&&(a.style.position="relative"),h=l.offset(),f=m.css(a,"top"),i=m.css(a,"left"),j=("absolute"===k||"fixed"===k)&&m.inArray("auto",[f,i])>-1,j?(d=l.position(),g=d.top,e=d.left):(g=parseFloat(f)||0,e=parseFloat(i)||0),m.isFunction(b)&&(b=b.call(a,c,h)),null!=b.top&&(n.top=b.top-h.top+g),null!=b.left&&(n.left=b.left-h.left+e),"using"in b?b.using.call(a,n):l.css(n)}},m.fn.extend({offset:function(a){if(arguments.length)return void 0===a?this:this.each(function(b){m.offset.setOffset(this,a,b)});var b,c,d={top:0,left:0},e=this[0],f=e&&e.ownerDocument;if(f)return b=f.documentElement,m.contains(b,e)?(typeof e.getBoundingClientRect!==K&&(d=e.getBoundingClientRect()),c=dd(f),{top:d.top+(c.pageYOffset||b.scrollTop)-(b.clientTop||0),left:d.left+(c.pageXOffset||b.scrollLeft)-(b.clientLeft||0)}):d},position:function(){if(this[0]){var a,b,c={top:0,left:0},d=this[0];return"fixed"===m.css(d,"position")?b=d.getBoundingClientRect():(a=this.offsetParent(),b=this.offset(),m.nodeName(a[0],"html")||(c=a.offset()),c.top+=m.css(a[0],"borderTopWidth",!0),c.left+=m.css(a[0],"borderLeftWidth",!0)),{top:b.top-c.top-m.css(d,"marginTop",!0),left:b.left-c.left-m.css(d,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||cd;while(a&&!m.nodeName(a,"html")&&"static"===m.css(a,"position"))a=a.offsetParent;return a||cd})}}),m.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(a,b){var c=/Y/.test(b);m.fn[a]=function(d){return V(this,function(a,d,e){var f=dd(a);return void 0===e?f?b in f?f[b]:f.document.documentElement[d]:a[d]:void(f?f.scrollTo(c?m(f).scrollLeft():e,c?e:m(f).scrollTop()):a[d]=e)},a,d,arguments.length,null)}}),m.each(["top","left"],function(a,b){m.cssHooks[b]=Lb(k.pixelPosition,function(a,c){return c?(c=Jb(a,b),Hb.test(c)?m(a).position()[b]+"px":c):void 0})}),m.each({Height:"height",Width:"width"},function(a,b){m.each({padding:"inner"+a,content:b,"":"outer"+a},function(c,d){m.fn[d]=function(d,e){var f=arguments.length&&(c||"boolean"!=typeof d),g=c||(d===!0||e===!0?"margin":"border");return V(this,function(b,c,d){var e;return m.isWindow(b)?b.document.documentElement["client"+a]:9===b.nodeType?(e=b.documentElement,Math.max(b.body["scroll"+a],e["scroll"+a],b.body["offset"+a],e["offset"+a],e["client"+a])):void 0===d?m.css(b,c,g):m.style(b,c,d,g)},b,f?d:void 0,f,null)}})}),m.fn.size=function(){return this.length},m.fn.andSelf=m.fn.addBack,"function"==typeof define&&define.amd&&define("jquery",[],function(){return m});var ed=a.jQuery,fd=a.$;return m.noConflict=function(b){return a.$===m&&(a.$=fd),b&&a.jQuery===m&&(a.jQuery=ed),m},typeof b===K&&(a.jQuery=a.$=m),m});
+/*! jQuery v3.2.1 | (c) JS Foundation and other contributors | jquery.org/license */
+!function(a,b){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){"use strict";var c=[],d=a.document,e=Object.getPrototypeOf,f=c.slice,g=c.concat,h=c.push,i=c.indexOf,j={},k=j.toString,l=j.hasOwnProperty,m=l.toString,n=m.call(Object),o={};function p(a,b){b=b||d;var c=b.createElement("script");c.text=a,b.head.appendChild(c).parentNode.removeChild(c)}var q="3.2.1",r=function(a,b){return new r.fn.init(a,b)},s=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,t=/^-ms-/,u=/-([a-z])/g,v=function(a,b){return b.toUpperCase()};r.fn=r.prototype={jquery:q,constructor:r,length:0,toArray:function(){return f.call(this)},get:function(a){return null==a?f.call(this):a<0?this[a+this.length]:this[a]},pushStack:function(a){var b=r.merge(this.constructor(),a);return b.prevObject=this,b},each:function(a){return r.each(this,a)},map:function(a){return this.pushStack(r.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(f.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(a<0?b:0);return this.pushStack(c>=0&&c<b?[this[c]]:[])},end:function(){return this.prevObject||this.constructor()},push:h,sort:c.sort,splice:c.splice},r.extend=r.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||r.isFunction(g)||(g={}),h===i&&(g=this,h--);h<i;h++)if(null!=(a=arguments[h]))for(b in a)c=g[b],d=a[b],g!==d&&(j&&d&&(r.isPlainObject(d)||(e=Array.isArray(d)))?(e?(e=!1,f=c&&Array.isArray(c)?c:[]):f=c&&r.isPlainObject(c)?c:{},g[b]=r.extend(j,f,d)):void 0!==d&&(g[b]=d));return g},r.extend({expando:"jQuery"+(q+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===r.type(a)},isWindow:function(a){return null!=a&&a===a.window},isNumeric:function(a){var b=r.type(a);return("number"===b||"string"===b)&&!isNaN(a-parseFloat(a))},isPlainObject:function(a){var b,c;return!(!a||"[object Object]"!==k.call(a))&&(!(b=e(a))||(c=l.call(b,"constructor")&&b.constructor,"function"==typeof c&&m.call(c)===n))},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?j[k.call(a)]||"object":typeof a},globalEval:function(a){p(a)},camelCase:function(a){return a.replace(t,"ms-").replace(u,v)},each:function(a,b){var c,d=0;if(w(a)){for(c=a.length;d<c;d++)if(b.call(a[d],d,a[d])===!1)break}else for(d in a)if(b.call(a[d],d,a[d])===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(s,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(w(Object(a))?r.merge(c,"string"==typeof a?[a]:a):h.call(c,a)),c},inArray:function(a,b,c){return null==b?-1:i.call(b,a,c)},merge:function(a,b){for(var c=+b.length,d=0,e=a.length;d<c;d++)a[e++]=b[d];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;f<g;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,e,f=0,h=[];if(w(a))for(d=a.length;f<d;f++)e=b(a[f],f,c),null!=e&&h.push(e);else for(f in a)e=b(a[f],f,c),null!=e&&h.push(e);return g.apply([],h)},guid:1,proxy:function(a,b){var c,d,e;if("string"==typeof b&&(c=a[b],b=a,a=c),r.isFunction(a))return d=f.call(arguments,2),e=function(){return a.apply(b||this,d.concat(f.call(arguments)))},e.guid=a.guid=a.guid||r.guid++,e},now:Date.now,support:o}),"function"==typeof Symbol&&(r.fn[Symbol.iterator]=c[Symbol.iterator]),r.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(a,b){j["[object "+b+"]"]=b.toLowerCase()});function w(a){var b=!!a&&"length"in a&&a.length,c=r.type(a);return"function"!==c&&!r.isWindow(a)&&("array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a)}var x=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+1*new Date,v=a.document,w=0,x=0,y=ha(),z=ha(),A=ha(),B=function(a,b){return a===b&&(l=!0),0},C={}.hasOwnProperty,D=[],E=D.pop,F=D.push,G=D.push,H=D.slice,I=function(a,b){for(var c=0,d=a.length;c<d;c++)if(a[c]===b)return c;return-1},J="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",K="[\\x20\\t\\r\\n\\f]",L="(?:\\\\.|[\\w-]|[^\0-\\xa0])+",M="\\["+K+"*("+L+")(?:"+K+"*([*^$|!~]?=)"+K+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+L+"))|)"+K+"*\\]",N=":("+L+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+M+")*)|.*)\\)|)",O=new RegExp(K+"+","g"),P=new RegExp("^"+K+"+|((?:^|[^\\\\])(?:\\\\.)*)"+K+"+$","g"),Q=new RegExp("^"+K+"*,"+K+"*"),R=new RegExp("^"+K+"*([>+~]|"+K+")"+K+"*"),S=new RegExp("="+K+"*([^\\]'\"]*?)"+K+"*\\]","g"),T=new RegExp(N),U=new RegExp("^"+L+"$"),V={ID:new RegExp("^#("+L+")"),CLASS:new RegExp("^\\.("+L+")"),TAG:new RegExp("^("+L+"|[*])"),ATTR:new RegExp("^"+M),PSEUDO:new RegExp("^"+N),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+K+"*(even|odd|(([+-]|)(\\d*)n|)"+K+"*(?:([+-]|)"+K+"*(\\d+)|))"+K+"*\\)|)","i"),bool:new RegExp("^(?:"+J+")$","i"),needsContext:new RegExp("^"+K+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+K+"*((?:-\\d)?\\d*)"+K+"*\\)|)(?=[^-]|$)","i")},W=/^(?:input|select|textarea|button)$/i,X=/^h\d$/i,Y=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,$=/[+~]/,_=new RegExp("\\\\([\\da-f]{1,6}"+K+"?|("+K+")|.)","ig"),aa=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:d<0?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)},ba=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ca=function(a,b){return b?"\0"===a?"\ufffd":a.slice(0,-1)+"\\"+a.charCodeAt(a.length-1).toString(16)+" ":"\\"+a},da=function(){m()},ea=ta(function(a){return a.disabled===!0&&("form"in a||"label"in a)},{dir:"parentNode",next:"legend"});try{G.apply(D=H.call(v.childNodes),v.childNodes),D[v.childNodes.length].nodeType}catch(fa){G={apply:D.length?function(a,b){F.apply(a,H.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function ga(a,b,d,e){var f,h,j,k,l,o,r,s=b&&b.ownerDocument,w=b?b.nodeType:9;if(d=d||[],"string"!=typeof a||!a||1!==w&&9!==w&&11!==w)return d;if(!e&&((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,p)){if(11!==w&&(l=Z.exec(a)))if(f=l[1]){if(9===w){if(!(j=b.getElementById(f)))return d;if(j.id===f)return d.push(j),d}else if(s&&(j=s.getElementById(f))&&t(b,j)&&j.id===f)return d.push(j),d}else{if(l[2])return G.apply(d,b.getElementsByTagName(a)),d;if((f=l[3])&&c.getElementsByClassName&&b.getElementsByClassName)return G.apply(d,b.getElementsByClassName(f)),d}if(c.qsa&&!A[a+" "]&&(!q||!q.test(a))){if(1!==w)s=b,r=a;else if("object"!==b.nodeName.toLowerCase()){(k=b.getAttribute("id"))?k=k.replace(ba,ca):b.setAttribute("id",k=u),o=g(a),h=o.length;while(h--)o[h]="#"+k+" "+sa(o[h]);r=o.join(","),s=$.test(a)&&qa(b.parentNode)||b}if(r)try{return G.apply(d,s.querySelectorAll(r)),d}catch(x){}finally{k===u&&b.removeAttribute("id")}}}return i(a.replace(P,"$1"),b,d,e)}function ha(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function ia(a){return a[u]=!0,a}function ja(a){var b=n.createElement("fieldset");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function ka(a,b){var c=a.split("|"),e=c.length;while(e--)d.attrHandle[c[e]]=b}function la(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&a.sourceIndex-b.sourceIndex;if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function ma(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function na(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function oa(a){return function(b){return"form"in b?b.parentNode&&b.disabled===!1?"label"in b?"label"in b.parentNode?b.parentNode.disabled===a:b.disabled===a:b.isDisabled===a||b.isDisabled!==!a&&ea(b)===a:b.disabled===a:"label"in b&&b.disabled===a}}function pa(a){return ia(function(b){return b=+b,ia(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function qa(a){return a&&"undefined"!=typeof a.getElementsByTagName&&a}c=ga.support={},f=ga.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return!!b&&"HTML"!==b.nodeName},m=ga.setDocument=function(a){var b,e,g=a?a.ownerDocument||a:v;return g!==n&&9===g.nodeType&&g.documentElement?(n=g,o=n.documentElement,p=!f(n),v!==n&&(e=n.defaultView)&&e.top!==e&&(e.addEventListener?e.addEventListener("unload",da,!1):e.attachEvent&&e.attachEvent("onunload",da)),c.attributes=ja(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ja(function(a){return a.appendChild(n.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=Y.test(n.getElementsByClassName),c.getById=ja(function(a){return o.appendChild(a).id=u,!n.getElementsByName||!n.getElementsByName(u).length}),c.getById?(d.filter.ID=function(a){var b=a.replace(_,aa);return function(a){return a.getAttribute("id")===b}},d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c=b.getElementById(a);return c?[c]:[]}}):(d.filter.ID=function(a){var b=a.replace(_,aa);return function(a){var c="undefined"!=typeof a.getAttributeNode&&a.getAttributeNode("id");return c&&c.value===b}},d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c,d,e,f=b.getElementById(a);if(f){if(c=f.getAttributeNode("id"),c&&c.value===a)return[f];e=b.getElementsByName(a),d=0;while(f=e[d++])if(c=f.getAttributeNode("id"),c&&c.value===a)return[f]}return[]}}),d.find.TAG=c.getElementsByTagName?function(a,b){return"undefined"!=typeof b.getElementsByTagName?b.getElementsByTagName(a):c.qsa?b.querySelectorAll(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){if("undefined"!=typeof b.getElementsByClassName&&p)return b.getElementsByClassName(a)},r=[],q=[],(c.qsa=Y.test(n.querySelectorAll))&&(ja(function(a){o.appendChild(a).innerHTML="<a id='"+u+"'></a><select id='"+u+"-\r\\' msallowcapture=''><option selected=''></option></select>",a.querySelectorAll("[msallowcapture^='']").length&&q.push("[*^$]="+K+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+K+"*(?:value|"+J+")"),a.querySelectorAll("[id~="+u+"-]").length||q.push("~="),a.querySelectorAll(":checked").length||q.push(":checked"),a.querySelectorAll("a#"+u+"+*").length||q.push(".#.+[+~]")}),ja(function(a){a.innerHTML="<a href='' disabled='disabled'></a><select disabled='disabled'><option/></select>";var b=n.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+K+"*[*^$|!~]?="),2!==a.querySelectorAll(":enabled").length&&q.push(":enabled",":disabled"),o.appendChild(a).disabled=!0,2!==a.querySelectorAll(":disabled").length&&q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=Y.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ja(function(a){c.disconnectedMatch=s.call(a,"*"),s.call(a,"[s!='']:x"),r.push("!=",N)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=Y.test(o.compareDocumentPosition),t=b||Y.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===n||a.ownerDocument===v&&t(v,a)?-1:b===n||b.ownerDocument===v&&t(v,b)?1:k?I(k,a)-I(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,e=a.parentNode,f=b.parentNode,g=[a],h=[b];if(!e||!f)return a===n?-1:b===n?1:e?-1:f?1:k?I(k,a)-I(k,b):0;if(e===f)return la(a,b);c=a;while(c=c.parentNode)g.unshift(c);c=b;while(c=c.parentNode)h.unshift(c);while(g[d]===h[d])d++;return d?la(g[d],h[d]):g[d]===v?-1:h[d]===v?1:0},n):n},ga.matches=function(a,b){return ga(a,null,null,b)},ga.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(S,"='$1']"),c.matchesSelector&&p&&!A[b+" "]&&(!r||!r.test(b))&&(!q||!q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return ga(b,n,null,[a]).length>0},ga.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},ga.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&C.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},ga.escape=function(a){return(a+"").replace(ba,ca)},ga.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},ga.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=ga.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=ga.selectors={cacheLength:50,createPseudo:ia,match:V,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(_,aa),a[3]=(a[3]||a[4]||a[5]||"").replace(_,aa),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||ga.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&ga.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return V.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&T.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(_,aa).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+K+")"+a+"("+K+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||"undefined"!=typeof a.getAttribute&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=ga.attr(d,a);return null==e?"!="===b:!b||(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e.replace(O," ")+" ").indexOf(c)>-1:"|="===b&&(e===c||e.slice(0,c.length+1)===c+"-"))}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h,t=!1;if(q){if(f){while(p){m=b;while(m=m[p])if(h?m.nodeName.toLowerCase()===r:1===m.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){m=q,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n&&j[2],m=n&&q.childNodes[n];while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if(1===m.nodeType&&++t&&m===b){k[a]=[w,n,t];break}}else if(s&&(m=b,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n),t===!1)while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if((h?m.nodeName.toLowerCase()===r:1===m.nodeType)&&++t&&(s&&(l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),k[a]=[w,t]),m===b))break;return t-=e,t===d||t%d===0&&t/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||ga.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?ia(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=I(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:ia(function(a){var b=[],c=[],d=h(a.replace(P,"$1"));return d[u]?ia(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),b[0]=null,!c.pop()}}),has:ia(function(a){return function(b){return ga(a,b).length>0}}),contains:ia(function(a){return a=a.replace(_,aa),function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:ia(function(a){return U.test(a||"")||ga.error("unsupported lang: "+a),a=a.replace(_,aa).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:oa(!1),disabled:oa(!0),checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return X.test(a.nodeName)},input:function(a){return W.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:pa(function(){return[0]}),last:pa(function(a,b){return[b-1]}),eq:pa(function(a,b,c){return[c<0?c+b:c]}),even:pa(function(a,b){for(var c=0;c<b;c+=2)a.push(c);return a}),odd:pa(function(a,b){for(var c=1;c<b;c+=2)a.push(c);return a}),lt:pa(function(a,b,c){for(var d=c<0?c+b:c;--d>=0;)a.push(d);return a}),gt:pa(function(a,b,c){for(var d=c<0?c+b:c;++d<b;)a.push(d);return a})}},d.pseudos.nth=d.pseudos.eq;for(b in{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})d.pseudos[b]=ma(b);for(b in{submit:!0,reset:!0})d.pseudos[b]=na(b);function ra(){}ra.prototype=d.filters=d.pseudos,d.setFilters=new ra,g=ga.tokenize=function(a,b){var c,e,f,g,h,i,j,k=z[a+" "];if(k)return b?0:k.slice(0);h=a,i=[],j=d.preFilter;while(h){c&&!(e=Q.exec(h))||(e&&(h=h.slice(e[0].length)||h),i.push(f=[])),c=!1,(e=R.exec(h))&&(c=e.shift(),f.push({value:c,type:e[0].replace(P," ")}),h=h.slice(c.length));for(g in d.filter)!(e=V[g].exec(h))||j[g]&&!(e=j[g](e))||(c=e.shift(),f.push({value:c,type:g,matches:e}),h=h.slice(c.length));if(!c)break}return b?h.length:h?ga.error(a):z(a,i).slice(0)};function sa(a){for(var b=0,c=a.length,d="";b<c;b++)d+=a[b].value;return d}function ta(a,b,c){var d=b.dir,e=b.next,f=e||d,g=c&&"parentNode"===f,h=x++;return b.first?function(b,c,e){while(b=b[d])if(1===b.nodeType||g)return a(b,c,e);return!1}:function(b,c,i){var j,k,l,m=[w,h];if(i){while(b=b[d])if((1===b.nodeType||g)&&a(b,c,i))return!0}else while(b=b[d])if(1===b.nodeType||g)if(l=b[u]||(b[u]={}),k=l[b.uniqueID]||(l[b.uniqueID]={}),e&&e===b.nodeName.toLowerCase())b=b[d]||b;else{if((j=k[f])&&j[0]===w&&j[1]===h)return m[2]=j[2];if(k[f]=m,m[2]=a(b,c,i))return!0}return!1}}function ua(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function va(a,b,c){for(var d=0,e=b.length;d<e;d++)ga(a,b[d],c);return c}function wa(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;h<i;h++)(f=a[h])&&(c&&!c(f,d,e)||(g.push(f),j&&b.push(h)));return g}function xa(a,b,c,d,e,f){return d&&!d[u]&&(d=xa(d)),e&&!e[u]&&(e=xa(e,f)),ia(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||va(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:wa(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=wa(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?I(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=wa(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):G.apply(g,r)})}function ya(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=ta(function(a){return a===b},h,!0),l=ta(function(a){return I(b,a)>-1},h,!0),m=[function(a,c,d){var e=!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d));return b=null,e}];i<f;i++)if(c=d.relative[a[i].type])m=[ta(ua(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;e<f;e++)if(d.relative[a[e].type])break;return xa(i>1&&ua(m),i>1&&sa(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(P,"$1"),c,i<e&&ya(a.slice(i,e)),e<f&&ya(a=a.slice(e)),e<f&&sa(a))}m.push(c)}return ua(m)}function za(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,o,q,r=0,s="0",t=f&&[],u=[],v=j,x=f||e&&d.find.TAG("*",k),y=w+=null==v?1:Math.random()||.1,z=x.length;for(k&&(j=g===n||g||k);s!==z&&null!=(l=x[s]);s++){if(e&&l){o=0,g||l.ownerDocument===n||(m(l),h=!p);while(q=a[o++])if(q(l,g||n,h)){i.push(l);break}k&&(w=y)}c&&((l=!q&&l)&&r--,f&&t.push(l))}if(r+=s,c&&s!==r){o=0;while(q=b[o++])q(t,u,g,h);if(f){if(r>0)while(s--)t[s]||u[s]||(u[s]=E.call(i));u=wa(u)}G.apply(i,u),k&&!f&&u.length>0&&r+b.length>1&&ga.uniqueSort(i)}return k&&(w=y,j=v),t};return c?ia(f):f}return h=ga.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=ya(b[c]),f[u]?d.push(f):e.push(f);f=A(a,za(e,d)),f.selector=a}return f},i=ga.select=function(a,b,c,e){var f,i,j,k,l,m="function"==typeof a&&a,n=!e&&g(a=m.selector||a);if(c=c||[],1===n.length){if(i=n[0]=n[0].slice(0),i.length>2&&"ID"===(j=i[0]).type&&9===b.nodeType&&p&&d.relative[i[1].type]){if(b=(d.find.ID(j.matches[0].replace(_,aa),b)||[])[0],!b)return c;m&&(b=b.parentNode),a=a.slice(i.shift().value.length)}f=V.needsContext.test(a)?0:i.length;while(f--){if(j=i[f],d.relative[k=j.type])break;if((l=d.find[k])&&(e=l(j.matches[0].replace(_,aa),$.test(i[0].type)&&qa(b.parentNode)||b))){if(i.splice(f,1),a=e.length&&sa(i),!a)return G.apply(c,e),c;break}}}return(m||h(a,n))(e,b,!p,c,!b||$.test(a)&&qa(b.parentNode)||b),c},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ja(function(a){return 1&a.compareDocumentPosition(n.createElement("fieldset"))}),ja(function(a){return a.innerHTML="<a href='#'></a>","#"===a.firstChild.getAttribute("href")})||ka("type|href|height|width",function(a,b,c){if(!c)return a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ja(function(a){return a.innerHTML="<input/>",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||ka("value",function(a,b,c){if(!c&&"input"===a.nodeName.toLowerCase())return a.defaultValue}),ja(function(a){return null==a.getAttribute("disabled")})||ka(J,function(a,b,c){var d;if(!c)return a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),ga}(a);r.find=x,r.expr=x.selectors,r.expr[":"]=r.expr.pseudos,r.uniqueSort=r.unique=x.uniqueSort,r.text=x.getText,r.isXMLDoc=x.isXML,r.contains=x.contains,r.escapeSelector=x.escape;var y=function(a,b,c){var d=[],e=void 0!==c;while((a=a[b])&&9!==a.nodeType)if(1===a.nodeType){if(e&&r(a).is(c))break;d.push(a)}return d},z=function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c},A=r.expr.match.needsContext;function B(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()}var C=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i,D=/^.[^:#\[\.,]*$/;function E(a,b,c){return r.isFunction(b)?r.grep(a,function(a,d){return!!b.call(a,d,a)!==c}):b.nodeType?r.grep(a,function(a){return a===b!==c}):"string"!=typeof b?r.grep(a,function(a){return i.call(b,a)>-1!==c}):D.test(b)?r.filter(b,a,c):(b=r.filter(b,a),r.grep(a,function(a){return i.call(b,a)>-1!==c&&1===a.nodeType}))}r.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?r.find.matchesSelector(d,a)?[d]:[]:r.find.matches(a,r.grep(b,function(a){return 1===a.nodeType}))},r.fn.extend({find:function(a){var b,c,d=this.length,e=this;if("string"!=typeof a)return this.pushStack(r(a).filter(function(){for(b=0;b<d;b++)if(r.contains(e[b],this))return!0}));for(c=this.pushStack([]),b=0;b<d;b++)r.find(a,e[b],c);return d>1?r.uniqueSort(c):c},filter:function(a){return this.pushStack(E(this,a||[],!1))},not:function(a){return this.pushStack(E(this,a||[],!0))},is:function(a){return!!E(this,"string"==typeof a&&A.test(a)?r(a):a||[],!1).length}});var F,G=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,H=r.fn.init=function(a,b,c){var e,f;if(!a)return this;if(c=c||F,"string"==typeof a){if(e="<"===a[0]&&">"===a[a.length-1]&&a.length>=3?[null,a,null]:G.exec(a),!e||!e[1]&&b)return!b||b.jquery?(b||c).find(a):this.constructor(b).find(a);if(e[1]){if(b=b instanceof r?b[0]:b,r.merge(this,r.parseHTML(e[1],b&&b.nodeType?b.ownerDocument||b:d,!0)),C.test(e[1])&&r.isPlainObject(b))for(e in b)r.isFunction(this[e])?this[e](b[e]):this.attr(e,b[e]);return this}return f=d.getElementById(e[2]),f&&(this[0]=f,this.length=1),this}return a.nodeType?(this[0]=a,this.length=1,this):r.isFunction(a)?void 0!==c.ready?c.ready(a):a(r):r.makeArray(a,this)};H.prototype=r.fn,F=r(d);var I=/^(?:parents|prev(?:Until|All))/,J={children:!0,contents:!0,next:!0,prev:!0};r.fn.extend({has:function(a){var b=r(a,this),c=b.length;return this.filter(function(){for(var a=0;a<c;a++)if(r.contains(this,b[a]))return!0})},closest:function(a,b){var c,d=0,e=this.length,f=[],g="string"!=typeof a&&r(a);if(!A.test(a))for(;d<e;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&r.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?r.uniqueSort(f):f)},index:function(a){return a?"string"==typeof a?i.call(r(a),this[0]):i.call(this,a.jquery?a[0]:a):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(r.uniqueSort(r.merge(this.get(),r(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function K(a,b){while((a=a[b])&&1!==a.nodeType);return a}r.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return y(a,"parentNode")},parentsUntil:function(a,b,c){return y(a,"parentNode",c)},next:function(a){return K(a,"nextSibling")},prev:function(a){return K(a,"previousSibling")},nextAll:function(a){return y(a,"nextSibling")},prevAll:function(a){return y(a,"previousSibling")},nextUntil:function(a,b,c){return y(a,"nextSibling",c)},prevUntil:function(a,b,c){return y(a,"previousSibling",c)},siblings:function(a){return z((a.parentNode||{}).firstChild,a)},children:function(a){return z(a.firstChild)},contents:function(a){return B(a,"iframe")?a.contentDocument:(B(a,"template")&&(a=a.content||a),r.merge([],a.childNodes))}},function(a,b){r.fn[a]=function(c,d){var e=r.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=r.filter(d,e)),this.length>1&&(J[a]||r.uniqueSort(e),I.test(a)&&e.reverse()),this.pushStack(e)}});var L=/[^\x20\t\r\n\f]+/g;function M(a){var b={};return r.each(a.match(L)||[],function(a,c){b[c]=!0}),b}r.Callbacks=function(a){a="string"==typeof a?M(a):r.extend({},a);var b,c,d,e,f=[],g=[],h=-1,i=function(){for(e=e||a.once,d=b=!0;g.length;h=-1){c=g.shift();while(++h<f.length)f[h].apply(c[0],c[1])===!1&&a.stopOnFalse&&(h=f.length,c=!1)}a.memory||(c=!1),b=!1,e&&(f=c?[]:"")},j={add:function(){return f&&(c&&!b&&(h=f.length-1,g.push(c)),function d(b){r.each(b,function(b,c){r.isFunction(c)?a.unique&&j.has(c)||f.push(c):c&&c.length&&"string"!==r.type(c)&&d(c)})}(arguments),c&&!b&&i()),this},remove:function(){return r.each(arguments,function(a,b){var c;while((c=r.inArray(b,f,c))>-1)f.splice(c,1),c<=h&&h--}),this},has:function(a){return a?r.inArray(a,f)>-1:f.length>0},empty:function(){return f&&(f=[]),this},disable:function(){return e=g=[],f=c="",this},disabled:function(){return!f},lock:function(){return e=g=[],c||b||(f=c=""),this},locked:function(){return!!e},fireWith:function(a,c){return e||(c=c||[],c=[a,c.slice?c.slice():c],g.push(c),b||i()),this},fire:function(){return j.fireWith(this,arguments),this},fired:function(){return!!d}};return j};function N(a){return a}function O(a){throw a}function P(a,b,c,d){var e;try{a&&r.isFunction(e=a.promise)?e.call(a).done(b).fail(c):a&&r.isFunction(e=a.then)?e.call(a,b,c):b.apply(void 0,[a].slice(d))}catch(a){c.apply(void 0,[a])}}r.extend({Deferred:function(b){var c=[["notify","progress",r.Callbacks("memory"),r.Callbacks("memory"),2],["resolve","done",r.Callbacks("once memory"),r.Callbacks("once memory"),0,"resolved"],["reject","fail",r.Callbacks("once memory"),r.Callbacks("once memory"),1,"rejected"]],d="pending",e={state:function(){return d},always:function(){return f.done(arguments).fail(arguments),this},"catch":function(a){return e.then(null,a)},pipe:function(){var a=arguments;return r.Deferred(function(b){r.each(c,function(c,d){var e=r.isFunction(a[d[4]])&&a[d[4]];f[d[1]](function(){var a=e&&e.apply(this,arguments);a&&r.isFunction(a.promise)?a.promise().progress(b.notify).done(b.resolve).fail(b.reject):b[d[0]+"With"](this,e?[a]:arguments)})}),a=null}).promise()},then:function(b,d,e){var f=0;function g(b,c,d,e){return function(){var h=this,i=arguments,j=function(){var a,j;if(!(b<f)){if(a=d.apply(h,i),a===c.promise())throw new TypeError("Thenable self-resolution");j=a&&("object"==typeof a||"function"==typeof a)&&a.then,r.isFunction(j)?e?j.call(a,g(f,c,N,e),g(f,c,O,e)):(f++,j.call(a,g(f,c,N,e),g(f,c,O,e),g(f,c,N,c.notifyWith))):(d!==N&&(h=void 0,i=[a]),(e||c.resolveWith)(h,i))}},k=e?j:function(){try{j()}catch(a){r.Deferred.exceptionHook&&r.Deferred.exceptionHook(a,k.stackTrace),b+1>=f&&(d!==O&&(h=void 0,i=[a]),c.rejectWith(h,i))}};b?k():(r.Deferred.getStackHook&&(k.stackTrace=r.Deferred.getStackHook()),a.setTimeout(k))}}return r.Deferred(function(a){c[0][3].add(g(0,a,r.isFunction(e)?e:N,a.notifyWith)),c[1][3].add(g(0,a,r.isFunction(b)?b:N)),c[2][3].add(g(0,a,r.isFunction(d)?d:O))}).promise()},promise:function(a){return null!=a?r.extend(a,e):e}},f={};return r.each(c,function(a,b){var g=b[2],h=b[5];e[b[1]]=g.add,h&&g.add(function(){d=h},c[3-a][2].disable,c[0][2].lock),g.add(b[3].fire),f[b[0]]=function(){return f[b[0]+"With"](this===f?void 0:this,arguments),this},f[b[0]+"With"]=g.fireWith}),e.promise(f),b&&b.call(f,f),f},when:function(a){var b=arguments.length,c=b,d=Array(c),e=f.call(arguments),g=r.Deferred(),h=function(a){return function(c){d[a]=this,e[a]=arguments.length>1?f.call(arguments):c,--b||g.resolveWith(d,e)}};if(b<=1&&(P(a,g.done(h(c)).resolve,g.reject,!b),"pending"===g.state()||r.isFunction(e[c]&&e[c].then)))return g.then();while(c--)P(e[c],h(c),g.reject);return g.promise()}});var Q=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;r.Deferred.exceptionHook=function(b,c){a.console&&a.console.warn&&b&&Q.test(b.name)&&a.console.warn("jQuery.Deferred exception: "+b.message,b.stack,c)},r.readyException=function(b){a.setTimeout(function(){throw b})};var R=r.Deferred();r.fn.ready=function(a){return R.then(a)["catch"](function(a){r.readyException(a)}),this},r.extend({isReady:!1,readyWait:1,ready:function(a){(a===!0?--r.readyWait:r.isReady)||(r.isReady=!0,a!==!0&&--r.readyWait>0||R.resolveWith(d,[r]))}}),r.ready.then=R.then;function S(){d.removeEventListener("DOMContentLoaded",S),
+a.removeEventListener("load",S),r.ready()}"complete"===d.readyState||"loading"!==d.readyState&&!d.documentElement.doScroll?a.setTimeout(r.ready):(d.addEventListener("DOMContentLoaded",S),a.addEventListener("load",S));var T=function(a,b,c,d,e,f,g){var h=0,i=a.length,j=null==c;if("object"===r.type(c)){e=!0;for(h in c)T(a,b,h,c[h],!0,f,g)}else if(void 0!==d&&(e=!0,r.isFunction(d)||(g=!0),j&&(g?(b.call(a,d),b=null):(j=b,b=function(a,b,c){return j.call(r(a),c)})),b))for(;h<i;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},U=function(a){return 1===a.nodeType||9===a.nodeType||!+a.nodeType};function V(){this.expando=r.expando+V.uid++}V.uid=1,V.prototype={cache:function(a){var b=a[this.expando];return b||(b={},U(a)&&(a.nodeType?a[this.expando]=b:Object.defineProperty(a,this.expando,{value:b,configurable:!0}))),b},set:function(a,b,c){var d,e=this.cache(a);if("string"==typeof b)e[r.camelCase(b)]=c;else for(d in b)e[r.camelCase(d)]=b[d];return e},get:function(a,b){return void 0===b?this.cache(a):a[this.expando]&&a[this.expando][r.camelCase(b)]},access:function(a,b,c){return void 0===b||b&&"string"==typeof b&&void 0===c?this.get(a,b):(this.set(a,b,c),void 0!==c?c:b)},remove:function(a,b){var c,d=a[this.expando];if(void 0!==d){if(void 0!==b){Array.isArray(b)?b=b.map(r.camelCase):(b=r.camelCase(b),b=b in d?[b]:b.match(L)||[]),c=b.length;while(c--)delete d[b[c]]}(void 0===b||r.isEmptyObject(d))&&(a.nodeType?a[this.expando]=void 0:delete a[this.expando])}},hasData:function(a){var b=a[this.expando];return void 0!==b&&!r.isEmptyObject(b)}};var W=new V,X=new V,Y=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,Z=/[A-Z]/g;function $(a){return"true"===a||"false"!==a&&("null"===a?null:a===+a+""?+a:Y.test(a)?JSON.parse(a):a)}function _(a,b,c){var d;if(void 0===c&&1===a.nodeType)if(d="data-"+b.replace(Z,"-$&").toLowerCase(),c=a.getAttribute(d),"string"==typeof c){try{c=$(c)}catch(e){}X.set(a,b,c)}else c=void 0;return c}r.extend({hasData:function(a){return X.hasData(a)||W.hasData(a)},data:function(a,b,c){return X.access(a,b,c)},removeData:function(a,b){X.remove(a,b)},_data:function(a,b,c){return W.access(a,b,c)},_removeData:function(a,b){W.remove(a,b)}}),r.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=X.get(f),1===f.nodeType&&!W.get(f,"hasDataAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=r.camelCase(d.slice(5)),_(f,d,e[d])));W.set(f,"hasDataAttrs",!0)}return e}return"object"==typeof a?this.each(function(){X.set(this,a)}):T(this,function(b){var c;if(f&&void 0===b){if(c=X.get(f,a),void 0!==c)return c;if(c=_(f,a),void 0!==c)return c}else this.each(function(){X.set(this,a,b)})},null,b,arguments.length>1,null,!0)},removeData:function(a){return this.each(function(){X.remove(this,a)})}}),r.extend({queue:function(a,b,c){var d;if(a)return b=(b||"fx")+"queue",d=W.get(a,b),c&&(!d||Array.isArray(c)?d=W.access(a,b,r.makeArray(c)):d.push(c)),d||[]},dequeue:function(a,b){b=b||"fx";var c=r.queue(a,b),d=c.length,e=c.shift(),f=r._queueHooks(a,b),g=function(){r.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return W.get(a,c)||W.access(a,c,{empty:r.Callbacks("once memory").add(function(){W.remove(a,[b+"queue",c])})})}}),r.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.length<c?r.queue(this[0],a):void 0===b?this:this.each(function(){var c=r.queue(this,a,b);r._queueHooks(this,a),"fx"===a&&"inprogress"!==c[0]&&r.dequeue(this,a)})},dequeue:function(a){return this.each(function(){r.dequeue(this,a)})},clearQueue:function(a){return this.queue(a||"fx",[])},promise:function(a,b){var c,d=1,e=r.Deferred(),f=this,g=this.length,h=function(){--d||e.resolveWith(f,[f])};"string"!=typeof a&&(b=a,a=void 0),a=a||"fx";while(g--)c=W.get(f[g],a+"queueHooks"),c&&c.empty&&(d++,c.empty.add(h));return h(),e.promise(b)}});var aa=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,ba=new RegExp("^(?:([+-])=|)("+aa+")([a-z%]*)$","i"),ca=["Top","Right","Bottom","Left"],da=function(a,b){return a=b||a,"none"===a.style.display||""===a.style.display&&r.contains(a.ownerDocument,a)&&"none"===r.css(a,"display")},ea=function(a,b,c,d){var e,f,g={};for(f in b)g[f]=a.style[f],a.style[f]=b[f];e=c.apply(a,d||[]);for(f in b)a.style[f]=g[f];return e};function fa(a,b,c,d){var e,f=1,g=20,h=d?function(){return d.cur()}:function(){return r.css(a,b,"")},i=h(),j=c&&c[3]||(r.cssNumber[b]?"":"px"),k=(r.cssNumber[b]||"px"!==j&&+i)&&ba.exec(r.css(a,b));if(k&&k[3]!==j){j=j||k[3],c=c||[],k=+i||1;do f=f||".5",k/=f,r.style(a,b,k+j);while(f!==(f=h()/i)&&1!==f&&--g)}return c&&(k=+k||+i||0,e=c[1]?k+(c[1]+1)*c[2]:+c[2],d&&(d.unit=j,d.start=k,d.end=e)),e}var ga={};function ha(a){var b,c=a.ownerDocument,d=a.nodeName,e=ga[d];return e?e:(b=c.body.appendChild(c.createElement(d)),e=r.css(b,"display"),b.parentNode.removeChild(b),"none"===e&&(e="block"),ga[d]=e,e)}function ia(a,b){for(var c,d,e=[],f=0,g=a.length;f<g;f++)d=a[f],d.style&&(c=d.style.display,b?("none"===c&&(e[f]=W.get(d,"display")||null,e[f]||(d.style.display="")),""===d.style.display&&da(d)&&(e[f]=ha(d))):"none"!==c&&(e[f]="none",W.set(d,"display",c)));for(f=0;f<g;f++)null!=e[f]&&(a[f].style.display=e[f]);return a}r.fn.extend({show:function(){return ia(this,!0)},hide:function(){return ia(this)},toggle:function(a){return"boolean"==typeof a?a?this.show():this.hide():this.each(function(){da(this)?r(this).show():r(this).hide()})}});var ja=/^(?:checkbox|radio)$/i,ka=/<([a-z][^\/\0>\x20\t\r\n\f]+)/i,la=/^$|\/(?:java|ecma)script/i,ma={option:[1,"<select multiple='multiple'>","</select>"],thead:[1,"<table>","</table>"],col:[2,"<table><colgroup>","</colgroup></table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:[0,"",""]};ma.optgroup=ma.option,ma.tbody=ma.tfoot=ma.colgroup=ma.caption=ma.thead,ma.th=ma.td;function na(a,b){var c;return c="undefined"!=typeof a.getElementsByTagName?a.getElementsByTagName(b||"*"):"undefined"!=typeof a.querySelectorAll?a.querySelectorAll(b||"*"):[],void 0===b||b&&B(a,b)?r.merge([a],c):c}function oa(a,b){for(var c=0,d=a.length;c<d;c++)W.set(a[c],"globalEval",!b||W.get(b[c],"globalEval"))}var pa=/<|&#?\w+;/;function qa(a,b,c,d,e){for(var f,g,h,i,j,k,l=b.createDocumentFragment(),m=[],n=0,o=a.length;n<o;n++)if(f=a[n],f||0===f)if("object"===r.type(f))r.merge(m,f.nodeType?[f]:f);else if(pa.test(f)){g=g||l.appendChild(b.createElement("div")),h=(ka.exec(f)||["",""])[1].toLowerCase(),i=ma[h]||ma._default,g.innerHTML=i[1]+r.htmlPrefilter(f)+i[2],k=i[0];while(k--)g=g.lastChild;r.merge(m,g.childNodes),g=l.firstChild,g.textContent=""}else m.push(b.createTextNode(f));l.textContent="",n=0;while(f=m[n++])if(d&&r.inArray(f,d)>-1)e&&e.push(f);else if(j=r.contains(f.ownerDocument,f),g=na(l.appendChild(f),"script"),j&&oa(g),c){k=0;while(f=g[k++])la.test(f.type||"")&&c.push(f)}return l}!function(){var a=d.createDocumentFragment(),b=a.appendChild(d.createElement("div")),c=d.createElement("input");c.setAttribute("type","radio"),c.setAttribute("checked","checked"),c.setAttribute("name","t"),b.appendChild(c),o.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,b.innerHTML="<textarea>x</textarea>",o.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue}();var ra=d.documentElement,sa=/^key/,ta=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,ua=/^([^.]*)(?:\.(.+)|)/;function va(){return!0}function wa(){return!1}function xa(){try{return d.activeElement}catch(a){}}function ya(a,b,c,d,e,f){var g,h;if("object"==typeof b){"string"!=typeof c&&(d=d||c,c=void 0);for(h in b)ya(a,h,c,d,b[h],f);return a}if(null==d&&null==e?(e=c,d=c=void 0):null==e&&("string"==typeof c?(e=d,d=void 0):(e=d,d=c,c=void 0)),e===!1)e=wa;else if(!e)return a;return 1===f&&(g=e,e=function(a){return r().off(a),g.apply(this,arguments)},e.guid=g.guid||(g.guid=r.guid++)),a.each(function(){r.event.add(this,b,e,d,c)})}r.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=W.get(a);if(q){c.handler&&(f=c,c=f.handler,e=f.selector),e&&r.find.matchesSelector(ra,e),c.guid||(c.guid=r.guid++),(i=q.events)||(i=q.events={}),(g=q.handle)||(g=q.handle=function(b){return"undefined"!=typeof r&&r.event.triggered!==b.type?r.event.dispatch.apply(a,arguments):void 0}),b=(b||"").match(L)||[""],j=b.length;while(j--)h=ua.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n&&(l=r.event.special[n]||{},n=(e?l.delegateType:l.bindType)||n,l=r.event.special[n]||{},k=r.extend({type:n,origType:p,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&r.expr.match.needsContext.test(e),namespace:o.join(".")},f),(m=i[n])||(m=i[n]=[],m.delegateCount=0,l.setup&&l.setup.call(a,d,o,g)!==!1||a.addEventListener&&a.addEventListener(n,g)),l.add&&(l.add.call(a,k),k.handler.guid||(k.handler.guid=c.guid)),e?m.splice(m.delegateCount++,0,k):m.push(k),r.event.global[n]=!0)}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=W.hasData(a)&&W.get(a);if(q&&(i=q.events)){b=(b||"").match(L)||[""],j=b.length;while(j--)if(h=ua.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n){l=r.event.special[n]||{},n=(d?l.delegateType:l.bindType)||n,m=i[n]||[],h=h[2]&&new RegExp("(^|\\.)"+o.join("\\.(?:.*\\.|)")+"(\\.|$)"),g=f=m.length;while(f--)k=m[f],!e&&p!==k.origType||c&&c.guid!==k.guid||h&&!h.test(k.namespace)||d&&d!==k.selector&&("**"!==d||!k.selector)||(m.splice(f,1),k.selector&&m.delegateCount--,l.remove&&l.remove.call(a,k));g&&!m.length&&(l.teardown&&l.teardown.call(a,o,q.handle)!==!1||r.removeEvent(a,n,q.handle),delete i[n])}else for(n in i)r.event.remove(a,n+b[j],c,d,!0);r.isEmptyObject(i)&&W.remove(a,"handle events")}},dispatch:function(a){var b=r.event.fix(a),c,d,e,f,g,h,i=new Array(arguments.length),j=(W.get(this,"events")||{})[b.type]||[],k=r.event.special[b.type]||{};for(i[0]=b,c=1;c<arguments.length;c++)i[c]=arguments[c];if(b.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,b)!==!1){h=r.event.handlers.call(this,b,j),c=0;while((f=h[c++])&&!b.isPropagationStopped()){b.currentTarget=f.elem,d=0;while((g=f.handlers[d++])&&!b.isImmediatePropagationStopped())b.rnamespace&&!b.rnamespace.test(g.namespace)||(b.handleObj=g,b.data=g.data,e=((r.event.special[g.origType]||{}).handle||g.handler).apply(f.elem,i),void 0!==e&&(b.result=e)===!1&&(b.preventDefault(),b.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,b),b.result}},handlers:function(a,b){var c,d,e,f,g,h=[],i=b.delegateCount,j=a.target;if(i&&j.nodeType&&!("click"===a.type&&a.button>=1))for(;j!==this;j=j.parentNode||this)if(1===j.nodeType&&("click"!==a.type||j.disabled!==!0)){for(f=[],g={},c=0;c<i;c++)d=b[c],e=d.selector+" ",void 0===g[e]&&(g[e]=d.needsContext?r(e,this).index(j)>-1:r.find(e,this,null,[j]).length),g[e]&&f.push(d);f.length&&h.push({elem:j,handlers:f})}return j=this,i<b.length&&h.push({elem:j,handlers:b.slice(i)}),h},addProp:function(a,b){Object.defineProperty(r.Event.prototype,a,{enumerable:!0,configurable:!0,get:r.isFunction(b)?function(){if(this.originalEvent)return b(this.originalEvent)}:function(){if(this.originalEvent)return this.originalEvent[a]},set:function(b){Object.defineProperty(this,a,{enumerable:!0,configurable:!0,writable:!0,value:b})}})},fix:function(a){return a[r.expando]?a:new r.Event(a)},special:{load:{noBubble:!0},focus:{trigger:function(){if(this!==xa()&&this.focus)return this.focus(),!1},delegateType:"focusin"},blur:{trigger:function(){if(this===xa()&&this.blur)return this.blur(),!1},delegateType:"focusout"},click:{trigger:function(){if("checkbox"===this.type&&this.click&&B(this,"input"))return this.click(),!1},_default:function(a){return B(a.target,"a")}},beforeunload:{postDispatch:function(a){void 0!==a.result&&a.originalEvent&&(a.originalEvent.returnValue=a.result)}}}},r.removeEvent=function(a,b,c){a.removeEventListener&&a.removeEventListener(b,c)},r.Event=function(a,b){return this instanceof r.Event?(a&&a.type?(this.originalEvent=a,this.type=a.type,this.isDefaultPrevented=a.defaultPrevented||void 0===a.defaultPrevented&&a.returnValue===!1?va:wa,this.target=a.target&&3===a.target.nodeType?a.target.parentNode:a.target,this.currentTarget=a.currentTarget,this.relatedTarget=a.relatedTarget):this.type=a,b&&r.extend(this,b),this.timeStamp=a&&a.timeStamp||r.now(),void(this[r.expando]=!0)):new r.Event(a,b)},r.Event.prototype={constructor:r.Event,isDefaultPrevented:wa,isPropagationStopped:wa,isImmediatePropagationStopped:wa,isSimulated:!1,preventDefault:function(){var a=this.originalEvent;this.isDefaultPrevented=va,a&&!this.isSimulated&&a.preventDefault()},stopPropagation:function(){var a=this.originalEvent;this.isPropagationStopped=va,a&&!this.isSimulated&&a.stopPropagation()},stopImmediatePropagation:function(){var a=this.originalEvent;this.isImmediatePropagationStopped=va,a&&!this.isSimulated&&a.stopImmediatePropagation(),this.stopPropagation()}},r.each({altKey:!0,bubbles:!0,cancelable:!0,changedTouches:!0,ctrlKey:!0,detail:!0,eventPhase:!0,metaKey:!0,pageX:!0,pageY:!0,shiftKey:!0,view:!0,"char":!0,charCode:!0,key:!0,keyCode:!0,button:!0,buttons:!0,clientX:!0,clientY:!0,offsetX:!0,offsetY:!0,pointerId:!0,pointerType:!0,screenX:!0,screenY:!0,targetTouches:!0,toElement:!0,touches:!0,which:function(a){var b=a.button;return null==a.which&&sa.test(a.type)?null!=a.charCode?a.charCode:a.keyCode:!a.which&&void 0!==b&&ta.test(a.type)?1&b?1:2&b?3:4&b?2:0:a.which}},r.event.addProp),r.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(a,b){r.event.special[a]={delegateType:b,bindType:b,handle:function(a){var c,d=this,e=a.relatedTarget,f=a.handleObj;return e&&(e===d||r.contains(d,e))||(a.type=f.origType,c=f.handler.apply(this,arguments),a.type=b),c}}}),r.fn.extend({on:function(a,b,c,d){return ya(this,a,b,c,d)},one:function(a,b,c,d){return ya(this,a,b,c,d,1)},off:function(a,b,c){var d,e;if(a&&a.preventDefault&&a.handleObj)return d=a.handleObj,r(a.delegateTarget).off(d.namespace?d.origType+"."+d.namespace:d.origType,d.selector,d.handler),this;if("object"==typeof a){for(e in a)this.off(e,b,a[e]);return this}return b!==!1&&"function"!=typeof b||(c=b,b=void 0),c===!1&&(c=wa),this.each(function(){r.event.remove(this,a,c,b)})}});var za=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi,Aa=/<script|<style|<link/i,Ba=/checked\s*(?:[^=]|=\s*.checked.)/i,Ca=/^true\/(.*)/,Da=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;function Ea(a,b){return B(a,"table")&&B(11!==b.nodeType?b:b.firstChild,"tr")?r(">tbody",a)[0]||a:a}function Fa(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function Ga(a){var b=Ca.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function Ha(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(W.hasData(a)&&(f=W.access(a),g=W.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;c<d;c++)r.event.add(b,e,j[e][c])}X.hasData(a)&&(h=X.access(a),i=r.extend({},h),X.set(b,i))}}function Ia(a,b){var c=b.nodeName.toLowerCase();"input"===c&&ja.test(a.type)?b.checked=a.checked:"input"!==c&&"textarea"!==c||(b.defaultValue=a.defaultValue)}function Ja(a,b,c,d){b=g.apply([],b);var e,f,h,i,j,k,l=0,m=a.length,n=m-1,q=b[0],s=r.isFunction(q);if(s||m>1&&"string"==typeof q&&!o.checkClone&&Ba.test(q))return a.each(function(e){var f=a.eq(e);s&&(b[0]=q.call(this,e,f.html())),Ja(f,b,c,d)});if(m&&(e=qa(b,a[0].ownerDocument,!1,a,d),f=e.firstChild,1===e.childNodes.length&&(e=f),f||d)){for(h=r.map(na(e,"script"),Fa),i=h.length;l<m;l++)j=e,l!==n&&(j=r.clone(j,!0,!0),i&&r.merge(h,na(j,"script"))),c.call(a[l],j,l);if(i)for(k=h[h.length-1].ownerDocument,r.map(h,Ga),l=0;l<i;l++)j=h[l],la.test(j.type||"")&&!W.access(j,"globalEval")&&r.contains(k,j)&&(j.src?r._evalUrl&&r._evalUrl(j.src):p(j.textContent.replace(Da,""),k))}return a}function Ka(a,b,c){for(var d,e=b?r.filter(b,a):a,f=0;null!=(d=e[f]);f++)c||1!==d.nodeType||r.cleanData(na(d)),d.parentNode&&(c&&r.contains(d.ownerDocument,d)&&oa(na(d,"script")),d.parentNode.removeChild(d));return a}r.extend({htmlPrefilter:function(a){return a.replace(za,"<$1></$2>")},clone:function(a,b,c){var d,e,f,g,h=a.cloneNode(!0),i=r.contains(a.ownerDocument,a);if(!(o.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||r.isXMLDoc(a)))for(g=na(h),f=na(a),d=0,e=f.length;d<e;d++)Ia(f[d],g[d]);if(b)if(c)for(f=f||na(a),g=g||na(h),d=0,e=f.length;d<e;d++)Ha(f[d],g[d]);else Ha(a,h);return g=na(h,"script"),g.length>0&&oa(g,!i&&na(a,"script")),h},cleanData:function(a){for(var b,c,d,e=r.event.special,f=0;void 0!==(c=a[f]);f++)if(U(c)){if(b=c[W.expando]){if(b.events)for(d in b.events)e[d]?r.event.remove(c,d):r.removeEvent(c,d,b.handle);c[W.expando]=void 0}c[X.expando]&&(c[X.expando]=void 0)}}}),r.fn.extend({detach:function(a){return Ka(this,a,!0)},remove:function(a){return Ka(this,a)},text:function(a){return T(this,function(a){return void 0===a?r.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=a)})},null,a,arguments.length)},append:function(){return Ja(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ea(this,a);b.appendChild(a)}})},prepend:function(){return Ja(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ea(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return Ja(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return Ja(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},empty:function(){for(var a,b=0;null!=(a=this[b]);b++)1===a.nodeType&&(r.cleanData(na(a,!1)),a.textContent="");return this},clone:function(a,b){return a=null!=a&&a,b=null==b?a:b,this.map(function(){return r.clone(this,a,b)})},html:function(a){return T(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a&&1===b.nodeType)return b.innerHTML;if("string"==typeof a&&!Aa.test(a)&&!ma[(ka.exec(a)||["",""])[1].toLowerCase()]){a=r.htmlPrefilter(a);try{for(;c<d;c++)b=this[c]||{},1===b.nodeType&&(r.cleanData(na(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=[];return Ja(this,arguments,function(b){var c=this.parentNode;r.inArray(this,a)<0&&(r.cleanData(na(this)),c&&c.replaceChild(b,this))},a)}}),r.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){r.fn[a]=function(a){for(var c,d=[],e=r(a),f=e.length-1,g=0;g<=f;g++)c=g===f?this:this.clone(!0),r(e[g])[b](c),h.apply(d,c.get());return this.pushStack(d)}});var La=/^margin/,Ma=new RegExp("^("+aa+")(?!px)[a-z%]+$","i"),Na=function(b){var c=b.ownerDocument.defaultView;return c&&c.opener||(c=a),c.getComputedStyle(b)};!function(){function b(){if(i){i.style.cssText="box-sizing:border-box;position:relative;display:block;margin:auto;border:1px;padding:1px;top:1%;width:50%",i.innerHTML="",ra.appendChild(h);var b=a.getComputedStyle(i);c="1%"!==b.top,g="2px"===b.marginLeft,e="4px"===b.width,i.style.marginRight="50%",f="4px"===b.marginRight,ra.removeChild(h),i=null}}var c,e,f,g,h=d.createElement("div"),i=d.createElement("div");i.style&&(i.style.backgroundClip="content-box",i.cloneNode(!0).style.backgroundClip="",o.clearCloneStyle="content-box"===i.style.backgroundClip,h.style.cssText="border:0;width:8px;height:0;top:0;left:-9999px;padding:0;margin-top:1px;position:absolute",h.appendChild(i),r.extend(o,{pixelPosition:function(){return b(),c},boxSizingReliable:function(){return b(),e},pixelMarginRight:function(){return b(),f},reliableMarginLeft:function(){return b(),g}}))}();function Oa(a,b,c){var d,e,f,g,h=a.style;return c=c||Na(a),c&&(g=c.getPropertyValue(b)||c[b],""!==g||r.contains(a.ownerDocument,a)||(g=r.style(a,b)),!o.pixelMarginRight()&&Ma.test(g)&&La.test(b)&&(d=h.width,e=h.minWidth,f=h.maxWidth,h.minWidth=h.maxWidth=h.width=g,g=c.width,h.width=d,h.minWidth=e,h.maxWidth=f)),void 0!==g?g+"":g}function Pa(a,b){return{get:function(){return a()?void delete this.get:(this.get=b).apply(this,arguments)}}}var Qa=/^(none|table(?!-c[ea]).+)/,Ra=/^--/,Sa={position:"absolute",visibility:"hidden",display:"block"},Ta={letterSpacing:"0",fontWeight:"400"},Ua=["Webkit","Moz","ms"],Va=d.createElement("div").style;function Wa(a){if(a in Va)return a;var b=a[0].toUpperCase()+a.slice(1),c=Ua.length;while(c--)if(a=Ua[c]+b,a in Va)return a}function Xa(a){var b=r.cssProps[a];return b||(b=r.cssProps[a]=Wa(a)||a),b}function Ya(a,b,c){var d=ba.exec(b);return d?Math.max(0,d[2]-(c||0))+(d[3]||"px"):b}function Za(a,b,c,d,e){var f,g=0;for(f=c===(d?"border":"content")?4:"width"===b?1:0;f<4;f+=2)"margin"===c&&(g+=r.css(a,c+ca[f],!0,e)),d?("content"===c&&(g-=r.css(a,"padding"+ca[f],!0,e)),"margin"!==c&&(g-=r.css(a,"border"+ca[f]+"Width",!0,e))):(g+=r.css(a,"padding"+ca[f],!0,e),"padding"!==c&&(g+=r.css(a,"border"+ca[f]+"Width",!0,e)));return g}function $a(a,b,c){var d,e=Na(a),f=Oa(a,b,e),g="border-box"===r.css(a,"boxSizing",!1,e);return Ma.test(f)?f:(d=g&&(o.boxSizingReliable()||f===a.style[b]),"auto"===f&&(f=a["offset"+b[0].toUpperCase()+b.slice(1)]),f=parseFloat(f)||0,f+Za(a,b,c||(g?"border":"content"),d,e)+"px")}r.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=Oa(a,"opacity");return""===c?"1":c}}}},cssNumber:{animationIterationCount:!0,columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":"cssFloat"},style:function(a,b,c,d){if(a&&3!==a.nodeType&&8!==a.nodeType&&a.style){var e,f,g,h=r.camelCase(b),i=Ra.test(b),j=a.style;return i||(b=Xa(h)),g=r.cssHooks[b]||r.cssHooks[h],void 0===c?g&&"get"in g&&void 0!==(e=g.get(a,!1,d))?e:j[b]:(f=typeof c,"string"===f&&(e=ba.exec(c))&&e[1]&&(c=fa(a,b,e),f="number"),null!=c&&c===c&&("number"===f&&(c+=e&&e[3]||(r.cssNumber[h]?"":"px")),o.clearCloneStyle||""!==c||0!==b.indexOf("background")||(j[b]="inherit"),g&&"set"in g&&void 0===(c=g.set(a,c,d))||(i?j.setProperty(b,c):j[b]=c)),void 0)}},css:function(a,b,c,d){var e,f,g,h=r.camelCase(b),i=Ra.test(b);return i||(b=Xa(h)),g=r.cssHooks[b]||r.cssHooks[h],g&&"get"in g&&(e=g.get(a,!0,c)),void 0===e&&(e=Oa(a,b,d)),"normal"===e&&b in Ta&&(e=Ta[b]),""===c||c?(f=parseFloat(e),c===!0||isFinite(f)?f||0:e):e}}),r.each(["height","width"],function(a,b){r.cssHooks[b]={get:function(a,c,d){if(c)return!Qa.test(r.css(a,"display"))||a.getClientRects().length&&a.getBoundingClientRect().width?$a(a,b,d):ea(a,Sa,function(){return $a(a,b,d)})},set:function(a,c,d){var e,f=d&&Na(a),g=d&&Za(a,b,d,"border-box"===r.css(a,"boxSizing",!1,f),f);return g&&(e=ba.exec(c))&&"px"!==(e[3]||"px")&&(a.style[b]=c,c=r.css(a,b)),Ya(a,c,g)}}}),r.cssHooks.marginLeft=Pa(o.reliableMarginLeft,function(a,b){if(b)return(parseFloat(Oa(a,"marginLeft"))||a.getBoundingClientRect().left-ea(a,{marginLeft:0},function(){return a.getBoundingClientRect().left}))+"px"}),r.each({margin:"",padding:"",border:"Width"},function(a,b){r.cssHooks[a+b]={expand:function(c){for(var d=0,e={},f="string"==typeof c?c.split(" "):[c];d<4;d++)e[a+ca[d]+b]=f[d]||f[d-2]||f[0];return e}},La.test(a)||(r.cssHooks[a+b].set=Ya)}),r.fn.extend({css:function(a,b){return T(this,function(a,b,c){var d,e,f={},g=0;if(Array.isArray(b)){for(d=Na(a),e=b.length;g<e;g++)f[b[g]]=r.css(a,b[g],!1,d);return f}return void 0!==c?r.style(a,b,c):r.css(a,b)},a,b,arguments.length>1)}});function _a(a,b,c,d,e){return new _a.prototype.init(a,b,c,d,e)}r.Tween=_a,_a.prototype={constructor:_a,init:function(a,b,c,d,e,f){this.elem=a,this.prop=c,this.easing=e||r.easing._default,this.options=b,this.start=this.now=this.cur(),this.end=d,this.unit=f||(r.cssNumber[c]?"":"px")},cur:function(){var a=_a.propHooks[this.prop];return a&&a.get?a.get(this):_a.propHooks._default.get(this)},run:function(a){var b,c=_a.propHooks[this.prop];return this.options.duration?this.pos=b=r.easing[this.easing](a,this.options.duration*a,0,1,this.options.duration):this.pos=b=a,this.now=(this.end-this.start)*b+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),c&&c.set?c.set(this):_a.propHooks._default.set(this),this}},_a.prototype.init.prototype=_a.prototype,_a.propHooks={_default:{get:function(a){var b;return 1!==a.elem.nodeType||null!=a.elem[a.prop]&&null==a.elem.style[a.prop]?a.elem[a.prop]:(b=r.css(a.elem,a.prop,""),b&&"auto"!==b?b:0)},set:function(a){r.fx.step[a.prop]?r.fx.step[a.prop](a):1!==a.elem.nodeType||null==a.elem.style[r.cssProps[a.prop]]&&!r.cssHooks[a.prop]?a.elem[a.prop]=a.now:r.style(a.elem,a.prop,a.now+a.unit)}}},_a.propHooks.scrollTop=_a.propHooks.scrollLeft={set:function(a){a.elem.nodeType&&a.elem.parentNode&&(a.elem[a.prop]=a.now)}},r.easing={linear:function(a){return a},swing:function(a){return.5-Math.cos(a*Math.PI)/2},_default:"swing"},r.fx=_a.prototype.init,r.fx.step={};var ab,bb,cb=/^(?:toggle|show|hide)$/,db=/queueHooks$/;function eb(){bb&&(d.hidden===!1&&a.requestAnimationFrame?a.requestAnimationFrame(eb):a.setTimeout(eb,r.fx.interval),r.fx.tick())}function fb(){return a.setTimeout(function(){ab=void 0}),ab=r.now()}function gb(a,b){var c,d=0,e={height:a};for(b=b?1:0;d<4;d+=2-b)c=ca[d],e["margin"+c]=e["padding"+c]=a;return b&&(e.opacity=e.width=a),e}function hb(a,b,c){for(var d,e=(kb.tweeners[b]||[]).concat(kb.tweeners["*"]),f=0,g=e.length;f<g;f++)if(d=e[f].call(c,b,a))return d}function ib(a,b,c){var d,e,f,g,h,i,j,k,l="width"in b||"height"in b,m=this,n={},o=a.style,p=a.nodeType&&da(a),q=W.get(a,"fxshow");c.queue||(g=r._queueHooks(a,"fx"),null==g.unqueued&&(g.unqueued=0,h=g.empty.fire,g.empty.fire=function(){g.unqueued||h()}),g.unqueued++,m.always(function(){m.always(function(){g.unqueued--,r.queue(a,"fx").length||g.empty.fire()})}));for(d in b)if(e=b[d],cb.test(e)){if(delete b[d],f=f||"toggle"===e,e===(p?"hide":"show")){if("show"!==e||!q||void 0===q[d])continue;p=!0}n[d]=q&&q[d]||r.style(a,d)}if(i=!r.isEmptyObject(b),i||!r.isEmptyObject(n)){l&&1===a.nodeType&&(c.overflow=[o.overflow,o.overflowX,o.overflowY],j=q&&q.display,null==j&&(j=W.get(a,"display")),k=r.css(a,"display"),"none"===k&&(j?k=j:(ia([a],!0),j=a.style.display||j,k=r.css(a,"display"),ia([a]))),("inline"===k||"inline-block"===k&&null!=j)&&"none"===r.css(a,"float")&&(i||(m.done(function(){o.display=j}),null==j&&(k=o.display,j="none"===k?"":k)),o.display="inline-block")),c.overflow&&(o.overflow="hidden",m.always(function(){o.overflow=c.overflow[0],o.overflowX=c.overflow[1],o.overflowY=c.overflow[2]})),i=!1;for(d in n)i||(q?"hidden"in q&&(p=q.hidden):q=W.access(a,"fxshow",{display:j}),f&&(q.hidden=!p),p&&ia([a],!0),m.done(function(){p||ia([a]),W.remove(a,"fxshow");for(d in n)r.style(a,d,n[d])})),i=hb(p?q[d]:0,d,m),d in q||(q[d]=i.start,p&&(i.end=i.start,i.start=0))}}function jb(a,b){var c,d,e,f,g;for(c in a)if(d=r.camelCase(c),e=b[d],f=a[c],Array.isArray(f)&&(e=f[1],f=a[c]=f[0]),c!==d&&(a[d]=f,delete a[c]),g=r.cssHooks[d],g&&"expand"in g){f=g.expand(f),delete a[d];for(c in f)c in a||(a[c]=f[c],b[c]=e)}else b[d]=e}function kb(a,b,c){var d,e,f=0,g=kb.prefilters.length,h=r.Deferred().always(function(){delete i.elem}),i=function(){if(e)return!1;for(var b=ab||fb(),c=Math.max(0,j.startTime+j.duration-b),d=c/j.duration||0,f=1-d,g=0,i=j.tweens.length;g<i;g++)j.tweens[g].run(f);return h.notifyWith(a,[j,f,c]),f<1&&i?c:(i||h.notifyWith(a,[j,1,0]),h.resolveWith(a,[j]),!1)},j=h.promise({elem:a,props:r.extend({},b),opts:r.extend(!0,{specialEasing:{},easing:r.easing._default},c),originalProperties:b,originalOptions:c,startTime:ab||fb(),duration:c.duration,tweens:[],createTween:function(b,c){var d=r.Tween(a,j.opts,b,c,j.opts.specialEasing[b]||j.opts.easing);return j.tweens.push(d),d},stop:function(b){var c=0,d=b?j.tweens.length:0;if(e)return this;for(e=!0;c<d;c++)j.tweens[c].run(1);return b?(h.notifyWith(a,[j,1,0]),h.resolveWith(a,[j,b])):h.rejectWith(a,[j,b]),this}}),k=j.props;for(jb(k,j.opts.specialEasing);f<g;f++)if(d=kb.prefilters[f].call(j,a,k,j.opts))return r.isFunction(d.stop)&&(r._queueHooks(j.elem,j.opts.queue).stop=r.proxy(d.stop,d)),d;return r.map(k,hb,j),r.isFunction(j.opts.start)&&j.opts.start.call(a,j),j.progress(j.opts.progress).done(j.opts.done,j.opts.complete).fail(j.opts.fail).always(j.opts.always),r.fx.timer(r.extend(i,{elem:a,anim:j,queue:j.opts.queue})),j}r.Animation=r.extend(kb,{tweeners:{"*":[function(a,b){var c=this.createTween(a,b);return fa(c.elem,a,ba.exec(b),c),c}]},tweener:function(a,b){r.isFunction(a)?(b=a,a=["*"]):a=a.match(L);for(var c,d=0,e=a.length;d<e;d++)c=a[d],kb.tweeners[c]=kb.tweeners[c]||[],kb.tweeners[c].unshift(b)},prefilters:[ib],prefilter:function(a,b){b?kb.prefilters.unshift(a):kb.prefilters.push(a)}}),r.speed=function(a,b,c){var d=a&&"object"==typeof a?r.extend({},a):{complete:c||!c&&b||r.isFunction(a)&&a,duration:a,easing:c&&b||b&&!r.isFunction(b)&&b};return r.fx.off?d.duration=0:"number"!=typeof d.duration&&(d.duration in r.fx.speeds?d.duration=r.fx.speeds[d.duration]:d.duration=r.fx.speeds._default),null!=d.queue&&d.queue!==!0||(d.queue="fx"),d.old=d.complete,d.complete=function(){r.isFunction(d.old)&&d.old.call(this),d.queue&&r.dequeue(this,d.queue)},d},r.fn.extend({fadeTo:function(a,b,c,d){return this.filter(da).css("opacity",0).show().end().animate({opacity:b},a,c,d)},animate:function(a,b,c,d){var e=r.isEmptyObject(a),f=r.speed(b,c,d),g=function(){var b=kb(this,r.extend({},a),f);(e||W.get(this,"finish"))&&b.stop(!0)};return g.finish=g,e||f.queue===!1?this.each(g):this.queue(f.queue,g)},stop:function(a,b,c){var d=function(a){var b=a.stop;delete a.stop,b(c)};return"string"!=typeof a&&(c=b,b=a,a=void 0),b&&a!==!1&&this.queue(a||"fx",[]),this.each(function(){var b=!0,e=null!=a&&a+"queueHooks",f=r.timers,g=W.get(this);if(e)g[e]&&g[e].stop&&d(g[e]);else for(e in g)g[e]&&g[e].stop&&db.test(e)&&d(g[e]);for(e=f.length;e--;)f[e].elem!==this||null!=a&&f[e].queue!==a||(f[e].anim.stop(c),b=!1,f.splice(e,1));!b&&c||r.dequeue(this,a)})},finish:function(a){return a!==!1&&(a=a||"fx"),this.each(function(){var b,c=W.get(this),d=c[a+"queue"],e=c[a+"queueHooks"],f=r.timers,g=d?d.length:0;for(c.finish=!0,r.queue(this,a,[]),e&&e.stop&&e.stop.call(this,!0),b=f.length;b--;)f[b].elem===this&&f[b].queue===a&&(f[b].anim.stop(!0),f.splice(b,1));for(b=0;b<g;b++)d[b]&&d[b].finish&&d[b].finish.call(this);delete c.finish})}}),r.each(["toggle","show","hide"],function(a,b){var c=r.fn[b];r.fn[b]=function(a,d,e){return null==a||"boolean"==typeof a?c.apply(this,arguments):this.animate(gb(b,!0),a,d,e)}}),r.each({slideDown:gb("show"),slideUp:gb("hide"),slideToggle:gb("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){r.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),r.timers=[],r.fx.tick=function(){var a,b=0,c=r.timers;for(ab=r.now();b<c.length;b++)a=c[b],a()||c[b]!==a||c.splice(b--,1);c.length||r.fx.stop(),ab=void 0},r.fx.timer=function(a){r.timers.push(a),r.fx.start()},r.fx.interval=13,r.fx.start=function(){bb||(bb=!0,eb())},r.fx.stop=function(){bb=null},r.fx.speeds={slow:600,fast:200,_default:400},r.fn.delay=function(b,c){return b=r.fx?r.fx.speeds[b]||b:b,c=c||"fx",this.queue(c,function(c,d){var e=a.setTimeout(c,b);d.stop=function(){a.clearTimeout(e)}})},function(){var a=d.createElement("input"),b=d.createElement("select"),c=b.appendChild(d.createElement("option"));a.type="checkbox",o.checkOn=""!==a.value,o.optSelected=c.selected,a=d.createElement("input"),a.value="t",a.type="radio",o.radioValue="t"===a.value}();var lb,mb=r.expr.attrHandle;r.fn.extend({attr:function(a,b){return T(this,r.attr,a,b,arguments.length>1)},removeAttr:function(a){return this.each(function(){r.removeAttr(this,a)})}}),r.extend({attr:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return"undefined"==typeof a.getAttribute?r.prop(a,b,c):(1===f&&r.isXMLDoc(a)||(e=r.attrHooks[b.toLowerCase()]||(r.expr.match.bool.test(b)?lb:void 0)),void 0!==c?null===c?void r.removeAttr(a,b):e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:(a.setAttribute(b,c+""),c):e&&"get"in e&&null!==(d=e.get(a,b))?d:(d=r.find.attr(a,b),
+null==d?void 0:d))},attrHooks:{type:{set:function(a,b){if(!o.radioValue&&"radio"===b&&B(a,"input")){var c=a.value;return a.setAttribute("type",b),c&&(a.value=c),b}}}},removeAttr:function(a,b){var c,d=0,e=b&&b.match(L);if(e&&1===a.nodeType)while(c=e[d++])a.removeAttribute(c)}}),lb={set:function(a,b,c){return b===!1?r.removeAttr(a,c):a.setAttribute(c,c),c}},r.each(r.expr.match.bool.source.match(/\w+/g),function(a,b){var c=mb[b]||r.find.attr;mb[b]=function(a,b,d){var e,f,g=b.toLowerCase();return d||(f=mb[g],mb[g]=e,e=null!=c(a,b,d)?g:null,mb[g]=f),e}});var nb=/^(?:input|select|textarea|button)$/i,ob=/^(?:a|area)$/i;r.fn.extend({prop:function(a,b){return T(this,r.prop,a,b,arguments.length>1)},removeProp:function(a){return this.each(function(){delete this[r.propFix[a]||a]})}}),r.extend({prop:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return 1===f&&r.isXMLDoc(a)||(b=r.propFix[b]||b,e=r.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){var b=r.find.attr(a,"tabindex");return b?parseInt(b,10):nb.test(a.nodeName)||ob.test(a.nodeName)&&a.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),o.optSelected||(r.propHooks.selected={get:function(a){var b=a.parentNode;return b&&b.parentNode&&b.parentNode.selectedIndex,null},set:function(a){var b=a.parentNode;b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex)}}),r.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){r.propFix[this.toLowerCase()]=this});function pb(a){var b=a.match(L)||[];return b.join(" ")}function qb(a){return a.getAttribute&&a.getAttribute("class")||""}r.fn.extend({addClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).addClass(a.call(this,b,qb(this)))});if("string"==typeof a&&a){b=a.match(L)||[];while(c=this[i++])if(e=qb(c),d=1===c.nodeType&&" "+pb(e)+" "){g=0;while(f=b[g++])d.indexOf(" "+f+" ")<0&&(d+=f+" ");h=pb(d),e!==h&&c.setAttribute("class",h)}}return this},removeClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).removeClass(a.call(this,b,qb(this)))});if(!arguments.length)return this.attr("class","");if("string"==typeof a&&a){b=a.match(L)||[];while(c=this[i++])if(e=qb(c),d=1===c.nodeType&&" "+pb(e)+" "){g=0;while(f=b[g++])while(d.indexOf(" "+f+" ")>-1)d=d.replace(" "+f+" "," ");h=pb(d),e!==h&&c.setAttribute("class",h)}}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):r.isFunction(a)?this.each(function(c){r(this).toggleClass(a.call(this,c,qb(this),b),b)}):this.each(function(){var b,d,e,f;if("string"===c){d=0,e=r(this),f=a.match(L)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else void 0!==a&&"boolean"!==c||(b=qb(this),b&&W.set(this,"__className__",b),this.setAttribute&&this.setAttribute("class",b||a===!1?"":W.get(this,"__className__")||""))})},hasClass:function(a){var b,c,d=0;b=" "+a+" ";while(c=this[d++])if(1===c.nodeType&&(" "+pb(qb(c))+" ").indexOf(b)>-1)return!0;return!1}});var rb=/\r/g;r.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=r.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,r(this).val()):a,null==e?e="":"number"==typeof e?e+="":Array.isArray(e)&&(e=r.map(e,function(a){return null==a?"":a+""})),b=r.valHooks[this.type]||r.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=r.valHooks[e.type]||r.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(rb,""):null==c?"":c)}}}),r.extend({valHooks:{option:{get:function(a){var b=r.find.attr(a,"value");return null!=b?b:pb(r.text(a))}},select:{get:function(a){var b,c,d,e=a.options,f=a.selectedIndex,g="select-one"===a.type,h=g?null:[],i=g?f+1:e.length;for(d=f<0?i:g?f:0;d<i;d++)if(c=e[d],(c.selected||d===f)&&!c.disabled&&(!c.parentNode.disabled||!B(c.parentNode,"optgroup"))){if(b=r(c).val(),g)return b;h.push(b)}return h},set:function(a,b){var c,d,e=a.options,f=r.makeArray(b),g=e.length;while(g--)d=e[g],(d.selected=r.inArray(r.valHooks.option.get(d),f)>-1)&&(c=!0);return c||(a.selectedIndex=-1),f}}}}),r.each(["radio","checkbox"],function(){r.valHooks[this]={set:function(a,b){if(Array.isArray(b))return a.checked=r.inArray(r(a).val(),b)>-1}},o.checkOn||(r.valHooks[this].get=function(a){return null===a.getAttribute("value")?"on":a.value})});var sb=/^(?:focusinfocus|focusoutblur)$/;r.extend(r.event,{trigger:function(b,c,e,f){var g,h,i,j,k,m,n,o=[e||d],p=l.call(b,"type")?b.type:b,q=l.call(b,"namespace")?b.namespace.split("."):[];if(h=i=e=e||d,3!==e.nodeType&&8!==e.nodeType&&!sb.test(p+r.event.triggered)&&(p.indexOf(".")>-1&&(q=p.split("."),p=q.shift(),q.sort()),k=p.indexOf(":")<0&&"on"+p,b=b[r.expando]?b:new r.Event(p,"object"==typeof b&&b),b.isTrigger=f?2:3,b.namespace=q.join("."),b.rnamespace=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=e),c=null==c?[b]:r.makeArray(c,[b]),n=r.event.special[p]||{},f||!n.trigger||n.trigger.apply(e,c)!==!1)){if(!f&&!n.noBubble&&!r.isWindow(e)){for(j=n.delegateType||p,sb.test(j+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),i=h;i===(e.ownerDocument||d)&&o.push(i.defaultView||i.parentWindow||a)}g=0;while((h=o[g++])&&!b.isPropagationStopped())b.type=g>1?j:n.bindType||p,m=(W.get(h,"events")||{})[b.type]&&W.get(h,"handle"),m&&m.apply(h,c),m=k&&h[k],m&&m.apply&&U(h)&&(b.result=m.apply(h,c),b.result===!1&&b.preventDefault());return b.type=p,f||b.isDefaultPrevented()||n._default&&n._default.apply(o.pop(),c)!==!1||!U(e)||k&&r.isFunction(e[p])&&!r.isWindow(e)&&(i=e[k],i&&(e[k]=null),r.event.triggered=p,e[p](),r.event.triggered=void 0,i&&(e[k]=i)),b.result}},simulate:function(a,b,c){var d=r.extend(new r.Event,c,{type:a,isSimulated:!0});r.event.trigger(d,null,b)}}),r.fn.extend({trigger:function(a,b){return this.each(function(){r.event.trigger(a,b,this)})},triggerHandler:function(a,b){var c=this[0];if(c)return r.event.trigger(a,b,c,!0)}}),r.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(a,b){r.fn[b]=function(a,c){return arguments.length>0?this.on(b,null,a,c):this.trigger(b)}}),r.fn.extend({hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)}}),o.focusin="onfocusin"in a,o.focusin||r.each({focus:"focusin",blur:"focusout"},function(a,b){var c=function(a){r.event.simulate(b,a.target,r.event.fix(a))};r.event.special[b]={setup:function(){var d=this.ownerDocument||this,e=W.access(d,b);e||d.addEventListener(a,c,!0),W.access(d,b,(e||0)+1)},teardown:function(){var d=this.ownerDocument||this,e=W.access(d,b)-1;e?W.access(d,b,e):(d.removeEventListener(a,c,!0),W.remove(d,b))}}});var tb=a.location,ub=r.now(),vb=/\?/;r.parseXML=function(b){var c;if(!b||"string"!=typeof b)return null;try{c=(new a.DOMParser).parseFromString(b,"text/xml")}catch(d){c=void 0}return c&&!c.getElementsByTagName("parsererror").length||r.error("Invalid XML: "+b),c};var wb=/\[\]$/,xb=/\r?\n/g,yb=/^(?:submit|button|image|reset|file)$/i,zb=/^(?:input|select|textarea|keygen)/i;function Ab(a,b,c,d){var e;if(Array.isArray(b))r.each(b,function(b,e){c||wb.test(a)?d(a,e):Ab(a+"["+("object"==typeof e&&null!=e?b:"")+"]",e,c,d)});else if(c||"object"!==r.type(b))d(a,b);else for(e in b)Ab(a+"["+e+"]",b[e],c,d)}r.param=function(a,b){var c,d=[],e=function(a,b){var c=r.isFunction(b)?b():b;d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(null==c?"":c)};if(Array.isArray(a)||a.jquery&&!r.isPlainObject(a))r.each(a,function(){e(this.name,this.value)});else for(c in a)Ab(c,a[c],b,e);return d.join("&")},r.fn.extend({serialize:function(){return r.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var a=r.prop(this,"elements");return a?r.makeArray(a):this}).filter(function(){var a=this.type;return this.name&&!r(this).is(":disabled")&&zb.test(this.nodeName)&&!yb.test(a)&&(this.checked||!ja.test(a))}).map(function(a,b){var c=r(this).val();return null==c?null:Array.isArray(c)?r.map(c,function(a){return{name:b.name,value:a.replace(xb,"\r\n")}}):{name:b.name,value:c.replace(xb,"\r\n")}}).get()}});var Bb=/%20/g,Cb=/#.*$/,Db=/([?&])_=[^&]*/,Eb=/^(.*?):[ \t]*([^\r\n]*)$/gm,Fb=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,Gb=/^(?:GET|HEAD)$/,Hb=/^\/\//,Ib={},Jb={},Kb="*/".concat("*"),Lb=d.createElement("a");Lb.href=tb.href;function Mb(a){return function(b,c){"string"!=typeof b&&(c=b,b="*");var d,e=0,f=b.toLowerCase().match(L)||[];if(r.isFunction(c))while(d=f[e++])"+"===d[0]?(d=d.slice(1)||"*",(a[d]=a[d]||[]).unshift(c)):(a[d]=a[d]||[]).push(c)}}function Nb(a,b,c,d){var e={},f=a===Jb;function g(h){var i;return e[h]=!0,r.each(a[h]||[],function(a,h){var j=h(b,c,d);return"string"!=typeof j||f||e[j]?f?!(i=j):void 0:(b.dataTypes.unshift(j),g(j),!1)}),i}return g(b.dataTypes[0])||!e["*"]&&g("*")}function Ob(a,b){var c,d,e=r.ajaxSettings.flatOptions||{};for(c in b)void 0!==b[c]&&((e[c]?a:d||(d={}))[c]=b[c]);return d&&r.extend(!0,a,d),a}function Pb(a,b,c){var d,e,f,g,h=a.contents,i=a.dataTypes;while("*"===i[0])i.shift(),void 0===d&&(d=a.mimeType||b.getResponseHeader("Content-Type"));if(d)for(e in h)if(h[e]&&h[e].test(d)){i.unshift(e);break}if(i[0]in c)f=i[0];else{for(e in c){if(!i[0]||a.converters[e+" "+i[0]]){f=e;break}g||(g=e)}f=f||g}if(f)return f!==i[0]&&i.unshift(f),c[f]}function Qb(a,b,c,d){var e,f,g,h,i,j={},k=a.dataTypes.slice();if(k[1])for(g in a.converters)j[g.toLowerCase()]=a.converters[g];f=k.shift();while(f)if(a.responseFields[f]&&(c[a.responseFields[f]]=b),!i&&d&&a.dataFilter&&(b=a.dataFilter(b,a.dataType)),i=f,f=k.shift())if("*"===f)f=i;else if("*"!==i&&i!==f){if(g=j[i+" "+f]||j["* "+f],!g)for(e in j)if(h=e.split(" "),h[1]===f&&(g=j[i+" "+h[0]]||j["* "+h[0]])){g===!0?g=j[e]:j[e]!==!0&&(f=h[0],k.unshift(h[1]));break}if(g!==!0)if(g&&a["throws"])b=g(b);else try{b=g(b)}catch(l){return{state:"parsererror",error:g?l:"No conversion from "+i+" to "+f}}}return{state:"success",data:b}}r.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:tb.href,type:"GET",isLocal:Fb.test(tb.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":Kb,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":r.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(a,b){return b?Ob(Ob(a,r.ajaxSettings),b):Ob(r.ajaxSettings,a)},ajaxPrefilter:Mb(Ib),ajaxTransport:Mb(Jb),ajax:function(b,c){"object"==typeof b&&(c=b,b=void 0),c=c||{};var e,f,g,h,i,j,k,l,m,n,o=r.ajaxSetup({},c),p=o.context||o,q=o.context&&(p.nodeType||p.jquery)?r(p):r.event,s=r.Deferred(),t=r.Callbacks("once memory"),u=o.statusCode||{},v={},w={},x="canceled",y={readyState:0,getResponseHeader:function(a){var b;if(k){if(!h){h={};while(b=Eb.exec(g))h[b[1].toLowerCase()]=b[2]}b=h[a.toLowerCase()]}return null==b?null:b},getAllResponseHeaders:function(){return k?g:null},setRequestHeader:function(a,b){return null==k&&(a=w[a.toLowerCase()]=w[a.toLowerCase()]||a,v[a]=b),this},overrideMimeType:function(a){return null==k&&(o.mimeType=a),this},statusCode:function(a){var b;if(a)if(k)y.always(a[y.status]);else for(b in a)u[b]=[u[b],a[b]];return this},abort:function(a){var b=a||x;return e&&e.abort(b),A(0,b),this}};if(s.promise(y),o.url=((b||o.url||tb.href)+"").replace(Hb,tb.protocol+"//"),o.type=c.method||c.type||o.method||o.type,o.dataTypes=(o.dataType||"*").toLowerCase().match(L)||[""],null==o.crossDomain){j=d.createElement("a");try{j.href=o.url,j.href=j.href,o.crossDomain=Lb.protocol+"//"+Lb.host!=j.protocol+"//"+j.host}catch(z){o.crossDomain=!0}}if(o.data&&o.processData&&"string"!=typeof o.data&&(o.data=r.param(o.data,o.traditional)),Nb(Ib,o,c,y),k)return y;l=r.event&&o.global,l&&0===r.active++&&r.event.trigger("ajaxStart"),o.type=o.type.toUpperCase(),o.hasContent=!Gb.test(o.type),f=o.url.replace(Cb,""),o.hasContent?o.data&&o.processData&&0===(o.contentType||"").indexOf("application/x-www-form-urlencoded")&&(o.data=o.data.replace(Bb,"+")):(n=o.url.slice(f.length),o.data&&(f+=(vb.test(f)?"&":"?")+o.data,delete o.data),o.cache===!1&&(f=f.replace(Db,"$1"),n=(vb.test(f)?"&":"?")+"_="+ub++ +n),o.url=f+n),o.ifModified&&(r.lastModified[f]&&y.setRequestHeader("If-Modified-Since",r.lastModified[f]),r.etag[f]&&y.setRequestHeader("If-None-Match",r.etag[f])),(o.data&&o.hasContent&&o.contentType!==!1||c.contentType)&&y.setRequestHeader("Content-Type",o.contentType),y.setRequestHeader("Accept",o.dataTypes[0]&&o.accepts[o.dataTypes[0]]?o.accepts[o.dataTypes[0]]+("*"!==o.dataTypes[0]?", "+Kb+"; q=0.01":""):o.accepts["*"]);for(m in o.headers)y.setRequestHeader(m,o.headers[m]);if(o.beforeSend&&(o.beforeSend.call(p,y,o)===!1||k))return y.abort();if(x="abort",t.add(o.complete),y.done(o.success),y.fail(o.error),e=Nb(Jb,o,c,y)){if(y.readyState=1,l&&q.trigger("ajaxSend",[y,o]),k)return y;o.async&&o.timeout>0&&(i=a.setTimeout(function(){y.abort("timeout")},o.timeout));try{k=!1,e.send(v,A)}catch(z){if(k)throw z;A(-1,z)}}else A(-1,"No Transport");function A(b,c,d,h){var j,m,n,v,w,x=c;k||(k=!0,i&&a.clearTimeout(i),e=void 0,g=h||"",y.readyState=b>0?4:0,j=b>=200&&b<300||304===b,d&&(v=Pb(o,y,d)),v=Qb(o,v,y,j),j?(o.ifModified&&(w=y.getResponseHeader("Last-Modified"),w&&(r.lastModified[f]=w),w=y.getResponseHeader("etag"),w&&(r.etag[f]=w)),204===b||"HEAD"===o.type?x="nocontent":304===b?x="notmodified":(x=v.state,m=v.data,n=v.error,j=!n)):(n=x,!b&&x||(x="error",b<0&&(b=0))),y.status=b,y.statusText=(c||x)+"",j?s.resolveWith(p,[m,x,y]):s.rejectWith(p,[y,x,n]),y.statusCode(u),u=void 0,l&&q.trigger(j?"ajaxSuccess":"ajaxError",[y,o,j?m:n]),t.fireWith(p,[y,x]),l&&(q.trigger("ajaxComplete",[y,o]),--r.active||r.event.trigger("ajaxStop")))}return y},getJSON:function(a,b,c){return r.get(a,b,c,"json")},getScript:function(a,b){return r.get(a,void 0,b,"script")}}),r.each(["get","post"],function(a,b){r[b]=function(a,c,d,e){return r.isFunction(c)&&(e=e||d,d=c,c=void 0),r.ajax(r.extend({url:a,type:b,dataType:e,data:c,success:d},r.isPlainObject(a)&&a))}}),r._evalUrl=function(a){return r.ajax({url:a,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,"throws":!0})},r.fn.extend({wrapAll:function(a){var b;return this[0]&&(r.isFunction(a)&&(a=a.call(this[0])),b=r(a,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstElementChild)a=a.firstElementChild;return a}).append(this)),this},wrapInner:function(a){return r.isFunction(a)?this.each(function(b){r(this).wrapInner(a.call(this,b))}):this.each(function(){var b=r(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=r.isFunction(a);return this.each(function(c){r(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(a){return this.parent(a).not("body").each(function(){r(this).replaceWith(this.childNodes)}),this}}),r.expr.pseudos.hidden=function(a){return!r.expr.pseudos.visible(a)},r.expr.pseudos.visible=function(a){return!!(a.offsetWidth||a.offsetHeight||a.getClientRects().length)},r.ajaxSettings.xhr=function(){try{return new a.XMLHttpRequest}catch(b){}};var Rb={0:200,1223:204},Sb=r.ajaxSettings.xhr();o.cors=!!Sb&&"withCredentials"in Sb,o.ajax=Sb=!!Sb,r.ajaxTransport(function(b){var c,d;if(o.cors||Sb&&!b.crossDomain)return{send:function(e,f){var g,h=b.xhr();if(h.open(b.type,b.url,b.async,b.username,b.password),b.xhrFields)for(g in b.xhrFields)h[g]=b.xhrFields[g];b.mimeType&&h.overrideMimeType&&h.overrideMimeType(b.mimeType),b.crossDomain||e["X-Requested-With"]||(e["X-Requested-With"]="XMLHttpRequest");for(g in e)h.setRequestHeader(g,e[g]);c=function(a){return function(){c&&(c=d=h.onload=h.onerror=h.onabort=h.onreadystatechange=null,"abort"===a?h.abort():"error"===a?"number"!=typeof h.status?f(0,"error"):f(h.status,h.statusText):f(Rb[h.status]||h.status,h.statusText,"text"!==(h.responseType||"text")||"string"!=typeof h.responseText?{binary:h.response}:{text:h.responseText},h.getAllResponseHeaders()))}},h.onload=c(),d=h.onerror=c("error"),void 0!==h.onabort?h.onabort=d:h.onreadystatechange=function(){4===h.readyState&&a.setTimeout(function(){c&&d()})},c=c("abort");try{h.send(b.hasContent&&b.data||null)}catch(i){if(c)throw i}},abort:function(){c&&c()}}}),r.ajaxPrefilter(function(a){a.crossDomain&&(a.contents.script=!1)}),r.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(a){return r.globalEval(a),a}}}),r.ajaxPrefilter("script",function(a){void 0===a.cache&&(a.cache=!1),a.crossDomain&&(a.type="GET")}),r.ajaxTransport("script",function(a){if(a.crossDomain){var b,c;return{send:function(e,f){b=r("<script>").prop({charset:a.scriptCharset,src:a.url}).on("load error",c=function(a){b.remove(),c=null,a&&f("error"===a.type?404:200,a.type)}),d.head.appendChild(b[0])},abort:function(){c&&c()}}}});var Tb=[],Ub=/(=)\?(?=&|$)|\?\?/;r.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var a=Tb.pop()||r.expando+"_"+ub++;return this[a]=!0,a}}),r.ajaxPrefilter("json jsonp",function(b,c,d){var e,f,g,h=b.jsonp!==!1&&(Ub.test(b.url)?"url":"string"==typeof b.data&&0===(b.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ub.test(b.data)&&"data");if(h||"jsonp"===b.dataTypes[0])return e=b.jsonpCallback=r.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,h?b[h]=b[h].replace(Ub,"$1"+e):b.jsonp!==!1&&(b.url+=(vb.test(b.url)?"&":"?")+b.jsonp+"="+e),b.converters["script json"]=function(){return g||r.error(e+" was not called"),g[0]},b.dataTypes[0]="json",f=a[e],a[e]=function(){g=arguments},d.always(function(){void 0===f?r(a).removeProp(e):a[e]=f,b[e]&&(b.jsonpCallback=c.jsonpCallback,Tb.push(e)),g&&r.isFunction(f)&&f(g[0]),g=f=void 0}),"script"}),o.createHTMLDocument=function(){var a=d.implementation.createHTMLDocument("").body;return a.innerHTML="<form></form><form></form>",2===a.childNodes.length}(),r.parseHTML=function(a,b,c){if("string"!=typeof a)return[];"boolean"==typeof b&&(c=b,b=!1);var e,f,g;return b||(o.createHTMLDocument?(b=d.implementation.createHTMLDocument(""),e=b.createElement("base"),e.href=d.location.href,b.head.appendChild(e)):b=d),f=C.exec(a),g=!c&&[],f?[b.createElement(f[1])]:(f=qa([a],b,g),g&&g.length&&r(g).remove(),r.merge([],f.childNodes))},r.fn.load=function(a,b,c){var d,e,f,g=this,h=a.indexOf(" ");return h>-1&&(d=pb(a.slice(h)),a=a.slice(0,h)),r.isFunction(b)?(c=b,b=void 0):b&&"object"==typeof b&&(e="POST"),g.length>0&&r.ajax({url:a,type:e||"GET",dataType:"html",data:b}).done(function(a){f=arguments,g.html(d?r("<div>").append(r.parseHTML(a)).find(d):a)}).always(c&&function(a,b){g.each(function(){c.apply(this,f||[a.responseText,b,a])})}),this},r.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(a,b){r.fn[b]=function(a){return this.on(b,a)}}),r.expr.pseudos.animated=function(a){return r.grep(r.timers,function(b){return a===b.elem}).length},r.offset={setOffset:function(a,b,c){var d,e,f,g,h,i,j,k=r.css(a,"position"),l=r(a),m={};"static"===k&&(a.style.position="relative"),h=l.offset(),f=r.css(a,"top"),i=r.css(a,"left"),j=("absolute"===k||"fixed"===k)&&(f+i).indexOf("auto")>-1,j?(d=l.position(),g=d.top,e=d.left):(g=parseFloat(f)||0,e=parseFloat(i)||0),r.isFunction(b)&&(b=b.call(a,c,r.extend({},h))),null!=b.top&&(m.top=b.top-h.top+g),null!=b.left&&(m.left=b.left-h.left+e),"using"in b?b.using.call(a,m):l.css(m)}},r.fn.extend({offset:function(a){if(arguments.length)return void 0===a?this:this.each(function(b){r.offset.setOffset(this,a,b)});var b,c,d,e,f=this[0];if(f)return f.getClientRects().length?(d=f.getBoundingClientRect(),b=f.ownerDocument,c=b.documentElement,e=b.defaultView,{top:d.top+e.pageYOffset-c.clientTop,left:d.left+e.pageXOffset-c.clientLeft}):{top:0,left:0}},position:function(){if(this[0]){var a,b,c=this[0],d={top:0,left:0};return"fixed"===r.css(c,"position")?b=c.getBoundingClientRect():(a=this.offsetParent(),b=this.offset(),B(a[0],"html")||(d=a.offset()),d={top:d.top+r.css(a[0],"borderTopWidth",!0),left:d.left+r.css(a[0],"borderLeftWidth",!0)}),{top:b.top-d.top-r.css(c,"marginTop",!0),left:b.left-d.left-r.css(c,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var a=this.offsetParent;while(a&&"static"===r.css(a,"position"))a=a.offsetParent;return a||ra})}}),r.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(a,b){var c="pageYOffset"===b;r.fn[a]=function(d){return T(this,function(a,d,e){var f;return r.isWindow(a)?f=a:9===a.nodeType&&(f=a.defaultView),void 0===e?f?f[b]:a[d]:void(f?f.scrollTo(c?f.pageXOffset:e,c?e:f.pageYOffset):a[d]=e)},a,d,arguments.length)}}),r.each(["top","left"],function(a,b){r.cssHooks[b]=Pa(o.pixelPosition,function(a,c){if(c)return c=Oa(a,b),Ma.test(c)?r(a).position()[b]+"px":c})}),r.each({Height:"height",Width:"width"},function(a,b){r.each({padding:"inner"+a,content:b,"":"outer"+a},function(c,d){r.fn[d]=function(e,f){var g=arguments.length&&(c||"boolean"!=typeof e),h=c||(e===!0||f===!0?"margin":"border");return T(this,function(b,c,e){var f;return r.isWindow(b)?0===d.indexOf("outer")?b["inner"+a]:b.document.documentElement["client"+a]:9===b.nodeType?(f=b.documentElement,Math.max(b.body["scroll"+a],f["scroll"+a],b.body["offset"+a],f["offset"+a],f["client"+a])):void 0===e?r.css(b,c,h):r.style(b,c,e,h)},b,g?e:void 0,g)}})}),r.fn.extend({bind:function(a,b,c){return this.on(a,null,b,c)},unbind:function(a,b){return this.off(a,null,b)},delegate:function(a,b,c,d){return this.on(b,a,c,d)},undelegate:function(a,b,c){return 1===arguments.length?this.off(a,"**"):this.off(b,a||"**",c)}}),r.holdReady=function(a){a?r.readyWait++:r.ready(!0)},r.isArray=Array.isArray,r.parseJSON=JSON.parse,r.nodeName=B,"function"==typeof define&&define.amd&&define("jquery",[],function(){return r});var Vb=a.jQuery,Wb=a.$;return r.noConflict=function(b){return a.$===r&&(a.$=Wb),b&&a.jQuery===r&&(a.jQuery=Vb),r},b||(a.jQuery=a.$=r),r});
diff --git a/docs/latest/_static/minus.png b/docs/latest/_static/minus.png
index 0f22b16..d96755f 100644
--- a/docs/latest/_static/minus.png
+++ b/docs/latest/_static/minus.png
Binary files differ
diff --git a/docs/latest/_static/plus.png b/docs/latest/_static/plus.png
index 0cfe084..7107cec 100644
--- a/docs/latest/_static/plus.png
+++ b/docs/latest/_static/plus.png
Binary files differ
diff --git a/docs/latest/_static/pygments.css b/docs/latest/_static/pygments.css
index 8213e90..20c4814 100644
--- a/docs/latest/_static/pygments.css
+++ b/docs/latest/_static/pygments.css
@@ -47,8 +47,10 @@
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
+.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
+.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
@@ -59,7 +61,9 @@
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #06287e } /* Name.Function.Magic */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
+.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/docs/latest/_static/searchtools.js b/docs/latest/_static/searchtools.js
index 066857c..41b8336 100644
--- a/docs/latest/_static/searchtools.js
+++ b/docs/latest/_static/searchtools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -226,6 +226,106 @@
};
+
+
+
+var splitChars = (function() {
+ var result = {};
+ var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
+ 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
+ 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
+ 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
+ 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
+ 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
+ 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
+ 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
+ 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
+ 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
+ var i, j, start, end;
+ for (i = 0; i < singles.length; i++) {
+ result[singles[i]] = true;
+ }
+ var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
+ [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
+ [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
+ [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
+ [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
+ [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
+ [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
+ [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
+ [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
+ [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
+ [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
+ [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
+ [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
+ [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
+ [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
+ [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
+ [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
+ [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
+ [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
+ [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
+ [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
+ [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
+ [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
+ [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
+ [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
+ [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
+ [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
+ [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
+ [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
+ [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
+ [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
+ [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
+ [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
+ [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
+ [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
+ [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
+ [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
+ [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
+ [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
+ [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
+ [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
+ [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
+ [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
+ [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
+ [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
+ [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
+ [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
+ [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
+ [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
+ for (i = 0; i < ranges.length; i++) {
+ start = ranges[i][0];
+ end = ranges[i][1];
+ for (j = start; j <= end; j++) {
+ result[j] = true;
+ }
+ }
+ return result;
+})();
+
+function splitQuery(query) {
+ var result = [];
+ var start = -1;
+ for (var i = 0; i < query.length; i++) {
+ if (splitChars[query.charCodeAt(i)]) {
+ if (start !== -1) {
+ result.push(query.slice(start, i));
+ start = -1;
+ }
+ } else if (start === -1) {
+ start = i;
+ }
+ }
+ if (start !== -1) {
+ result.push(query.slice(start));
+ }
+ return result;
+}
+
+
+
+
/**
* Search Module
*/
@@ -324,7 +424,7 @@
var searchterms = [];
var excluded = [];
var hlterms = [];
- var tmp = query.split(/\s+/);
+ var tmp = splitQuery(query);
var objectterms = [];
for (i = 0; i < tmp.length; i++) {
if (tmp[i] !== "") {
@@ -338,6 +438,10 @@
}
// stem the word
var word = stemmer.stemWord(tmp[i].toLowerCase());
+ // prevent stemmer from cutting word smaller than two chars
+ if(word.length < 3 && tmp[i].length >= 3) {
+ word = tmp[i];
+ }
var toAppend;
// select the correct list
if (word[0] == '-') {
@@ -435,7 +539,11 @@
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
- $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[0] + '.txt',
+ var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
+ if (suffix === undefined) {
+ suffix = '.txt';
+ }
+ $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
@@ -474,6 +582,7 @@
*/
performObjectSearch : function(object, otherterms) {
var filenames = this._index.filenames;
+ var docnames = this._index.docnames;
var objects = this._index.objects;
var objnames = this._index.objnames;
var titles = this._index.titles;
@@ -527,7 +636,7 @@
} else {
score += Scorer.objPrioDefault;
}
- results.push([filenames[match[0]], fullname, '#'+anchor, descr, score]);
+ results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
}
}
}
@@ -539,6 +648,7 @@
* search for full-text terms in the index
*/
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
+ var docnames = this._index.docnames;
var filenames = this._index.filenames;
var titles = this._index.titles;
@@ -613,7 +723,7 @@
// select one (max) score for the file.
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
- results.push([filenames[file], titles[file], '', null, score]);
+ results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
}
}
return results;
diff --git a/docs/latest/_static/up-pressed.png b/docs/latest/_static/up-pressed.png
index 99e7210..acee3b6 100644
--- a/docs/latest/_static/up-pressed.png
+++ b/docs/latest/_static/up-pressed.png
Binary files differ
diff --git a/docs/latest/_static/up.png b/docs/latest/_static/up.png
index 26de002..2a940a7 100644
--- a/docs/latest/_static/up.png
+++ b/docs/latest/_static/up.png
Binary files differ
diff --git a/docs/latest/_static/websupport.js b/docs/latest/_static/websupport.js
index 98e7f40..78e14bb 100644
--- a/docs/latest/_static/websupport.js
+++ b/docs/latest/_static/websupport.js
@@ -4,7 +4,7 @@
*
* sphinx.websupport utilities for all documentation.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -301,7 +301,7 @@
li.hide();
// Determine where in the parents children list to insert this comment.
- for(i=0; i < siblings.length; i++) {
+ for(var i=0; i < siblings.length; i++) {
if (comp(comment, siblings[i]) <= 0) {
$('#cd' + siblings[i].id)
.parent()
diff --git a/docs/latest/admin/index.html b/docs/latest/admin/index.html
index 9e0cb26..07c8711 100644
--- a/docs/latest/admin/index.html
+++ b/docs/latest/admin/index.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Administrator’s Guide — Traffic Control 2.1-dev documentation </title>
+ <title>Administrator’s Guide — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="next" title="Traffic Ops - Installing" href="traffic_ops/installation.html"/>
<link rel="prev" title="Traffic Vault" href="../overview/traffic_vault.html"/>
@@ -94,21 +99,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Administrator’s Guide</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
@@ -119,15 +125,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -163,12 +177,12 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li>Administrator’s Guide</li>
+ <li>Administrator’s Guide</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/index.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -187,7 +201,7 @@
<div role="main" class="document">
<div class="section" id="administrator-s-guide">
-<h1>Administrator’s Guide<a class="headerlink" href="#administrator-s-guide" title="Permalink to this headline">¶</a></h1>
+<h1>Administrator’s Guide<a class="headerlink" href="#administrator-s-guide" title="Permalink to this headline">¶</a></h1>
<p>Traffic Control is distributed in source form for the developer, but also as a binary package. This guide details how to install and configure a Traffic Control CDN using the binary packages, as well as how to perform common operations running a CDN.</p>
<p>When installing a complete CDN from scratch, a sample recommended order is:</p>
<ol class="arabic simple">
@@ -223,6 +237,15 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html#navigating-the-database-migration">Navigating the Database Migration</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html#per-deliveryservice-routing-names">Per-DeliveryService Routing Names</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html#apache-traffic-server-7-x-cachekey-plugin">Apache Traffic Server 7.x (Cachekey Plugin)</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html#examples-of-cacheurl-to-cachekey-replacements">Examples of Cacheurl to Cachekey Replacements</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html#apache-traffic-server-7-x-logging">Apache Traffic Server 7.x (Logging)</a></li>
+</ul>
+</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html#installing-the-ssl-cert">Installing the SSL Cert</a><ul>
<li class="toctree-l3"><a class="reference internal" href="traffic_ops/configuration.html#self-signed-certificate-development">Self-signed Certificate (Development)</a></li>
@@ -236,6 +259,7 @@
<li class="toctree-l3"><a class="reference internal" href="traffic_ops/configuration.html#creating-the-centos-kickstart-file">Creating the CentOS Kickstart File</a></li>
</ul>
</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html#configuring-the-go-application">Configuring the Go Application</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</a><ul>
@@ -266,6 +290,7 @@
<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#static-dns-entries">Static DNS Entries</a></li>
<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#server-assignments">Server Assignments</a></li>
<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#the-coverage-zone-file-and-asn-table">The Coverage Zone File and ASN Table</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_ops/using.html#the-deep-coverage-zone-file">The Deep Coverage Zone File</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html#parameters-and-profiles">Parameters and Profiles</a></li>
@@ -282,8 +307,61 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/extensions.html#example-cron-file">Example Cron File</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#dashboard">Dashboard</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#cdns">CDNs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#monitor">Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#services">Services</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#configure">Configure</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#topology">Topology</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#tools">Tools</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#user-admin">User Admin</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#other">Other</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#id1">Monitor</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#cache-checks">Cache Checks</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#cache-stats">Cache Stats</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#id2">Services</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#delivery-services">Delivery Services</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#delivery-service-requests">Delivery Service Requests</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#id3">Configure</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#servers">Servers</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#profiles">Profiles</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#parameters">Parameters</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#types">Types</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#statuses">Statuses</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#id4">Topology</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#cache-groups">Cache Groups</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#phys-locations">Phys Locations</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#divisions">Divisions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#regions">Regions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#asns">ASNs</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#id5">Tools</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#invalidate-content">Invalidate Content</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#generate-iso">Generate ISO</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#id6">User Admin</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#users">Users</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#tenants">Tenants</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#roles">Roles</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#id7">Other</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_portal/usingtrafficportal.html#custom-menu-items">Custom Menu Items</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration (Legacy)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#installing-traffic-monitor">Installing Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#configuring-traffic-monitor">Configuring Traffic Monitor</a><ul>
<li class="toctree-l3"><a class="reference internal" href="traffic_monitor.html#configuration-overview">Configuration Overview</a></li>
@@ -327,9 +405,15 @@
<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#configuration">Configuration</a></li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#steering-feature">Steering feature</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#deep-caching-deep-coverage-zone-topology">Deep Caching - Deep Coverage Zone Topology</a><ul>
<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#id2">Overview</a></li>
-<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#id3">Configuration</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#getting-started">Getting started</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#how-it-works">How it works</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#steering-feature">Steering feature</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#id3">Overview</a></li>
+<li class="toctree-l3"><a class="reference internal" href="traffic_router.html#id4">Configuration</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#https-for-http-type-delivery-services">HTTPS for Http Type Delivery Services</a><ul>
@@ -371,12 +455,19 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="quick_howto/multi_site.html">Configure Multi Site Origin</a></li>
-<li class="toctree-l2"><a class="reference internal" href="quick_howto/multi_site_ats5.html">Configure Multi Site Origin (5.x)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="quick_howto/dnssec.html">Configure DNSSEC</a></li>
-<li class="toctree-l2"><a class="reference internal" href="quick_howto/federations.html">Configure Federations</a></li>
-<li class="toctree-l2"><a class="reference internal" href="quick_howto/regionalgeo.html">Configure Regional Geo-blocking (RGB)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="quick_howto/steering.html">Configure Delivery Service Steering</a></li>
+<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html#traffic-ops">Traffic Ops</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="quick_howto/multi_site.html">Configure Multi Site Origin</a></li>
+<li class="toctree-l3"><a class="reference internal" href="quick_howto/dnssec.html">Configure DNSSEC</a></li>
+<li class="toctree-l3"><a class="reference internal" href="quick_howto/federations.html">Configure Federations</a></li>
+<li class="toctree-l3"><a class="reference internal" href="quick_howto/regionalgeo.html">Configure Regional Geo-blocking (RGB)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="quick_howto/anonymous_blocking.html">Configure Anonymous Blocking</a></li>
+<li class="toctree-l3"><a class="reference internal" href="quick_howto/steering.html">Configure Delivery Service Steering</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html#traffic-portal">Traffic Portal</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="quick_howto/ds_requests.html">Delivery Service Requests</a></li>
+</ul>
+</li>
</ul>
</li>
</ul>
@@ -416,16 +507,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/admin/quick_howto/anonymous_blocking.html b/docs/latest/admin/quick_howto/anonymous_blocking.html
new file mode 100644
index 0000000..d4d5f74
--- /dev/null
+++ b/docs/latest/admin/quick_howto/anonymous_blocking.html
@@ -0,0 +1,355 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Configure Anonymous Blocking — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="Quick How To Guides" href="index.html"/>
+ <link rel="next" title="Configure Delivery Service Steering" href="steering.html"/>
+ <link rel="prev" title="Configure Regional Geo-blocking (RGB)" href="regionalgeo.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
+
+ <li><a href="index.html">Quick How To Guides</a> »</li>
+
+ <li>Configure Anonymous Blocking</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/admin/quick_howto/anonymous_blocking.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="steering.html" class="btn btn-neutral float-right" title="Configure Delivery Service Steering">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="regionalgeo.html" class="btn btn-neutral" title="Configure Regional Geo-blocking (RGB)"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="configure-anonymous-blocking">
+<span id="rl-anonymous-blocking-qht"></span><h1>Configure Anonymous Blocking<a class="headerlink" href="#configure-anonymous-blocking" title="Permalink to this headline">¶</a></h1>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Anonymous Blocking is only supported for HTTP delivery services.</p>
+</div>
+<ol class="arabic simple">
+<li>Prepare the Anonymous Blocking configuration file</li>
+</ol>
+<p>Anonymous Blocking uses a configuration file in JSON format to define blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+
+ <span class="s2">"customer"</span><span class="p">:</span> <span class="s2">"YourCompany"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"date"</span> <span class="p">:</span> <span class="s2">"2017-05-23 03:28:25"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Anonymous IP Blocking Policy"</span><span class="p">,</span>
+
+ <span class="s2">"anonymousIp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"blockAnonymousVPN"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"blockHostingProvider"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"blockPublicProxy"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"blockTorExitNode"</span><span class="p">:</span> <span class="n">true</span><span class="p">},</span>
+
+ <span class="s2">"ip4Whitelist"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"192.168.30.0/24"</span><span class="p">,</span> <span class="s2">"10.0.2.0/24"</span><span class="p">,</span> <span class="s2">"10.1.1.1/32"</span><span class="p">],</span>
+
+ <span class="s2">"ip6Whitelist"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"2001:550:90a::/48"</span><span class="p">,</span> <span class="s2">"::1/128"</span><span class="p">],</span>
+
+ <span class="s2">"redirectUrl"</span><span class="p">:</span> <span class="s2">"http://youvebeenblocked.com"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li>“anonymousIp” contains the types of IPs which can be checked against the Anonymous IP Database. There are 4 types of IPs which can be checked: VPNs, Hosting Providers, Public Proxies, and Tor Exit Nodes. Each type of IP can be enabled or disabled. If the value is true, IPs which match this type will be blocked when the feature is enabled in the delivery service. If the value is false, IPs which match this type will not be blocked. If an IP matches more than 1 type and any type is enabled, the IP will be blocked.</li>
+<li>“redirectUrl” is the URL that will be returned to the blocked clients. Without a redirectUrl, the clients will receive an HTTP response code 403. With a redirectUrl, the clients will be redirected with an HTTP response code 302.</li>
+<li>“ipWhiteList” is an optional element. It includes a list of CIDR (Classless Inter-Domain Routing) blocks indicating the IPv4 and IPv6 subnets that are allowed by the rule. If this list exists and the value is not empty, client IP will be matched against the CIDR list, and if there is any match, the request will be allowed. If there is no match in the white list, further anonymous blocking logic will continue.</li>
+</ul>
+<ol class="arabic simple" start="2">
+<li>Add Anonymous Blocking parameters on Traffic Ops</li>
+</ol>
+<p>The following three new parameters are required to be added into CRConfig.json:</p>
+<ul class="simple">
+<li>“anonymousip.policy.configuration”: the HTTP URL of the Anonymous Blocking configuration file. Traffic Router will fetch the file from this URL.</li>
+<li>“anonymousip.polling.url”: the HTTP URL of the Anonymous IP Database. Traffic Router will fetch the file from this URL.</li>
+<li>“anonymousip.polling.interval”: the interval that Traffic Router polls the Anonymous Blocking configuration file and Anonymous IP Database.</li>
+</ul>
+<a class="reference internal image-reference" href="../../_images/anonymous_blocking01.png"><img alt="../../_images/anonymous_blocking01.png" class="align-center" src="../../_images/anonymous_blocking01.png" style="width: 1720.0px; height: 374.0px;" /></a>
+<ol class="arabic simple" start="3">
+<li>Enable Anonmyous Blocking for a delivery service</li>
+</ol>
+<a class="reference internal image-reference" href="../../_images/anonymous_blocking02.png"><img alt="../../_images/anonymous_blocking02.png" class="align-center" src="../../_images/anonymous_blocking02.png" style="width: 1058.0px; height: 220.0px;" /></a>
+<ol class="arabic simple" start="4">
+<li>Make configuration effective</li>
+</ol>
+<p>Go to Tools->Snapshot CRConfig, perform “Diff CRConfig” and click “Write CRConfig”.</p>
+<a class="reference internal image-reference" href="../../_images/regionalgeo03.png"><img alt="../../_images/regionalgeo03.png" class="align-center" src="../../_images/regionalgeo03.png" style="width: 464.79999999999995px; height: 128.79999999999998px;" /></a>
+<ol class="arabic simple" start="5">
+<li>Traffic Router access log with Anonymous Blocking</li>
+</ol>
+<p>Anonymous Blocking extends the field of “rtype” and adds a new field “ANON_BLOCK” in Traffic Router access.log to help to monitor the working of this feature.</p>
+<p>If rtype=ANON_BLOCK then the client’s IP was found in the Anonymous IP Database and was blocked.</p>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="steering.html" class="btn btn-neutral float-right" title="Configure Delivery Service Steering">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="regionalgeo.html" class="btn btn-neutral" title="Configure Regional Geo-blocking (RGB)"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/admin/quick_howto/dnssec.html b/docs/latest/admin/quick_howto/dnssec.html
index 65e5cf8..1f656c4 100644
--- a/docs/latest/admin/quick_howto/dnssec.html
+++ b/docs/latest/admin/quick_howto/dnssec.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configure DNSSEC — Traffic Control 2.1-dev documentation </title>
+ <title>Configure DNSSEC — Traffic Control 2.2-dev documentation </title>
@@ -33,10 +35,13 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Quick How To Guides" href="index.html"/>
<link rel="next" title="Configure Federations" href="federations.html"/>
- <link rel="prev" title="Configure Multi Site Origin (5.x)" href="multi_site_ats5.html"/>
+ <link rel="prev" title="Configure Multi Site Origin" href="multi_site.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,16 +178,16 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li><a href="index.html">Quick How To Guides</a> »</li>
<li>Configure DNSSEC</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/dnssec.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/dnssec.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -185,7 +199,7 @@
<a href="federations.html" class="btn btn-neutral float-right" title="Configure Federations">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="multi_site_ats5.html" class="btn btn-neutral" title="Configure Multi Site Origin (5.x)"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="multi_site.html" class="btn btn-neutral" title="Configure Multi Site Origin"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -214,33 +228,33 @@
<li>Effective Date</li>
</ul>
</div></blockquote>
-<p>Once the required information has been entered click on the ‘Generate Keys’ button.</p>
+<p>Once the required information has been entered click on the ‘Generate Keys’ button.</p>
<p>Depending upon the number of Delivery Services in the CDN, generating DNSSEC keys may take serveral seconds.</p>
</li>
</ol>
<a class="reference internal image-reference" href="../../_images/dnssec02.png"><img alt="../../_images/dnssec02.png" class="align-center" src="../../_images/dnssec02.png" style="width: 747.0px; height: 454.0px;" /></a>
<ol class="arabic" start="3">
-<li><p class="first">In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN’s domain (e.g. If the CDN’s domain is ‘cdn.kabletown.net’ the parent zone is ‘kabletown.net’).</p>
+<li><p class="first">In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN’s domain (e.g. If the CDN’s domain is ‘cdn.kabletown.net’ the parent zone is ‘kabletown.net’).</p>
<p>If you control your parent zone you can enter this information yourself, otherwise you will need to work with your DNS team to get the DS Record added to the parent zone.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec03.png"><img alt="../../_images/dnssec03.png" class="align-center" src="../../_images/dnssec03.png" style="width: 499.1px; height: 190.4px;" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec03.png"><img alt="../../_images/dnssec03.png" class="align-center" src="../../_images/dnssec03.png" style="width: 499.09999999999997px; height: 190.39999999999998px;" /></a>
<ol class="arabic" start="4">
<li><p class="first">Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.</p>
<p>Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.</p>
-<p>This will add a ‘dnssec.enabled = “true”’ entry to CRConfig for the chosen CDN.</p>
+<p>This will add a ‘dnssec.enabled = “true”’ entry to CRConfig for the chosen CDN.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" style="width: 554.4px; height: 422.8px;" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" style="width: 554.4px; height: 422.79999999999995px;" /></a>
<ol class="arabic" start="5">
<li><p class="first">DNSSEC should now be active on your CDN and Traffic Router should be signing responses.</p>
<blockquote>
<div><p>A dig command with +dnssec added should show you the signed responses.</p>
-<p><code class="docutils literal"><span class="pre">dig</span> <span class="pre">edge.cdn.kabletown.net.</span> <span class="pre">+dnssec</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">dig</span> <span class="pre">edge.cdn.kabletown.net.</span> <span class="pre">+dnssec</span></code></p>
</div></blockquote>
</li>
<li><p class="first">When KSK expiration is approaching (default 365 days), it is necessary to manually generate a new KSK for the TLD (Top Level Domain) and add the DS Record to the parent zone. In order to avoid signing errors, it is suggested that an effective date is chosen which allows time for the DS Record to be added to the parent zone before the new KSK becomes active.</p>
-<p>A new KSK can be generated by clicking the ‘Regenerate KSK’ button on the Manage DNSSEC Keys screen (see screenshot above).</p>
+<p>A new KSK can be generated by clicking the ‘Regenerate KSK’ button on the Manage DNSSEC Keys screen (see screenshot above).</p>
</li>
</ol>
</div>
@@ -254,7 +268,7 @@
<a href="federations.html" class="btn btn-neutral float-right" title="Configure Federations">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="multi_site_ats5.html" class="btn btn-neutral" title="Configure Multi Site Origin (5.x)"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="multi_site.html" class="btn btn-neutral" title="Configure Multi Site Origin"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -278,16 +292,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/quick_howto/ds_requests.html b/docs/latest/admin/quick_howto/ds_requests.html
new file mode 100644
index 0000000..28edf5e
--- /dev/null
+++ b/docs/latest/admin/quick_howto/ds_requests.html
@@ -0,0 +1,343 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Delivery Service Requests — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="Quick How To Guides" href="index.html"/>
+ <link rel="next" title="Developer’s Guide" href="../../development/index.html"/>
+ <link rel="prev" title="Configure Delivery Service Steering" href="steering.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
+
+ <li><a href="index.html">Quick How To Guides</a> »</li>
+
+ <li>Delivery Service Requests</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/admin/quick_howto/ds_requests.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../../development/index.html" class="btn btn-neutral float-right" title="Developer’s Guide">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="steering.html" class="btn btn-neutral" title="Configure Delivery Service Steering"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="delivery-service-requests">
+<span id="ds-requests"></span><h1>Delivery Service Requests<a class="headerlink" href="#delivery-service-requests" title="Permalink to this headline">¶</a></h1>
+<p>When enabled in traffic_portal_properties.json, delivery service requests are created when ALL users attempt to create, update or delete a delivery service.
+This allows users with higher level permissions (ops or admin) to review the changes for completeness and accuracy before deploying the changes.
+In addition, most delivery service changes require cache config updates (aka queue updates) and/or a cdn snapshot. Both of these actions are reserved for users with elevated permissions.</p>
+<p>A list of the delivery service requests associated with your tenant can be found here:</p>
+<p><code class="docutils literal notranslate"><span class="pre">https://traffic-portal.domain.com/#!/delivery-service-requests</span></code></p>
+<img alt="../../_images/tp_table_ds_requests.png" src="../../_images/tp_table_ds_requests.png" />
+<div class="section" id="who-can-create-a-delivery-service-request-and-how">
+<h2>Who Can Create a Delivery Service Request and How?<a class="headerlink" href="#who-can-create-a-delivery-service-request-and-how" title="Permalink to this headline">¶</a></h2>
+<p>Users with the Portal role (or above) can create delivery service requests by doing one of three things:</p>
+<ol class="arabic simple">
+<li>Creating a new delivery service</li>
+<li>Updating an existing delivery service</li>
+<li>Deleting an exiting delivery service</li>
+</ol>
+<p>By performing one of these actions, a delivery service request will be created for you with a status of draft or submitted. You determine the status of your request. Only change the status of your request to submitted once the request is ready for review and deployment.</p>
+</div>
+<div class="section" id="who-can-fulfill-a-delivery-service-request-and-how">
+<h2>Who Can Fulfill a Delivery Service Request and How?<a class="headerlink" href="#who-can-fulfill-a-delivery-service-request-and-how" title="Permalink to this headline">¶</a></h2>
+<p>Users with elevated permissions (Operations or above) can fulfill (apply the changes) or reject the delivery service request. In fact, they can do all of the following:</p>
+<div class="section" id="update-the-contents-of-the-delivery-service-request">
+<h3>Update the contents of the delivery service request<a class="headerlink" href="#update-the-contents-of-the-delivery-service-request" title="Permalink to this headline">¶</a></h3>
+<p>Optional. This will update the “Last Edited By” field to indicate who last updated the request.</p>
+</div>
+<div class="section" id="assign-or-unassign-the-delivery-service-request">
+<h3>Assign or unassign the delivery service request<a class="headerlink" href="#assign-or-unassign-the-delivery-service-request" title="Permalink to this headline">¶</a></h3>
+<p>Optional. Assignment is currently limited to current user. This is optional as fulfillment will auto-assign the request to the user doing the fulfillment.</p>
+</div>
+<div class="section" id="reject-the-delivery-service-request">
+<h3>Reject the delivery service request<a class="headerlink" href="#reject-the-delivery-service-request" title="Permalink to this headline">¶</a></h3>
+<p>Rejecting a delivery service request will set status to <code class="docutils literal notranslate"><span class="pre">rejected</span></code> and the request can no longer be modified. This will auto-assign the request to the user doing the rejection.</p>
+</div>
+<div class="section" id="fulfill-the-delivery-service-request">
+<h3>Fulfill the delivery service request<a class="headerlink" href="#fulfill-the-delivery-service-request" title="Permalink to this headline">¶</a></h3>
+<p>Fulfilling a delivery service request will show the requested changes and, once committed, will apply the desired changes and set status to <code class="docutils literal notranslate"><span class="pre">pending</span></code>. The request is pending because many types of changes will require cache config updates (aka queue updates) and/or a cdn snapshot. Once queue updates and/or cdn snapshot is complete, the request should be marked <code class="docutils literal notranslate"><span class="pre">complete</span></code>.</p>
+</div>
+<div class="section" id="complete-the-delivery-service-request">
+<h3>Complete the delivery service request<a class="headerlink" href="#complete-the-delivery-service-request" title="Permalink to this headline">¶</a></h3>
+<p>Only after the delivery service request has been fulfilled and the changes have been applied can a delivery service request be marked as complete. Marking a delivery service as complete is currently a manual step because some changes require cache config updates (aka queue updates) and/or a cdn snapshot.
+Once that is done and the changes have been deployed, the request status should be changed from <code class="docutils literal notranslate"><span class="pre">pending</span></code> to <code class="docutils literal notranslate"><span class="pre">complete</span></code>.</p>
+</div>
+<div class="section" id="delete-the-delivery-service-request">
+<h3>Delete the delivery service request<a class="headerlink" href="#delete-the-delivery-service-request" title="Permalink to this headline">¶</a></h3>
+<p>Delivery service requests with a status of draft or submitted can always be deleted entirely if appropriate.</p>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../../development/index.html" class="btn btn-neutral float-right" title="Developer’s Guide">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="steering.html" class="btn btn-neutral" title="Configure Delivery Service Steering"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/admin/quick_howto/federations.html b/docs/latest/admin/quick_howto/federations.html
index a5e2d6c..9bda124 100644
--- a/docs/latest/admin/quick_howto/federations.html
+++ b/docs/latest/admin/quick_howto/federations.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configure Federations — Traffic Control 2.1-dev documentation </title>
+ <title>Configure Federations — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Quick How To Guides" href="index.html"/>
<link rel="next" title="Configure Regional Geo-blocking (RGB)" href="regionalgeo.html"/>
<link rel="prev" title="Configure DNSSEC" href="dnssec.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,16 +178,16 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li><a href="index.html">Quick How To Guides</a> »</li>
<li>Configure Federations</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/federations.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/federations.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -207,7 +221,7 @@
</ol>
<a class="reference internal image-reference" href="../../_images/federation01.png"><img alt="../../_images/federation01.png" class="align-center" src="../../_images/federation01.png" style="width: 804.0px; height: 690.0px;" /></a>
<ol class="arabic simple" start="2">
-<li>As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking ‘Add Federation Mapping’</li>
+<li>As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking ‘Add Federation Mapping’</li>
<li>Choose the Delivery Service for the federation to be mapped to and assign it to the Federation User; click Add.</li>
</ol>
<a class="reference internal image-reference" href="../../_images/federation02.png"><img alt="../../_images/federation02.png" class="align-center" src="../../_images/federation02.png" style="width: 766.0px; height: 494.0px;" /></a>
@@ -222,7 +236,7 @@
<ol class="arabic" start="5">
<li><p class="first">The federation user logs to traffic ops and stores the mojolicious cookie. The mojolicious cookie can be obtained manually using the debug tools on a web browser or via curl.</p>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
HTTP/1.1 200 OK
Date: Wed, 02 Dec 2015 21:12:06 GMT
@@ -244,7 +258,7 @@
<li><p class="first">The federation user sends a request to Traffic Ops to add IPV4 and/or IPV6 resolvers</p>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
{"federations": [
{ "deliveryService": "images-c1",
"mappings":
@@ -281,9 +295,9 @@
<li><p class="first">Any requests made from a client that resolves to one of the federation resolvers will now be given a CNAME from Traffic Router.</p>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ dig @tr.kabletown.net edge.images-c1.kabletown.net
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ dig @tr.kabletown.net foo.images-c1.kabletown.net
-; <<>> DiG 9.7.3-RedHat-9.7.3-2.el6 <<>> @tr.kabletown.net edge.images-c1.kabletown.net
+; <<>> DiG 9.7.3-RedHat-9.7.3-2.el6 <<>> @tr.kabletown.net foo.images-c1.kabletown.net
; (1 server found)
;; global options: +cmd
;; Got answer:
@@ -292,10 +306,10 @@
;; WARNING: recursion requested but not available
;; QUESTION SECTION:
-;edge.images-c1.kabletown.net. IN A
+;foo.images-c1.kabletown.net. IN A
;; ANSWER SECTION:
-edge.images-c1.kabletown.net. 30 IN CNAME img.mega-cdn.net.
+foo.images-c1.kabletown.net. 30 IN CNAME img.mega-cdn.net.
;; Query time: 9 msec
;; SERVER: 10.10.10.10#53(10.10.10.10)
@@ -341,16 +355,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/quick_howto/index.html b/docs/latest/admin/quick_howto/index.html
index cb1c3d0..9fccd68 100644
--- a/docs/latest/admin/quick_howto/index.html
+++ b/docs/latest/admin/quick_howto/index.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Quick How To Guides — Traffic Control 2.1-dev documentation </title>
+ <title>Quick How To Guides — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Administrator’s Guide" href="../index.html"/>
<link rel="next" title="Configure Multi Site Origin" href="multi_site.html"/>
<link rel="prev" title="Traffic Vault Administration" href="../traffic_vault.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li>Quick How To Guides</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/index.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -192,17 +206,40 @@
<div class="section" id="quick-how-to-guides">
<h1>Quick How To Guides<a class="headerlink" href="#quick-how-to-guides" title="Permalink to this headline">¶</a></h1>
<p>Traffic Control is a complicated system, and documenting it is not trivial. Sometimes a picture says more than a thousand words, so here are some screen shot based tutorials on how to use some of the more involved features.</p>
+<div class="section" id="traffic-ops">
+<h2>Traffic Ops<a class="headerlink" href="#traffic-ops" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="multi_site.html">Configure Multi Site Origin</a></li>
-<li class="toctree-l1"><a class="reference internal" href="multi_site_ats5.html">Configure Multi Site Origin (5.x)</a></li>
<li class="toctree-l1"><a class="reference internal" href="dnssec.html">Configure DNSSEC</a></li>
<li class="toctree-l1"><a class="reference internal" href="federations.html">Configure Federations</a></li>
<li class="toctree-l1"><a class="reference internal" href="regionalgeo.html">Configure Regional Geo-blocking (RGB)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="anonymous_blocking.html">Configure Anonymous Blocking</a></li>
<li class="toctree-l1"><a class="reference internal" href="steering.html">Configure Delivery Service Steering</a></li>
</ul>
</div>
</div>
+<div class="section" id="traffic-portal">
+<h2>Traffic Portal<a class="headerlink" href="#traffic-portal" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="ds_requests.html">Delivery Service Requests</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="ds_requests.html#who-can-create-a-delivery-service-request-and-how">Who Can Create a Delivery Service Request and How?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ds_requests.html#who-can-fulfill-a-delivery-service-request-and-how">Who Can Fulfill a Delivery Service Request and How?</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="ds_requests.html#update-the-contents-of-the-delivery-service-request">Update the contents of the delivery service request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ds_requests.html#assign-or-unassign-the-delivery-service-request">Assign or unassign the delivery service request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ds_requests.html#reject-the-delivery-service-request">Reject the delivery service request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ds_requests.html#fulfill-the-delivery-service-request">Fulfill the delivery service request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ds_requests.html#complete-the-delivery-service-request">Complete the delivery service request</a></li>
+<li class="toctree-l3"><a class="reference internal" href="ds_requests.html#delete-the-delivery-service-request">Delete the delivery service request</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+</div>
</div>
@@ -237,16 +274,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/quick_howto/multi_site.html b/docs/latest/admin/quick_howto/multi_site.html
index aeca9a2..9fcd81e 100644
--- a/docs/latest/admin/quick_howto/multi_site.html
+++ b/docs/latest/admin/quick_howto/multi_site.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configure Multi Site Origin — Traffic Control 2.1-dev documentation </title>
+ <title>Configure Multi Site Origin — Traffic Control 2.2-dev documentation </title>
@@ -33,9 +35,12 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Quick How To Guides" href="index.html"/>
- <link rel="next" title="Configure Multi Site Origin (5.x)" href="multi_site_ats5.html"/>
+ <link rel="next" title="Configure DNSSEC" href="dnssec.html"/>
<link rel="prev" title="Quick How To Guides" href="index.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,16 +178,16 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li><a href="index.html">Quick How To Guides</a> »</li>
<li>Configure Multi Site Origin</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/multi_site.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/multi_site.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -182,7 +196,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="multi_site_ats5.html" class="btn btn-neutral float-right" title="Configure Multi Site Origin (5.x)">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="dnssec.html" class="btn btn-neutral float-right" title="Configure DNSSEC">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Quick How To Guides"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -194,7 +208,7 @@
<div class="section" id="configure-multi-site-origin">
<span id="rl-multi-site-origin-qht"></span><h1>Configure Multi Site Origin<a class="headerlink" href="#configure-multi-site-origin" title="Permalink to this headline">¶</a></h1>
<ol class="arabic simple">
-<li>Create “cachegroups” for the origin locations, and assign the appropriate parent-child relationship between the mid cg’s and org cgs (click the image to see full size):</li>
+<li>Create cachegroups for the origin locations, and assign the appropriate parent-child relationship between the mid and org cachegroups (click the image to see full size). Each mid cachegroup can be assigned a primary and secondary origin parent cachegroup. When the mid cache parent configuration is generated, origins in the primary cachegroups will be listed first, followed by origins in the secondary cachegroup. Origin servers assigned to the delivery service that are assigned to neither the primary nor secondary cachegroups will be listed last.</li>
</ol>
<a class="reference internal image-reference" href="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png"><img alt="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" class="align-center" src="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" style="width: 1472.0px; height: 210.0px;" /></a>
<ol class="arabic simple" start="2">
@@ -208,67 +222,92 @@
<ol class="arabic simple" start="4">
<li>Check the multi-site check box in the delivery service screen:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/mso-enable.png"><img alt="../../_images/mso-enable.png" class="align-center" src="../../_images/mso-enable.png" style="width: 1695.0px; height: 1079.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/mso-enable.png"><img alt="../../_images/mso-enable.png" class="align-center" src="../../_images/mso-enable.png" style="width: 1636.0px; height: 1005.0px;" /></a>
<ol class="arabic simple" start="5">
-<li>Assign the org servers to the delivery service that will have the multi site feature:</li>
+<li>Assign the org servers to the delivery service that will have the multi site feature. Org servers assigned to a delivery service with multi-site checked will be assigned to be the origin servers for this DS.</li>
</ol>
<a class="reference internal image-reference" href="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png"><img alt="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" class="align-center" src="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" style="width: 580.0px; height: 343.0px;" /></a>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">“Origin Server Base URL” uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that “Origin Server Base URL” (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The exceptions are:
-1) If there are multiple CDNs created on the same Traffic Ops, delivery services across different CDNs may have the same OFQDN configured.
-2) If several delivery services in the same CDN have the same MSO algorithm configured, they may share the same OFQDN.
-3) If delivery services are assigned with different MID cache groups respectively, they can share the same OFQDN.</p>
-</div>
-<ol class="arabic simple" start="6">
-<li>Select an option from the “Multi Site Origin Algorithm” drop-down list. Four MSO algorithms are supported:</li>
+<p>“Origin Server Base URL” uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that “Origin Server Base URL” (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The exceptions are:</p>
+<ol class="last arabic simple">
+<li>If there are multiple CDNs created on the same Traffic Ops, delivery services across different CDNs may have the same OFQDN configured.</li>
+<li>If several delivery services in the same CDN have the same MSO algorithm configured, they may share the same OFQDN.</li>
+<li>If delivery services are assigned with different MID cache groups respectively, they can share the same OFQDN.</li>
+<li>This OFQDN must be valid - ATS will perform a DNS lookup on this FQDN even if IPs, not DNS, are used in the parent.config.</li>
+<li>The OFQDN entered as the “Origin Server Base URL” will be sent to the origins as a host header. All origins must be configured to respond to this host.</li>
</ol>
+</div>
+<ol class="arabic" start="6">
+<li><p class="first">For ATS 5.x, configure the mid hdr_rewrite on the delivery service, example:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cond</span> <span class="o">%</span><span class="p">{</span><span class="n">REMAP_PSEUDO_HOOK</span><span class="p">}</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_enabled</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_enabled</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_response_codes</span> <span class="s2">"400,404,412"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_response_codes</span> <span class="s2">"502,503"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_timeout</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries_dead_server</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">transaction_active_timeout_in</span> <span class="mi">5</span> <span class="p">[</span><span class="n">L</span><span class="p">]</span> <span class="n">__RETURN__</span>
+</pre></div>
+</div>
+</li>
+<li><p class="first">Create a delivery service profile. This must be done to set the MSO algorithm. Also, as of ATS 6.x, multi-site options must be set as parameters within the parent.config. Header rewrite parameters will be ignored. See <a class="reference external" href="https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/files/parent.config.en.html">ATS parent.config</a> for more details. These parameters are now handled by the creation of a delivery service profile.</p>
+<ol class="loweralpha">
+<li><p class="first">Create a profile of the type DS_PROFILE for the delivery service in question.</p>
+<a class="reference internal image-reference" href="../../_images/ds-profile.png"><img alt="../../_images/ds-profile.png" class="align-center" src="../../_images/ds-profile.png" style="width: 589.0px; height: 269.0px;" /></a>
+</li>
+<li><p class="first">Click “Show profile parameters” to bring up the parameters screen for the profile. Create parameters for the following:</p>
<table border="1" class="docutils">
<colgroup>
-<col width="13%" />
-<col width="87%" />
+<col width="37%" />
+<col width="17%" />
+<col width="24%" />
+<col width="23%" />
</colgroup>
<thead valign="bottom">
-<tr class="row-odd"><th class="head">Option</th>
-<th class="head">Description</th>
+<tr class="row-odd"><th class="head">Parameter Name</th>
+<th class="head">Config File Name</th>
+<th class="head">Value</th>
+<th class="head">ATS parent.config value</th>
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td>Consistent hash</td>
-<td>Origin server selection is based on the consistent hash of requested URLs.</td>
+<tr class="row-even"><td>mso.algorithm</td>
+<td>parent.config</td>
+<td>true, false, strict,
+consistent_hash</td>
+<td>round_robin</td>
</tr>
-<tr class="row-odd"><td>Primary/back</td>
-<td>Round robin selection does not occur. The first origin server is selected unless it fails.
-If the first fails, the second and other following origin servers will be tried by order.
-Order is defined by 2 factors - if the origin server’s cachegroup is configured as the
-parent cachegroup for the mid, then this server will be used as the primary. The same rules
-apply for secondary parents, in order. Within the cachegroups, the rank parameter will sort
-order further. If no parents are defined at the mid, then only rank is considered.</td>
+<tr class="row-odd"><td>mso.parent_retry</td>
+<td>parent.config</td>
+<td>simple_retry, both,
+unavailable_server_retry</td>
+<td>parent_retry</td>
</tr>
-<tr class="row-even"><td>Strict
-round-robin</td>
-<td>MID caches serve requests strictly in turn. For example: origin server 1 serves the first request,
-origin server 2 serves the second request, and so on.</td>
+<tr class="row-even"><td>mso.unavailable_server_retry_responses</td>
+<td>parent.config</td>
+<td>list of server response
+codes, eg “500,502,503”</td>
+<td>defaults to the value
+in records.config
+when unused.</td>
</tr>
-<tr class="row-odd"><td>IP based
-round-robin</td>
-<td>MID cache goes through the origin server list in a round robin-based on the IP address of EDGE cache.</td>
+<tr class="row-odd"><td>mso.max_simple_retries</td>
+<td>parent.config</td>
+<td>Nubmer of retries made
+after a 4xx error</td>
+<td>defaults to the value
+in records.config
+when unused.</td>
+</tr>
+<tr class="row-even"><td>mso.max_unavailable_server_retries</td>
+<td>parent.config</td>
+<td>Nubmer of retries made
+after a 5xx error</td>
+<td>defaults to the value
+in records.config
+when unused.</td>
</tr>
</tbody>
</table>
-<ol class="arabic simple" start="7">
-<li>Optionally, there are two configuration options that can set the order of the origins used if “Primary/backup” is selected for “Multi Site Origin Algorithm”. By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter “rank” should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of “2” precedes OS with the rank of “5”. For any OS, if rank value is not defined in its profile, its rank value will default to “1”. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific backup servers for use at specific locations.</li>
+<a class="reference internal image-reference" href="../../_images/ds_profile_parameters.png"><img alt="../../_images/ds_profile_parameters.png" class="align-center" src="../../_images/ds_profile_parameters.png" style="width: 2840.0px; height: 338.0px;" /></a>
+</li>
+<li><p class="first">In the delivery service page, select the newly created DS_PROFILE and save the delivery service.</p>
+</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/mso-rank.png"><img alt="../../_images/mso-rank.png" class="align-center" src="../../_images/mso-rank.png" style="width: 585.0px; height: 105.6px;" /></a>
-<ol class="arabic simple" start="8">
-<li>Assign the parent.config location parameter to the MID profile:</li>
-</ol>
-<a class="reference internal image-reference" href="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png"><img alt="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" class="align-center" src="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" style="width: 658.0px; height: 601.0px;" /></a>
-<ol class="arabic" start="9">
-<li><p class="first">Configure the mid hdr_rewrite on the delivery service, example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cond</span> <span class="o">%</span><span class="p">{</span><span class="n">REMAP_PSEUDO_HOOK</span><span class="p">}</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_enabled</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_enabled</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_response_codes</span> <span class="s2">"400,404,412"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_response_codes</span> <span class="s2">"502,503"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_timeout</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries_dead_server</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">transaction_active_timeout_in</span> <span class="mi">5</span> <span class="p">[</span><span class="n">L</span><span class="p">]</span> <span class="n">__RETURN__</span>
-</pre></div>
-</div>
</li>
<li><p class="first">Turn on parent_proxy_routing in the MID profile.</p>
</li>
@@ -281,7 +320,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="multi_site_ats5.html" class="btn btn-neutral float-right" title="Configure Multi Site Origin (5.x)">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="dnssec.html" class="btn btn-neutral float-right" title="Configure DNSSEC">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Quick How To Guides"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -308,16 +347,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/quick_howto/regionalgeo.html b/docs/latest/admin/quick_howto/regionalgeo.html
index b4ce2b1..1bd5225 100644
--- a/docs/latest/admin/quick_howto/regionalgeo.html
+++ b/docs/latest/admin/quick_howto/regionalgeo.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configure Regional Geo-blocking (RGB) — Traffic Control 2.1-dev documentation </title>
+ <title>Configure Regional Geo-blocking (RGB) — Traffic Control 2.2-dev documentation </title>
@@ -33,9 +35,12 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Quick How To Guides" href="index.html"/>
- <link rel="next" title="Configure Delivery Service Steering" href="steering.html"/>
+ <link rel="next" title="Configure Anonymous Blocking" href="anonymous_blocking.html"/>
<link rel="prev" title="Configure Federations" href="federations.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,16 +178,16 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li><a href="index.html">Quick How To Guides</a> »</li>
<li>Configure Regional Geo-blocking (RGB)</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/regionalgeo.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/regionalgeo.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -182,7 +196,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="steering.html" class="btn btn-neutral float-right" title="Configure Delivery Service Steering">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="anonymous_blocking.html" class="btn btn-neutral float-right" title="Configure Anonymous Blocking">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="federations.html" class="btn btn-neutral" title="Configure Federations"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -201,7 +215,7 @@
<li>Prepare RGB configuration file</li>
</ol>
<p>RGB uses a configuration file in JSON format to define regional geo-blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"deliveryServices"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
@@ -222,7 +236,7 @@
</pre></div>
</div>
<ul class="simple">
-<li>The value of “deliveryServiceId” shall be equal to the “XML ID” field of the intended delivery service defined on Traffic Ops.</li>
+<li>The value of “deliveryServiceId” shall be equal to the “XML ID” field of the intended delivery service defined on Traffic Ops.</li>
<li>“urlRegex” is to match request URLs. The URLs matching the regex are applicable to the rule.</li>
<li>“geoLocation” currently supports “includePostalCode” and “excludePostalCode” attribute. When “includePostalCode” attribute is used, only the clients whose FSAs are in the “includePostalCode” list are able to view the content represented by “urlRegex”. When “excludePostalCode” is used, any client whose FSA are not in the “excludePostalCode” list are allowed to view the content. “includePostalCode” and “excludePostalCode” are mutually exclusive in one rule. (FSA: Forward Sortation Area, first three postal characters of Canadian postal codes)</li>
<li>“redirectUrl” is the URL that will be responded to the blocked clients. Without a domain name in the URL, the URL will still be served in the same delivery service. Thus Traffic Router will redirect the client to a chosen cache server assigned to the delivery service. If the URL includes a domain name, Traffic Router simply redirects the client to the defined URL. In the later case, the redirect URL must not match the “urlRegex” part to avoid HTTP 302 loop on Traffic Router.</li>
@@ -233,8 +247,8 @@
</ol>
<p>The two new parameters in following table are required to be added into CRConfig.json:</p>
<ul class="simple">
-<li>“regional_geoblocking.polling.url”: the HTTP URL of RGB configuration file. Traffic Router will fetch the file from this URL.</li>
-<li>“regional_geoblocking.polling.interval”: the interval that Traffic Router polls the RGB configuration file.</li>
+<li>“regional_geoblocking.polling.url”: the HTTP URL of RGB configuration file. Traffic Router will fetch the file from this URL.</li>
+<li>“regional_geoblocking.polling.interval”: the interval that Traffic Router polls the RGB configuration file.</li>
</ul>
<a class="reference internal image-reference" href="../../_images/regionalgeo01.png"><img alt="../../_images/regionalgeo01.png" class="align-center" src="../../_images/regionalgeo01.png" style="width: 1234.0px; height: 430.0px;" /></a>
<ol class="arabic simple" start="3">
@@ -244,15 +258,15 @@
<ol class="arabic simple" start="4">
<li>Make configuration effective</li>
</ol>
-<p>Go to Tools->Snapshot CRConfig, perform “Diff CRConfig” and click “Write CRConfig”.</p>
-<a class="reference internal image-reference" href="../../_images/regionalgeo03.png"><img alt="../../_images/regionalgeo03.png" class="align-center" src="../../_images/regionalgeo03.png" style="width: 464.8px; height: 128.8px;" /></a>
+<p>Go to Tools->Snapshot CRConfig, perform “Diff CRConfig” and click “Write CRConfig”.</p>
+<a class="reference internal image-reference" href="../../_images/regionalgeo03.png"><img alt="../../_images/regionalgeo03.png" class="align-center" src="../../_images/regionalgeo03.png" style="width: 464.79999999999995px; height: 128.79999999999998px;" /></a>
<ol class="arabic simple" start="5">
<li>Traffic Router access log with RGB</li>
</ol>
-<p>RGB extends the field of “rtype” and adds a new field “rgb” in Traffic Router access.log to help to monitor the working of this feature.</p>
-<p>For “rtype”, RGALT indicates that a request is redirected to an alternate URL by RGB; RGDENY indicates that a request is denied by RGB because there is no matching rule in JSON for this request.</p>
-<p>For “rgb”, when RGB is enabled, it will be non-empty with following format:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span><span class="n">FSA</span><span class="p">}:{</span><span class="n">allowed</span><span class="o">/</span><span class="n">disallowed</span><span class="p">}:{</span><span class="n">include</span><span class="o">/</span><span class="n">exclude</span> <span class="n">postal</span><span class="p">}:{</span><span class="n">fallback</span> <span class="n">config</span><span class="o">/</span><span class="n">current</span> <span class="n">config</span><span class="p">}:{</span><span class="n">allowed</span> <span class="n">by</span> <span class="n">whitelist</span><span class="o">/</span><span class="n">otherwise</span><span class="p">}</span>
+<p>RGB extends the field of “rtype” and adds a new field “rgb” in Traffic Router access.log to help to monitor the working of this feature.</p>
+<p>For “rtype”, RGALT indicates that a request is redirected to an alternate URL by RGB; RGDENY indicates that a request is denied by RGB because there is no matching rule in JSON for this request.</p>
+<p>For “rgb”, when RGB is enabled, it will be non-empty with following format:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="n">FSA</span><span class="p">}:{</span><span class="n">allowed</span><span class="o">/</span><span class="n">disallowed</span><span class="p">}:{</span><span class="n">include</span><span class="o">/</span><span class="n">exclude</span> <span class="n">postal</span><span class="p">}:{</span><span class="n">fallback</span> <span class="n">config</span><span class="o">/</span><span class="n">current</span> <span class="n">config</span><span class="p">}:{</span><span class="n">allowed</span> <span class="n">by</span> <span class="n">whitelist</span><span class="o">/</span><span class="n">otherwise</span><span class="p">}</span>
</pre></div>
</div>
<ul class="simple">
@@ -263,11 +277,11 @@
<li>{allowed by whitelist/otherwise}: If a request is allowed by whitelist, this flag is set to 1; for all other cases, it is 0.</li>
</ul>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1446442214.685</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">129.100</span><span class="o">.</span><span class="mf">254.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live5.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"N6G:1:X:0:0"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">live5</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1446442214.685</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">129.100</span><span class="o">.</span><span class="mf">254.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://foo.geo2.cdn.com/live5.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"N6G:1:X:0:0"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">live5</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
-<span class="mf">1446442219.181</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">184.68</span><span class="o">.</span><span class="mf">71.9</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live5.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">RGALT</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"-:0:X:0:0"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">low_bitrate</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
+<span class="mf">1446442219.181</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">184.68</span><span class="o">.</span><span class="mf">71.9</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://foo.geo2.cdn.com/live5.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">RGALT</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"-:0:X:0:0"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">low_bitrate</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
-<span class="mf">1446445521.677</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">24.114</span><span class="o">.</span><span class="mf">29.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live51.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">RGDENY</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"L4S:0:-:0:0"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">520</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
+<span class="mf">1446445521.677</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">24.114</span><span class="o">.</span><span class="mf">29.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://foo.geo2.cdn.com/live51.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">RGDENY</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"L4S:0:-:0:0"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">520</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
</pre></div>
</div>
</div>
@@ -278,7 +292,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="steering.html" class="btn btn-neutral float-right" title="Configure Delivery Service Steering">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="anonymous_blocking.html" class="btn btn-neutral float-right" title="Configure Anonymous Blocking">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="federations.html" class="btn btn-neutral" title="Configure Federations"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -305,16 +319,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/quick_howto/steering.html b/docs/latest/admin/quick_howto/steering.html
index 6db6e57..a76b622 100644
--- a/docs/latest/admin/quick_howto/steering.html
+++ b/docs/latest/admin/quick_howto/steering.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configure Delivery Service Steering — Traffic Control 2.1-dev documentation </title>
+ <title>Configure Delivery Service Steering — Traffic Control 2.2-dev documentation </title>
@@ -33,10 +35,13 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Quick How To Guides" href="index.html"/>
- <link rel="next" title="Developer’s Guide" href="../../development/index.html"/>
- <link rel="prev" title="Configure Regional Geo-blocking (RGB)" href="regionalgeo.html"/>
+ <link rel="next" title="Delivery Service Requests" href="ds_requests.html"/>
+ <link rel="prev" title="Configure Anonymous Blocking" href="anonymous_blocking.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,16 +178,16 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li><a href="index.html">Quick How To Guides</a> »</li>
<li>Configure Delivery Service Steering</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/steering.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/steering.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -182,10 +196,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../../development/index.html" class="btn btn-neutral float-right" title="Developer’s Guide">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="ds_requests.html" class="btn btn-neutral float-right" title="Delivery Service Requests">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="regionalgeo.html" class="btn btn-neutral" title="Configure Regional Geo-blocking (RGB)"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="anonymous_blocking.html" class="btn btn-neutral" title="Configure Anonymous Blocking"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -202,7 +216,7 @@
</ol>
<a class="reference internal image-reference" href="../../_images/steering02.png"><img alt="../../_images/steering02.png" class="align-center" src="../../_images/steering02.png" style="width: 811.0px; height: 617.0px;" /></a>
<ol class="arabic simple" start="3">
-<li>Click the ‘Manage Steering Assignments’ button on the delivery service screen to assign targets.</li>
+<li>Click the ‘Manage Steering Assignments’ button on the delivery service screen to assign targets.</li>
</ol>
<a class="reference internal image-reference" href="../../_images/steering03.png"><img alt="../../_images/steering03.png" class="align-center" src="../../_images/steering03.png" style="width: 757.0px; height: 598.0px;" /></a>
<ol class="arabic simple" start="4">
@@ -210,14 +224,14 @@
</ol>
<a class="reference internal image-reference" href="../../_images/steering04.png"><img alt="../../_images/steering04.png" class="align-center" src="../../_images/steering04.png" style="width: 650.0px; height: 487.0px;" /></a>
<ol class="arabic" start="5">
-<li><p class="first">As the steering user, assign weights or orders to target delivery services. Assignments must either have a value for weight or order, but not both. The value of weight must be a positive integer, while the value of order can be any integer. This will require logging in to Traffic Ops first via <code class="docutils literal"><span class="pre">http://to.kabletown.net/api/1.2/user/login</span></code> and storing the mojolicious cookie.</p>
+<li><p class="first">As the steering user, assign weights or orders to target delivery services. Assignments must either have a value for weight or order, but not both. The value of weight must be a positive integer, while the value of order can be any integer. This will require logging in to Traffic Ops first via <code class="docutils literal notranslate"><span class="pre">http://to.kabletown.net/api/1.2/user/login</span></code> and storing the mojolicious cookie.</p>
<blockquote>
-<div><p>Sample cURL: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-H</span> <span class="pre">"Cookie:</span> <span class="pre">mojolicious=xxxyyy"</span> <span class="pre">-XPUT</span> <span class="pre">"https://to.kabletown.net/internal/api/1.2/steering/steering-ds"</span> <span class="pre">-d</span> <span class="pre">@/tmp/steering.json</span></code></p>
+<div><p>Sample cURL: <code class="docutils literal notranslate"><span class="pre">curl</span> <span class="pre">-H</span> <span class="pre">"Cookie:</span> <span class="pre">mojolicious=xxxyyy"</span> <span class="pre">-XPUT</span> <span class="pre">"https://to.kabletown.net/internal/api/1.2/steering/steering-ds"</span> <span class="pre">-d</span> <span class="pre">@/tmp/steering.json</span></code></p>
<p>Sample JSON body:</p>
</div></blockquote>
</li>
</ol>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"targets"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"1000"</span><span class="p">,</span>
@@ -242,12 +256,12 @@
<ol class="arabic" start="6">
<li><p class="first">If desired, the steering user can create filters for the target delivery services.</p>
<blockquote>
-<div><p>Sample cURL: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-H</span> <span class="pre">"Cookie:</span> <span class="pre">mojolicious=xxxyyy"</span> <span class="pre">-XPUT</span> <span class="pre">"https://to.kabletown.net/internal/api/1.2/steering/steering-ds"</span> <span class="pre">-d</span> <span class="pre">@/tmp/steering.json</span></code></p>
+<div><p>Sample cURL: <code class="docutils literal notranslate"><span class="pre">curl</span> <span class="pre">-H</span> <span class="pre">"Cookie:</span> <span class="pre">mojolicious=xxxyyy"</span> <span class="pre">-XPUT</span> <span class="pre">"https://to.kabletown.net/internal/api/1.2/steering/steering-ds"</span> <span class="pre">-d</span> <span class="pre">@/tmp/steering.json</span></code></p>
<p>Sample JSON body:</p>
</div></blockquote>
</li>
</ol>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"filters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">gototarget1</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
@@ -276,7 +290,7 @@
</pre></div>
</div>
<ol class="arabic simple" start="7">
-<li>Any requests to Traffic Router for the steering delivery service should now be routed to target delivery services based on configured weight or order. Example: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-Lvs</span> <span class="pre">http://tr.steering-ds.cdn.kabletown.net/foo</span></code></li>
+<li>Any requests to Traffic Router for the steering delivery service should now be routed to target delivery services based on configured weight or order. Example: <code class="docutils literal notranslate"><span class="pre">curl</span> <span class="pre">-Lvs</span> <span class="pre">http://foo.steering-ds.cdn.kabletown.net/bar</span></code></li>
</ol>
</div>
@@ -286,10 +300,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../../development/index.html" class="btn btn-neutral float-right" title="Developer’s Guide">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="ds_requests.html" class="btn btn-neutral float-right" title="Delivery Service Requests">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="regionalgeo.html" class="btn btn-neutral" title="Configure Regional Geo-blocking (RGB)"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="anonymous_blocking.html" class="btn btn-neutral" title="Configure Anonymous Blocking"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -313,16 +327,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_monitor.html b/docs/latest/admin/traffic_monitor.html
index d80d41b..256545e 100644
--- a/docs/latest/admin/traffic_monitor.html
+++ b/docs/latest/admin/traffic_monitor.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Monitor Administration — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Monitor Administration (Legacy) — Traffic Control 2.2-dev documentation </title>
@@ -33,10 +35,13 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Monitor Administration" href="traffic_monitor_golang.html"/>
- <link rel="prev" title="Traffic Portal Administration" href="traffic_portal.html"/>
+ <link rel="prev" title="Traffic Portal - Using" href="traffic_portal/usingtrafficportal.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Administrator’s Guide</a> »</li>
+ <li><a href="index.html">Administrator’s Guide</a> »</li>
- <li>Traffic Monitor Administration</li>
+ <li>Traffic Monitor Administration (Legacy)</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_monitor.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_monitor.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -183,16 +197,16 @@
<a href="traffic_monitor_golang.html" class="btn btn-neutral float-right" title="Traffic Monitor Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_portal.html" class="btn btn-neutral" title="Traffic Portal Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="traffic_portal/usingtrafficportal.html" class="btn btn-neutral" title="Traffic Portal - Using"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<div role="main" class="document">
- <div class="section" id="traffic-monitor-administration">
-<h1>Traffic Monitor Administration<a class="headerlink" href="#traffic-monitor-administration" title="Permalink to this headline">¶</a></h1>
+ <div class="section" id="traffic-monitor-administration-legacy">
+<h1>Traffic Monitor Administration (Legacy)<a class="headerlink" href="#traffic-monitor-administration-legacy" title="Permalink to this headline">¶</a></h1>
<ul class="simple" id="rl-tm-java">
-<li>These instructions are for the Java Traffic Monitor, for the Golang beta, see <span class="xref std std-ref">rl-tm-golang</span>.</li>
+<li>These instructions are for the legacy Java Traffic Monitor, for the new Golang version, see <a class="reference internal" href="traffic_monitor_golang.html#rl-tm-golang"><span class="std std-ref">here</span></a>.</li>
</ul>
<div class="section" id="installing-traffic-monitor">
<h2>Installing Traffic Monitor<a class="headerlink" href="#installing-traffic-monitor" title="Permalink to this headline">¶</a></h2>
@@ -209,27 +223,27 @@
<li>perl-WWW-Curl</li>
</ul>
<ol class="arabic">
-<li><p class="first">Add the Traffic Monitor server into Traffic Ops using ‘Servers’ -> ‘Add Server’. Set the ‘Type’ field to ‘RASCAL’.</p>
+<li><p class="first">Add the Traffic Monitor server into Traffic Ops using ‘Servers’ -> ‘Add Server’. Set the ‘Type’ field to ‘RASCAL’.</p>
</li>
<li><p class="first">Make sure the FQDN of the Traffic Monitor is resolvable in DNS.</p>
</li>
<li><p class="first">Get the Traffic Monitor RPM.</p>
<p>Sample command:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">wget</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">traffic</span><span class="o">-</span><span class="n">control</span><span class="o">-</span><span class="n">cdn</span><span class="o">.</span><span class="n">net</span><span class="o">/</span><span class="n">downloads</span><span class="o">/</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">0</span><span class="o">/</span><span class="n">RELEASE</span><span class="o">-</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">0</span><span class="o">/</span><span class="n">traffic_monitor</span><span class="o">-</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">0</span><span class="o">-</span><span class="mf">3908.5</span><span class="n">b77f60f</span><span class="o">.</span><span class="n">el6</span><span class="o">.</span><span class="n">x86_64</span><span class="o">.</span><span class="n">rpm</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">wget</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">traffic</span><span class="o">-</span><span class="n">control</span><span class="o">-</span><span class="n">cdn</span><span class="o">.</span><span class="n">net</span><span class="o">/</span><span class="n">downloads</span><span class="o">/</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">0</span><span class="o">/</span><span class="n">RELEASE</span><span class="o">-</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">0</span><span class="o">/</span><span class="n">traffic_monitor</span><span class="o">-</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">0</span><span class="o">-</span><span class="mf">3908.5</span><span class="n">b77f60f</span><span class="o">.</span><span class="n">el6</span><span class="o">.</span><span class="n">x86_64</span><span class="o">.</span><span class="n">rpm</span>
</pre></div>
</div>
</li>
<li><p class="first">Install Traffic Monitor and Perl modules:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">traffic_monitor</span><span class="o">-*.</span><span class="n">rpm</span> <span class="n">perl</span><span class="o">-</span><span class="n">JSON</span> <span class="n">perl</span><span class="o">-</span><span class="n">WWW</span><span class="o">-</span><span class="n">Curl</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">traffic_monitor</span><span class="o">-*.</span><span class="n">rpm</span> <span class="n">perl</span><span class="o">-</span><span class="n">JSON</span> <span class="n">perl</span><span class="o">-</span><span class="n">WWW</span><span class="o">-</span><span class="n">Curl</span>
</pre></div>
</div>
</li>
<li><p class="first">Take the config from Traffic Ops:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_monitor</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">traffic_monitor_config</span><span class="o">.</span><span class="n">pl</span> <span class="n">https</span><span class="p">:</span><span class="o">//<</span><span class="n">traffic</span><span class="o">-</span><span class="n">ops</span><span class="o">-</span><span class="n">URL</span><span class="o">></span> <span class="o"><</span><span class="n">traffic</span><span class="o">-</span><span class="n">ops</span><span class="o">-</span><span class="n">user</span><span class="o">></span><span class="p">:</span><span class="o"><</span><span class="n">traffic</span><span class="o">-</span><span class="n">ops</span><span class="o">-</span><span class="n">password</span><span class="o">></span> <span class="n">prompt</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_monitor</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">traffic_monitor_config</span><span class="o">.</span><span class="n">pl</span> <span class="n">https</span><span class="p">:</span><span class="o">//<</span><span class="n">traffic</span><span class="o">-</span><span class="n">ops</span><span class="o">-</span><span class="n">URL</span><span class="o">></span> <span class="o"><</span><span class="n">traffic</span><span class="o">-</span><span class="n">ops</span><span class="o">-</span><span class="n">user</span><span class="o">></span><span class="p">:</span><span class="o"><</span><span class="n">traffic</span><span class="o">-</span><span class="n">ops</span><span class="o">-</span><span class="n">password</span><span class="o">></span> <span class="n">prompt</span>
</pre></div>
</div>
<p>Sample session:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:kl0tevax prompt
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:kl0tevax prompt
DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net
DEBUG: traffic_ops login: admin:kl0tevax
DEBUG: Config write mode: prompt
@@ -310,13 +324,13 @@
</pre></div>
</div>
</li>
-<li><p class="first">Update the ‘allow_ip’ and ‘allow_ip6’ parameters in the profiles of all caches defined in traffic ops, both edge and mid,
+<li><p class="first">Update the ‘allow_ip’ and ‘allow_ip6’ parameters in the profiles of all caches defined in traffic ops, both edge and mid,
with the address of the traffic monitor being installed, so that the traffic servers will allow this Traffic Monitor
to access the astats plugin.
For details see <a class="reference internal" href="traffic_ops/configuration.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a> in the <em>Configuring Traffic Ops</em> section.</p>
</li>
-<li><p class="first">Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Using</span> <span class="n">CATALINA_BASE</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
+<li><p class="first">Start Tomcat: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Using</span> <span class="n">CATALINA_BASE</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
<span class="n">Using</span> <span class="n">CATALINA_HOME</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
<span class="n">Using</span> <span class="n">CATALINA_TMPDIR</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="n">temp</span>
<span class="n">Using</span> <span class="n">JRE_HOME</span><span class="p">:</span> <span class="o">/</span><span class="n">usr</span>
@@ -326,15 +340,15 @@
</pre></div>
</div>
</li>
-<li><p class="first">Configure tomcat to start automatically: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">chkconfig</span> <span class="pre">tomcat</span> <span class="pre">on</span></code></p>
+<li><p class="first">Configure tomcat to start automatically: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">chkconfig</span> <span class="pre">tomcat</span> <span class="pre">on</span></code></p>
</li>
<li><p class="first">Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host:</p>
<ul class="simple">
-<li>The ‘Cache States’ tab should display all Mid and Edge caches configured in Traffic Ops.</li>
-<li>The ‘DeliveryService States’ tab should display all delivery services configured in Traffic Ops.</li>
+<li>The ‘Cache States’ tab should display all Mid and Edge caches configured in Traffic Ops.</li>
+<li>The ‘DeliveryService States’ tab should display all delivery services configured in Traffic Ops.</li>
</ul>
</li>
-<li><p class="first">In Traffic Ops servers table, click ‘Edit’ for this server, then click ‘Online’.</p>
+<li><p class="first">In Traffic Ops servers table, click ‘Edit’ for this server, then click ‘Online’.</p>
</li>
</ol>
</div>
@@ -342,8 +356,8 @@
<h2>Configuring Traffic Monitor<a class="headerlink" href="#configuring-traffic-monitor" title="Permalink to this headline">¶</a></h2>
<div class="section" id="configuration-overview">
<h3>Configuration Overview<a class="headerlink" href="#configuration-overview" title="Permalink to this headline">¶</a></h3>
-<p>Traffic Monitor is configured using its JSON configuration file, <code class="docutils literal"><span class="pre">/opt/traffic_monitor/conf/traffic_monitor_config.js</span></code>.
-This file is created by <code class="docutils literal"><span class="pre">traffic_monitor_config.pl</span></code> script, and among other things, it contains the Traffic Ops URL and the user:password
+<p>Traffic Monitor is configured using its JSON configuration file, <code class="docutils literal notranslate"><span class="pre">/opt/traffic_monitor/conf/traffic_monitor_config.js</span></code>.
+This file is created by <code class="docutils literal notranslate"><span class="pre">traffic_monitor_config.pl</span></code> script, and among other things, it contains the Traffic Ops URL and the user:password
specified during the invocation of that script.</p>
<p>When started, Traffic Monitor uses this basic configuration to downloads its configuration from Traffic Ops, and begins polling caches.
Once a configurable number of polling cycles completes, health protocol state is available via RESTful JSON endpoints.</p>
@@ -351,7 +365,7 @@
</div>
<div class="section" id="troubleshooting-and-log-files">
<h2>Troubleshooting and log files<a class="headerlink" href="#troubleshooting-and-log-files" title="Permalink to this headline">¶</a></h2>
-<p>Traffic Monitor log files are in <code class="docutils literal"><span class="pre">/opt/traffic_monitor/var/log/</span></code>, and tomcat log files are in <code class="docutils literal"><span class="pre">/opt/tomcat/logs/</span></code>.</p>
+<p>Traffic Monitor log files are in <code class="docutils literal notranslate"><span class="pre">/opt/traffic_monitor/var/log/</span></code>, and tomcat log files are in <code class="docutils literal notranslate"><span class="pre">/opt/tomcat/logs/</span></code>.</p>
</div>
</div>
@@ -364,7 +378,7 @@
<a href="traffic_monitor_golang.html" class="btn btn-neutral float-right" title="Traffic Monitor Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_portal.html" class="btn btn-neutral" title="Traffic Portal Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="traffic_portal/usingtrafficportal.html" class="btn btn-neutral" title="Traffic Portal - Using"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -388,16 +402,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_monitor_golang.html b/docs/latest/admin/traffic_monitor_golang.html
index 0288084..439d405 100644
--- a/docs/latest/admin/traffic_monitor_golang.html
+++ b/docs/latest/admin/traffic_monitor_golang.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Monitor Administration — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Monitor Administration — Traffic Control 2.2-dev documentation </title>
@@ -33,10 +35,13 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Router Administration" href="traffic_router.html"/>
- <link rel="prev" title="Traffic Monitor Administration" href="traffic_monitor.html"/>
+ <link rel="prev" title="Traffic Monitor Administration (Legacy)" href="traffic_monitor.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Administrator’s Guide</a> »</li>
+ <li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Monitor Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_monitor_golang.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_monitor_golang.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -183,7 +197,7 @@
<a href="traffic_router.html" class="btn btn-neutral float-right" title="Traffic Router Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor Administration (Legacy)"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -192,13 +206,13 @@
<div class="section" id="traffic-monitor-administration">
<h1>Traffic Monitor Administration<a class="headerlink" href="#traffic-monitor-administration" title="Permalink to this headline">¶</a></h1>
<ul class="simple" id="rl-tm-golang">
-<li>These instructions are for the beta Golang Traffic Monitor, for the old Java version, see <span class="xref std std-ref">rl-tm-java</span>.</li>
+<li>These instructions are for the Golang Traffic Monitor, for the legacy Java version, see <a class="reference internal" href="traffic_monitor.html#rl-tm-java"><span class="std std-ref">here</span></a>.</li>
</ul>
<div class="section" id="installing-traffic-monitor">
<h2>Installing Traffic Monitor<a class="headerlink" href="#installing-traffic-monitor" title="Permalink to this headline">¶</a></h2>
<p>The following are requirements to ensure an accurate set up:</p>
<ul class="simple">
-<li>CentOS 6</li>
+<li>CentOS 6+</li>
<li>8 vCPUs</li>
<li>16GB RAM</li>
<li>Successful install of Traffic Ops</li>
@@ -210,12 +224,12 @@
</li>
<li><p class="first">Make sure the FQDN of the Traffic Monitor is resolvable in DNS.</p>
</li>
-<li><p class="first">Install Traffic Monitor: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">-y</span> <span class="pre">install</span> <span class="pre">traffic_monitor</span></code></p>
+<li><p class="first">Install Traffic Monitor: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">-y</span> <span class="pre">install</span> <span class="pre">traffic_monitor</span></code></p>
</li>
-<li><p class="first">Configure Traffic Monitor. See <span class="xref std std-ref">rl-tm-configure</span></p>
+<li><p class="first">Configure Traffic Monitor. See <a class="reference internal" href="#rl-tm-configure"><span class="std std-ref">here</span></a></p>
</li>
-<li><p class="first">Start the service: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">traffic_monitor</span> <span class="pre">start</span></code></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Starting</span> <span class="n">traffic_monitor</span><span class="p">:</span>
+<li><p class="first">Start the service: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">traffic_monitor</span> <span class="pre">start</span></code></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Starting</span> <span class="n">traffic_monitor</span><span class="p">:</span>
</pre></div>
</div>
</li>
@@ -227,15 +241,15 @@
<h2>Configuring Traffic Monitor<a class="headerlink" href="#configuring-traffic-monitor" title="Permalink to this headline">¶</a></h2>
<div class="section" id="configuration-overview">
<h3>Configuration Overview<a class="headerlink" href="#configuration-overview" title="Permalink to this headline">¶</a></h3>
-<p id="rl-tm-configure">Traffic Monitor is configured via two JSON configuration files, <code class="docutils literal"><span class="pre">traffic_ops.cfg</span></code> and <code class="docutils literal"><span class="pre">traffic_monitor.cfg</span></code>, by default located in the <code class="docutils literal"><span class="pre">conf</span></code> directory in the install location.</p>
-<p>The <code class="docutils literal"><span class="pre">traffic_ops.cfg</span></code> config contains Traffic Ops connection information. Specify the URL, username, and password for the instance of Traffic Ops for which this Traffic Monitor is a member.</p>
-<p>The <code class="docutils literal"><span class="pre">traffic_monitor.cfg</span></code> config contains log file locations, as well as detailed application configuration variables, such as processing flush times and initial poll intervals.</p>
+<p id="rl-tm-configure">Traffic Monitor is configured via two JSON configuration files, <code class="docutils literal notranslate"><span class="pre">traffic_ops.cfg</span></code> and <code class="docutils literal notranslate"><span class="pre">traffic_monitor.cfg</span></code>, by default located in the <code class="docutils literal notranslate"><span class="pre">conf</span></code> directory in the install location.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">traffic_ops.cfg</span></code> config contains Traffic Ops connection information. Specify the URL, username, and password for the instance of Traffic Ops for which this Traffic Monitor is a member.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">traffic_monitor.cfg</span></code> config contains log file locations, as well as detailed application configuration variables, such as processing flush times and initial poll intervals.</p>
<p>Once started with the correct configuration, Traffic Monitor downloads its configuration from Traffic Ops and begins polling caches. Once every cache has been polled, health protocol state is available via RESTful JSON endpoints.</p>
</div>
</div>
<div class="section" id="troubleshooting-and-log-files">
<h2>Troubleshooting and log files<a class="headerlink" href="#troubleshooting-and-log-files" title="Permalink to this headline">¶</a></h2>
-<p>Traffic Monitor log files are in <code class="docutils literal"><span class="pre">/opt/traffic_monitor/var/log/</span></code>.</p>
+<p>Traffic Monitor log files are in <code class="docutils literal notranslate"><span class="pre">/opt/traffic_monitor/var/log/</span></code>.</p>
</div>
</div>
@@ -248,7 +262,7 @@
<a href="traffic_router.html" class="btn btn-neutral float-right" title="Traffic Router Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor Administration (Legacy)"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -272,16 +286,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_ops/configuration.html b/docs/latest/admin/traffic_ops/configuration.html
index 3180920..183198e 100644
--- a/docs/latest/admin/traffic_ops/configuration.html
+++ b/docs/latest/admin/traffic_ops/configuration.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Ops - Configuring — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Ops - Configuring — Traffic Control 2.2-dev documentation </title>
@@ -33,10 +35,13 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Administrator’s Guide" href="../index.html"/>
<link rel="next" title="Traffic Ops - Using" href="using.html"/>
- <link rel="prev" title="Traffic Ops - Migrating from 1.x to 2.x" href="migration_from_10_to_20.html"/>
+ <link rel="prev" title="Traffic Ops - Migrating from 2.0 to 2.2" href="migration_from_20_to_22.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li>Traffic Ops - Configuring</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/traffic_ops/configuration.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/traffic_ops/configuration.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -183,7 +197,7 @@
<a href="using.html" class="btn btn-neutral float-right" title="Traffic Ops - Using">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="migration_from_10_to_20.html" class="btn btn-neutral" title="Traffic Ops - Migrating from 1.x to 2.x"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="migration_from_20_to_22.html" class="btn btn-neutral" title="Traffic Ops - Migrating from 2.0 to 2.2"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -199,7 +213,7 @@
<h3>Self-signed Certificate (Development)<a class="headerlink" href="#self-signed-certificate-development" title="Permalink to this headline">¶</a></h3>
<blockquote>
<div><p>Example Procedure:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ openssl genrsa -des3 -passout pass:x -out localhost.pass.key 2048
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ openssl genrsa -des3 -passout pass:x -out localhost.pass.key 2048
Generating RSA private key, 2048 bit long modulus
...
$ openssl rsa -passin pass:x -in localhost.pass.key -out localhost.key
@@ -245,7 +259,7 @@
<p class="last">You will need to know the appropriate answers when generating the certificate request file <cite>trafficopss.csr</cite> below.</p>
</div>
<p>Example Procedure:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ openssl genrsa -des3 -passout pass:x -out trafficops.pass.key 2048
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ openssl genrsa -des3 -passout pass:x -out trafficops.pass.key 2048
Generating RSA private key, 2048 bit long modulus
...
$ openssl rsa -passin pass:x -in trafficops.pass.key -out trafficops.key
@@ -300,7 +314,7 @@
</div>
<div class="section" id="profile-parameters">
<span id="rl-param-prof"></span><h2>Profile Parameters<a class="headerlink" href="#profile-parameters" title="Permalink to this headline">¶</a></h2>
-<p>Many of the settings for the different servers in a Traffic Control CDN are controlled by parameters in the parameter view of Traffic Ops. Parameters are grouped in profiles and profiles are assigned to a server or a deliveryservice. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings. To make life easier, Traffic Ops allows for duplication, comparison, import and export of Profiles. Traffic Ops also has a “Global profile” - the parameters in this profile are going to be applied to all servers in the Traffic Ops instance, or apply to Traffic Ops themselves. These parameters are:</p>
+<p>Many of the settings for the different servers in a Traffic Control CDN are controlled by parameters in the parameter view of Traffic Ops. Parameters are grouped in profiles and profiles are assigned to a server or a deliveryservice. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings. To make life easier, Traffic Ops allows for duplication, comparison, import and export of Profiles. Traffic Ops also has a “Global profile” - the parameters in this profile are going to be applied to all servers in the Traffic Ops instance, or apply to Traffic Ops themselves. These parameters are:</p>
<table border="1" class="docutils" id="index-0">
<colgroup>
<col width="15%" />
@@ -327,11 +341,11 @@
</tr>
<tr class="row-even"><td>tm.toolname</td>
<td>global</td>
-<td>The name of the Traffic Ops tool. Usually “Traffic Ops”. Used in the About screen and in the comments headers of the files generated.</td>
+<td>The name of the Traffic Ops tool. Usually “Traffic Ops”. Used in the About screen and in the comments headers of the files generated.</td>
</tr>
<tr class="row-odd"><td>tm.infourl</td>
<td>global</td>
-<td>This is the “for more information go here” URL, which is visible in the About page.</td>
+<td>This is the “for more information go here” URL, which is visible in the About page.</td>
</tr>
<tr class="row-even"><td>tm.logourl</td>
<td>global</td>
@@ -356,6 +370,12 @@
<td>CRConfig.json</td>
<td>The location to get the IPv6 GeoLiteCity database from.</td>
</tr>
+<tr class="row-odd"><td>maxmind.default.override</td>
+<td>CRConfig.json</td>
+<td>The destination geo coordinates to use for client location when maxmind returns a default location that matches the country code.
+This parameter can be specified multiple times with different values to support default overrides for multiple countries.
+Format: <CountryCode>;<Lat>,<Long> Ex: US;37.751,-97.822</td>
+</tr>
</tbody>
</table>
<p>These parameters should be set to reflect the local environment.</p>
@@ -390,7 +410,7 @@
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">The Traffic Server profiles contain some information that is specific to the hardware being used (most notably the disk configuration), so some parameters will have to be changed to reflect your configuration. Future releases of Traffic Control will separate the hardware and software profiles so it is easier to “mix-and-match” different hardware configurations.</p>
+<p class="last">The Traffic Server profiles contain some information that is specific to the hardware being used (most notably the disk configuration), so some parameters will have to be changed to reflect your configuration. Future releases of Traffic Control will separate the hardware and software profiles so it is easier to “mix-and-match” different hardware configurations.</p>
</div>
<p>Below is a list of cache parameters that are likely to need changes from the default profiles shipped with Traffic Ops:</p>
<table border="1" class="docutils">
@@ -418,11 +438,11 @@
</tr>
<tr class="row-even"><td>Drive_Prefix</td>
<td>storage.config</td>
-<td>The device path start of the disks. For example, if you have <code class="docutils literal"><span class="pre">/dev/sda</span></code> through <code class="docutils literal"><span class="pre">/dev/sdf</span></code> set this to <code class="docutils literal"><span class="pre">/dev/sd</span></code></td>
+<td>The device path start of the disks. For example, if you have <code class="docutils literal notranslate"><span class="pre">/dev/sda</span></code> through <code class="docutils literal notranslate"><span class="pre">/dev/sdf</span></code> set this to <code class="docutils literal notranslate"><span class="pre">/dev/sd</span></code></td>
</tr>
<tr class="row-odd"><td>Drive_Letters</td>
<td>storage.config</td>
-<td>The letter part of the disks, in the same example as above set this to <code class="docutils literal"><span class="pre">a,b,c,d,e,f</span></code></td>
+<td>The letter part of the disks, in the same example as above set this to <code class="docutils literal notranslate"><span class="pre">a,b,c,d,e,f</span></code></td>
</tr>
<tr class="row-even"><td>purge_allow_ip</td>
<td>ip_allow.config</td>
@@ -452,7 +472,7 @@
availableBandwidthInKbps</td>
<td>rascal.properties</td>
<td>The amount of bandwidth that Traffic Router will try to keep available on the cache.
-For example: “”>1500000” means stop sending new traffic to this cache when traffic is at 8.5Gbps on a 10Gbps interface.</td>
+For example: “”>1500000” means stop sending new traffic to this cache when traffic is at 8.5Gbps on a 10Gbps interface.</td>
</tr>
</tbody>
</table>
@@ -485,7 +505,7 @@
<tr class="row-even"><td>regex_revalidate</td>
<td>plugin.config</td>
<td>The config to be used for regex_revalidate.
-For example: –config regex_revalidate.config</td>
+For example: –config regex_revalidate.config</td>
<td><a class="reference external" href="https://docs.trafficserver.apache.org/en/5.3.x/reference/plugins/regex_remap.en.html">regex_revalidate</a></td>
</tr>
<tr class="row-odd"><td>remap_stats</td>
@@ -496,15 +516,42 @@
</tr>
</tbody>
</table>
+<p>Below is a list of cache parameters for special configuration, which are unlikely to need changes, but may be useful in particular circumstances:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="11%" />
+<col width="73%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Config file</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>not_a_parent</td>
+<td>parent.config</td>
+<td>This is a boolean flag and is considered true if it exists and has any value except ‘false’.
+This prevents servers with this parameter in their profile from being inserted into the parent.config generated for
+servers with this server’s cachegroup as a parent of their cachegroup. This is primarily useful for when edge caches
+are configured to have a cachegroup of other edge caches as parents (a highly unusual configuration), and it is
+necessary to exclude some, but not all, edges in the parent cachegroup from the parent.config (for example, because they
+lack necessary capabilities), but still have all edges in the same cachegroup in order to take traffic from ordinary
+delivery services at that cachegroup’s geo location. Once again, this is a highly unusual scenario, and under ordinary
+circumstances this parameter should not exist.</td>
+</tr>
+</tbody>
+</table>
</div>
<div class="section" id="regions-locations-and-cache-groups">
<h2>Regions, Locations and Cache Groups<a class="headerlink" href="#regions-locations-and-cache-groups" title="Permalink to this headline">¶</a></h2>
-<p>All servers have to have a <cite>location</cite>, which is their physical location. Each location is part of a <cite>region</cite>, and each region is part of a <cite>division</cite>. For Example, <code class="docutils literal"><span class="pre">Denver</span></code> could be a location in the <code class="docutils literal"><span class="pre">Mile</span> <span class="pre">High</span></code> region and that region could be part of the <code class="docutils literal"><span class="pre">West</span></code> division. Enter your divisions first in <cite>Misc->Divisions</cite>, then enter the regions in <cite>Misc->Regions</cite>, referencing the divisions entered, and finally, enter the physical locations in <cite>Misc->Locations</cite>, referencing the regions entered.</p>
-<p>All servers also have to be part of a <cite>cache group</cite>. A cache group is a logical grouping of caches, that don’t have to be in the same physical location (in fact, usually a cache group is spread across minimally 2 physical Locations for redundancy purposes), but share geo coordinates for content routing purposes. JvD to add more.</p>
+<p>All servers have to have a <cite>location</cite>, which is their physical location. Each location is part of a <cite>region</cite>, and each region is part of a <cite>division</cite>. For Example, <code class="docutils literal notranslate"><span class="pre">Denver</span></code> could be a location in the <code class="docutils literal notranslate"><span class="pre">Mile</span> <span class="pre">High</span></code> region and that region could be part of the <code class="docutils literal notranslate"><span class="pre">West</span></code> division. Enter your divisions first in <cite>Misc->Divisions</cite>, then enter the regions in <cite>Misc->Regions</cite>, referencing the divisions entered, and finally, enter the physical locations in <cite>Misc->Locations</cite>, referencing the regions entered.</p>
+<p>All servers also have to be part of a <cite>cache group</cite>. A cache group is a logical grouping of caches, that don’t have to be in the same physical location (in fact, usually a cache group is spread across minimally 2 physical Locations for redundancy purposes), but share geo coordinates for content routing purposes. JvD to add more.</p>
</div>
<div class="section" id="configuring-content-purge">
<h2>Configuring Content Purge<a class="headerlink" href="#configuring-content-purge" title="Permalink to this headline">¶</a></h2>
-<p>Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html">Regex Revalidate Plugin</a> to purge content from the system. We don’t actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it’s config file, and will pick up changes to it without a <cite>traffic_line -x</cite> signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the lower tiers with the content that should be purged from the higher tiers without hitting the origin. This is why the ort script (see <a class="reference internal" href="../traffic_server.html#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a>) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the <cite>regex_revalidate.config</cite> file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the <cite>regex_revalidate.config</cite> file.</p>
+<p>Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html">Regex Revalidate Plugin</a> to purge content from the system. We don’t actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it’s config file, and will pick up changes to it without a <cite>traffic_line -x</cite> signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the lower tiers with the content that should be purged from the higher tiers without hitting the origin. This is why the ort script (see <a class="reference internal" href="../traffic_server.html#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a>) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the <cite>regex_revalidate.config</cite> file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the <cite>regex_revalidate.config</cite> file.</p>
<p>Content Purge is controlled by the following parameters in the profile of the cache:</p>
<table border="1" class="docutils">
<colgroup>
@@ -534,7 +581,7 @@
<tr class="row-even"><td>regex_revalidate</td>
<td>plugin.config</td>
<td>The config to be used for regex_revalidate.
-For example: –config regex_revalidate.config</td>
+For example: –config regex_revalidate.config</td>
<td><a class="reference external" href="https://docs.trafficserver.apache.org/en/5.3.x/reference/plugins/regex_remap.en.html">regex_revalidate</a></td>
</tr>
<tr class="row-odd"><td>use_reval_pending</td>
@@ -550,7 +597,7 @@
<p>Note that the TTL the adminstrator enters in the purge request should be longer than the TTL of the content to ensure the bad content will not be used. If the CDN is serving content of unknown, or unlimited TTL, the administrator should consider using <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html#proxy-config-http-cache-guaranteed-min-lifetime">proxy-config-http-cache-guaranteed-min-lifetime</a> to limit the maximum time an object can be in the cache before it is considered stale, and set that to the same value as <cite>maxRevalDurationDays</cite> (Note that the former is in seconds and the latter is in days, so convert appropriately).</p>
<div class="section" id="creating-the-centos-kickstart-file">
<span id="creating-centos-kickstart"></span><h3>Creating the CentOS Kickstart File<a class="headerlink" href="#creating-the-centos-kickstart-file" title="Permalink to this headline">¶</a></h3>
-<p>The kickstart file is a text file, containing a list of items, each identified by a keyword. You can create it by using the Kickstart Configurator application, or writing it from scratch. The Red Hat Enterprise Linux installation program also creates a sample kickstart file based on the options that you selected during installation. It is written to the file <code class="docutils literal"><span class="pre">/root/anaconda-ks.cfg</span></code>. This file is editable using most text editors that can save files as ASCII text.</p>
+<p>The kickstart file is a text file, containing a list of items, each identified by a keyword. You can create it by using the Kickstart Configurator application, or writing it from scratch. The Red Hat Enterprise Linux installation program also creates a sample kickstart file based on the options that you selected during installation. It is written to the file <code class="docutils literal notranslate"><span class="pre">/root/anaconda-ks.cfg</span></code>. This file is editable using most text editors that can save files as ASCII text.</p>
<p>To generate ISO, the CentOS Kickstart is necessary:</p>
<ol class="arabic simple">
<li>Create a kickstart file.</li>
@@ -559,7 +606,7 @@
<li>Start the kickstart installation.</li>
</ol>
<p>Create a ks.src file in the root of the selection location. See the example below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">newdir</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">newdir</span>
<span class="n">cd</span> <span class="n">newdir</span><span class="o">/</span>
<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="o">../</span><span class="n">centos65</span><span class="o">/*</span> <span class="o">.</span>
<span class="n">vim</span> <span class="n">ks</span><span class="o">.</span><span class="n">src</span>
@@ -579,6 +626,11 @@
</div>
</div>
</div>
+<div class="section" id="configuring-the-go-application">
+<h2>Configuring the Go Application<a class="headerlink" href="#configuring-the-go-application" title="Permalink to this headline">¶</a></h2>
+<p>Traffic Ops is in the process of migrating from Perl to Go, and currently runs as two applications. The Go application serves all endpoints which have been rewritten in the Go language, and transparently proxies all other requests to the old Perl application. Both applications are installed by the RPM, and both run as a single service. When the project has fully migrated to Go, the Perl application will be removed, and the RPM and service will consist solely of the Go application.</p>
+<p>By default, the postinstall script configures the Go application to behave and transparently serve as the old Perl Traffic Ops did in previous versions. This includes reading the old <code class="docutils literal notranslate"><span class="pre">cdn.conf</span></code> and <code class="docutils literal notranslate"><span class="pre">database.conf</span></code> config files, and logging to the old <code class="docutils literal notranslate"><span class="pre">access.log</span></code> location. However, if you wish to customize the Go Traffic Ops application, you can do so by running it with the <code class="docutils literal notranslate"><span class="pre">-oldcfg=false</span></code> argument. By default, it will then look for a config file in <code class="docutils literal notranslate"><span class="pre">/opt/traffic_ops/conf/traffic_ops_golang.config</span></code>. The new config file location may also be customized via the <code class="docutils literal notranslate"><span class="pre">-cfg</span></code> flag. A sample config file is installed by the RPM at <code class="docutils literal notranslate"><span class="pre">/opt/traffic_ops/conf/traffic_ops_golang.config</span></code>. If you wish to run the new Go Traffic Ops application as a service with a new config file, the <code class="docutils literal notranslate"><span class="pre">-oldcfg=false</span></code> and <code class="docutils literal notranslate"><span class="pre">-cfg</span></code> flags may be added to the <code class="docutils literal notranslate"><span class="pre">start</span></code> function in the service file, located by default at <code class="docutils literal notranslate"><span class="pre">etc/init.d/traffic_ops</span></code>.</p>
+</div>
</div>
@@ -590,7 +642,7 @@
<a href="using.html" class="btn btn-neutral float-right" title="Traffic Ops - Using">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="migration_from_10_to_20.html" class="btn btn-neutral" title="Traffic Ops - Migrating from 1.x to 2.x"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="migration_from_20_to_22.html" class="btn btn-neutral" title="Traffic Ops - Migrating from 2.0 to 2.2"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -614,16 +666,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_ops/default_profiles.html b/docs/latest/admin/traffic_ops/default_profiles.html
index a9d5254..a595fa7 100644
--- a/docs/latest/admin/traffic_ops/default_profiles.html
+++ b/docs/latest/admin/traffic_ops/default_profiles.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Ops - Default Profiles — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Ops - Default Profiles — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Administrator’s Guide" href="../index.html"/>
<link rel="next" title="Traffic Ops - Migrating from 1.x to 2.x" href="migration_from_10_to_20.html"/>
<link rel="prev" title="Traffic Ops - Installing" href="installation.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li>Traffic Ops - Default Profiles</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/traffic_ops/default_profiles.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/traffic_ops/default_profiles.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -210,10 +224,10 @@
<h2>Steps to Import a Profile<a class="headerlink" href="#steps-to-import-a-profile" title="Permalink to this headline">¶</a></h2>
<ol class="arabic simple">
<li>Sign into Traffic Ops</li>
-<li>Navigate to ‘Parameters->Select Profile’</li>
-<li>Click the “Import Profile” button at the bottom</li>
+<li>Navigate to ‘Parameters->Select Profile’</li>
+<li>Click the “Import Profile” button at the bottom</li>
<li>Choose the specific profile you want to import from your download directory</li>
-<li>Click ‘Submit’</li>
+<li>Click ‘Submit’</li>
<li>Continue these steps for each <a class="reference internal" href="#rl-to-profiles-min-needed"><span class="std std-ref">Minimum Traffic Ops Profiles needed</span></a> above</li>
</ol>
</div>
@@ -252,16 +266,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_ops/extensions.html b/docs/latest/admin/traffic_ops/extensions.html
index 57b84c5..d815698 100644
--- a/docs/latest/admin/traffic_ops/extensions.html
+++ b/docs/latest/admin/traffic_ops/extensions.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Managing Traffic Ops Extensions — Traffic Control 2.1-dev documentation </title>
+ <title>Managing Traffic Ops Extensions — Traffic Control 2.2-dev documentation </title>
@@ -33,9 +35,12 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Administrator’s Guide" href="../index.html"/>
- <link rel="next" title="Traffic Portal Administration" href="../traffic_portal.html"/>
+ <link rel="next" title="Traffic Portal Administration" href="../traffic_portal/installation.html"/>
<link rel="prev" title="Traffic Ops - Using" href="using.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li>Managing Traffic Ops Extensions</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/traffic_ops/extensions.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/traffic_ops/extensions.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -180,7 +194,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../traffic_portal.html" class="btn btn-neutral float-right" title="Traffic Portal Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../traffic_portal/installation.html" class="btn btn-neutral float-right" title="Traffic Portal Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="using.html" class="btn btn-neutral" title="Traffic Ops - Using"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -191,11 +205,11 @@
<div class="section" id="managing-traffic-ops-extensions">
<span id="admin-to-ext-script"></span><h1>Managing Traffic Ops Extensions<a class="headerlink" href="#managing-traffic-ops-extensions" title="Permalink to this headline">¶</a></h1>
-<p>Each script is a separate bash script located in <code class="docutils literal"><span class="pre">$TO_HOME/bin/checks/</span></code>.</p>
-<p>The extensions must be registered with Traffic Ops in order to display a column on the Server Check page. The list of currently registered extensions can be listed by running <code class="docutils literal"><span class="pre">/opt/traffic_ops/app/bin/extensions</span> <span class="pre">-a</span></code>.</p>
-<p>The below extensions are automatically registered with the Traffic Ops database (<code class="docutils literal"><span class="pre">to_extension</span></code> table) at install time (see <code class="docutils literal"><span class="pre">traffic_ops/app/db/seeds.sql</span></code>). However, cron must still be configured to run these checks periodically.</p>
+<p>Each script is a separate bash script located in <code class="docutils literal notranslate"><span class="pre">$TO_HOME/bin/checks/</span></code>.</p>
+<p>The extensions must be registered with Traffic Ops in order to display a column on the Server Check page. The list of currently registered extensions can be listed by running <code class="docutils literal notranslate"><span class="pre">/opt/traffic_ops/app/bin/extensions</span> <span class="pre">-a</span></code>.</p>
+<p>The below extensions are automatically registered with the Traffic Ops database (<code class="docutils literal notranslate"><span class="pre">to_extension</span></code> table) at install time (see <code class="docutils literal notranslate"><span class="pre">traffic_ops/app/db/seeds.sql</span></code>). However, cron must still be configured to run these checks periodically.</p>
<p>The scripts are called as follows:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
where:
<name> is the type of check script
@@ -206,8 +220,8 @@
</div>
<div class="section" id="example-cron-file">
<h2>Example Cron File<a class="headerlink" href="#example-cron-file" title="Permalink to this headline">¶</a></h2>
-<p>Edit with <code class="docutils literal"><span class="pre">crontab</span> <span class="pre">-e</span></code>. You may need to adjust the path to your $TO_HOME to match your system.</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span>
+<p>Edit with <code class="docutils literal notranslate"><span class="pre">crontab</span> <span class="pre">-e</span></code>. You may need to adjust the path to your $TO_HOME to match your system.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span>
<span class="c1"># IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.</span>
<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: [</span><span class="se">\"</span><span class="s2">hostName</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">domainName</span><span class="se">\"</span><span class="s2">]}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
@@ -260,7 +274,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../traffic_portal.html" class="btn btn-neutral float-right" title="Traffic Portal Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../traffic_portal/installation.html" class="btn btn-neutral float-right" title="Traffic Portal Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="using.html" class="btn btn-neutral" title="Traffic Ops - Using"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -287,16 +301,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_ops/installation.html b/docs/latest/admin/traffic_ops/installation.html
index 8a1c5b1..92c2125 100644
--- a/docs/latest/admin/traffic_ops/installation.html
+++ b/docs/latest/admin/traffic_ops/installation.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Ops - Installing — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Ops - Installing — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Administrator’s Guide" href="../index.html"/>
<link rel="next" title="Traffic Ops - Default Profiles" href="default_profiles.html"/>
<link rel="prev" title="Administrator’s Guide" href="../index.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li>Traffic Ops - Installing</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/traffic_ops/installation.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/traffic_ops/installation.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -200,7 +214,7 @@
<li>Access to Centos Base and epel repositories</li>
<li>Access to <a class="reference external" href="http://www.cpan.org/">The Comprehensive Perl Archive Network (CPAN)</a></li>
</ul>
-<p>As of version 2.0 only Postgres is supported as the database. This documentation assumes CentOS 7.2 and Postgresql 9.6.3. For a production install</p>
+<p>As of version 2.0 only Postgres is supported as the database. This documentation assumes CentOS 7.2 and Postgresql 9.6.3 for a production install.</p>
</div>
<div class="section" id="navigating-the-install">
<h2>Navigating the Install<a class="headerlink" href="#navigating-the-install" title="Permalink to this headline">¶</a></h2>
@@ -209,8 +223,8 @@
<li>Install Postgres</li>
</ol>
<blockquote>
-<div><p>For a production install it is best to install postgres on it’s own server/VM. To install postgres, on the postgres host (pg)</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>pg-$ sudo su -
+<div><p>For a production install it is best to install postgres on it’s own server/VM. To install postgres, on the postgres host (pg)</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pg-$ sudo su -
pg-# yum -y update
pg-# yum -y install https://download.postgresql.org/pub/repos/yum/9.6/redhat/rhel-7-x86_64/pgdg-centos96-9.6-3.noarch.rpm
pg-# yum -y install postgresql96-server
@@ -218,12 +232,12 @@
pg-$ /usr/pgsql-9.6/bin/initdb -A md5 -W #-W forces the user to provide a superuser (postgres) password
</pre></div>
</div>
-<p>Edit <code class="docutils literal"><span class="pre">/var/lib/pgsql/9.6/data/pg_hba.conf</span></code> to allow your traffic ops app server access. For example if you are going to install traffic ops on <code class="docutils literal"><span class="pre">99.33.99.1</span></code> add:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>host all all 99.33.99.1/32 md5
+<p>Edit <code class="docutils literal notranslate"><span class="pre">/var/lib/pgsql/9.6/data/pg_hba.conf</span></code> to allow your traffic ops app server access. For example if you are going to install traffic ops on <code class="docutils literal notranslate"><span class="pre">99.33.99.1</span></code> add:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>host all all 99.33.99.1/32 md5
</pre></div>
</div>
-<p>to the appropriate section of this file. Edit the <code class="docutils literal"><span class="pre">/var/lib/pgsql/9.6/data/postgresql.conf</span></code> file to add the approriate listen_addresses or <code class="docutils literal"><span class="pre">listen_addresses</span> <span class="pre">=</span> <span class="pre">'*'</span></code>, and start the database:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>pg-$ exit
+<p>to the appropriate section of this file. Edit the <code class="docutils literal notranslate"><span class="pre">/var/lib/pgsql/9.6/data/postgresql.conf</span></code> file to add the approriate listen_addresses or <code class="docutils literal notranslate"><span class="pre">listen_addresses</span> <span class="pre">=</span> <span class="pre">'*'</span></code>, set <code class="docutils literal notranslate"><span class="pre">timezone</span> <span class="pre">=</span> <span class="pre">'UTC'</span></code>, and start the database:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>pg-$ exit
pg-# systemctl enable postgresql-9.6
pg-# systemctl start postgresql-9.6
pg-# systemctl status postgresql-9.6
@@ -239,29 +253,29 @@
</ol>
<blockquote>
<div><p>Install the postgresql 9.6 yum repository access.</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>to-$ sudo su -
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>to-$ sudo su -
to-# yum -y install https://download.postgresql.org/pub/repos/yum/9.6/redhat/rhel-7-x86_64/pgdg-centos96-9.6-3.noarch.rpm
</pre></div>
</div>
</div></blockquote>
<ol class="arabic" start="4">
<li><p class="first">Install the rpm built in step 2.</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>to-# yum -y install ./dist/traffic_ops-2.0.0-xxxx.yyyyyyy.el7.x86_64.rpm
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>to-# yum -y install ./dist/traffic_ops-2.0.0-xxxx.yyyyyyy.el7.x86_64.rpm
</pre></div>
</div>
</li>
</ol>
<blockquote>
-<div><p>Install some additional packages that it depends on that were not installed as dependecies in the previous step (these are for the 2.0.0 install, this may change, but the pre-installs won’t hurt):</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>to-# yum -y install git
+<div><p>Install some additional packages that it depends on that were not installed as dependecies in the previous step (these are for the 2.0.0 install, this may change, but the pre-installs won’t hurt):</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>to-# yum -y install git
to-# wget -q https://storage.googleapis.com/golang/go1.8.3.linux-amd64.tar.gz
to-# tar -C /usr/local -xzf go1.8.3.linux-amd64.tar.gz
to-# PATH=$PATH:/usr/local/go/bin # go bins are needed in the path for postinstall
to-# go get bitbucket.org/liamstask/goose/cmd/goose
</pre></div>
</div>
-<p>At this point you should be able to login to the database from the <code class="docutils literal"><span class="pre">to</span></code> host to the <code class="docutils literal"><span class="pre">pg</span></code> host like:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>to-# psql -h 99.33.99.1 -U postgres
+<p>At this point you should be able to login to the database from the <code class="docutils literal notranslate"><span class="pre">to</span></code> host to the <code class="docutils literal notranslate"><span class="pre">pg</span></code> host like:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>to-# psql -h 99.33.99.1 -U postgres
Password for user postgres:
psql (9.6.3)
Type "help" for help.
@@ -269,8 +283,8 @@
postgres=#
</pre></div>
</div>
-<p>Use this connectivity to create the user and database. In this example, we use user: <code class="docutils literal"><span class="pre">traffic_ops</span></code>, password: <code class="docutils literal"><span class="pre">tcr0cks</span></code>, database: <code class="docutils literal"><span class="pre">traffic_ops</span></code>:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>to-# psql -U postgres -h 99.33.99.1 -c "CREATE USER traffic_ops WITH ENCRYPTED PASSWORD 'tcr0cks';"
+<p>Use this connectivity to create the user and database. In this example, we use user: <code class="docutils literal notranslate"><span class="pre">traffic_ops</span></code>, password: <code class="docutils literal notranslate"><span class="pre">tcr0cks</span></code>, database: <code class="docutils literal notranslate"><span class="pre">traffic_ops</span></code>:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>to-# psql -U postgres -h 99.33.99.1 -c "CREATE USER traffic_ops WITH ENCRYPTED PASSWORD 'tcr0cks';"
Password for user postgres:
CREATE ROLE
to-# createdb traffic_ops --owner traffic_ops -U postgres -h 99.33.99.1
@@ -278,16 +292,16 @@
to-#
</pre></div>
</div>
-<p>Now, run the following command as root: <code class="docutils literal"><span class="pre">/opt/traffic_ops/install/bin/postinstall</span></code></p>
+<p>Now, run the following command as root: <code class="docutils literal notranslate"><span class="pre">/opt/traffic_ops/install/bin/postinstall</span></code></p>
<p>The postinstall will first get all packages needed from CPAN. This may take a while, expect up to 30 minutes on the first install.
If there are any prompts in this phase, please just answer with the defaults (some CPAN installs can prompt for install questions).</p>
<p>When this phase is complete, you will see:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>Complete! Modules were installed into /opt/traffic_ops/app/local
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>Complete! Modules were installed into /opt/traffic_ops/app/local
</pre></div>
</div>
<p>Some additional files will be installed, and then it will proceed with the next phase of the install, where it will ask you about the local environment for your CDN. Please make sure you remember all your answers and the database answers match the database information previously used to create the database.</p>
<p>Example output:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>===========/opt/traffic_ops/app/conf/production/database.conf===========
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>===========/opt/traffic_ops/app/conf/production/database.conf===========
Database type [Pg]:
Database type: Pg
Database name [traffic_ops]:
@@ -334,8 +348,8 @@
===========/opt/traffic_ops/install/data/json/profiles.json===========
Traffic Ops url [https://localhost]:
Traffic Ops url: https://localhost
-Human-readable CDN Name. (No whitespace, please) [kabletown_cdn]: blue cdn
-Human-readable CDN Name. (No whitespace, please): blue cdn
+Human-readable CDN Name. (No whitespace, please) [kabletown_cdn]: blue_cdn
+Human-readable CDN Name. (No whitespace, please): blue_cdn
DNS sub-domain for which your CDN is authoritative [cdn1.kabletown.net]: blue-cdn.supercdn.net
DNS sub-domain for which your CDN is authoritative: blue-cdn.supercdn.net
Writing json to /opt/traffic_ops/install/data/json/profiles.json
@@ -416,15 +430,13 @@
<div class="section" id="upgrading-traffic-ops">
<h3>Upgrading Traffic Ops<a class="headerlink" href="#upgrading-traffic-ops" title="Permalink to this headline">¶</a></h3>
<p>To upgrade:</p>
-<div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">TODO : review for > 2.0</p>
-</div>
<ol class="arabic simple">
-<li>Enter the following command:<code class="docutils literal"><span class="pre">service</span> <span class="pre">traffic_ops</span> <span class="pre">stop</span></code></li>
-<li>Enter the following command:<code class="docutils literal"><span class="pre">yum</span> <span class="pre">upgrade</span> <span class="pre">traffic_ops</span></code></li>
+<li>Enter the following command:<code class="docutils literal notranslate"><span class="pre">service</span> <span class="pre">traffic_ops</span> <span class="pre">stop</span></code></li>
+<li>Enter the following command:<code class="docutils literal notranslate"><span class="pre">yum</span> <span class="pre">upgrade</span> <span class="pre">traffic_ops</span></code></li>
+<li>Enter the following command from the /opt/traffic_ops/app directory:
+<code class="docutils literal notranslate"><span class="pre">PERL5LIB=/opt/traffic_ops/app/lib:/opt/traffic_ops/app/local/lib/perl5</span> <span class="pre">./db/admin.pl</span> <span class="pre">--env</span> <span class="pre">production</span> <span class="pre">upgrade</span></code></li>
<li>See <a class="reference internal" href="#rl-to-install"><span class="std std-ref">Traffic Ops - Installing</span></a> to run postinstall.</li>
-<li>Enter the following command:<code class="docutils literal"><span class="pre">service</span> <span class="pre">traffic_ops</span> <span class="pre">start</span></code></li>
+<li>Enter the following command:<code class="docutils literal notranslate"><span class="pre">service</span> <span class="pre">traffic_ops</span> <span class="pre">start</span></code></li>
</ol>
</div>
</div>
@@ -463,16 +475,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_ops/migration_from_10_to_20.html b/docs/latest/admin/traffic_ops/migration_from_10_to_20.html
index 12d1d49..64c01a2 100644
--- a/docs/latest/admin/traffic_ops/migration_from_10_to_20.html
+++ b/docs/latest/admin/traffic_ops/migration_from_10_to_20.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Ops - Migrating from 1.x to 2.x — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Ops - Migrating from 1.x to 2.x — Traffic Control 2.2-dev documentation </title>
@@ -33,9 +35,12 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Administrator’s Guide" href="../index.html"/>
- <link rel="next" title="Traffic Ops - Configuring" href="configuration.html"/>
+ <link rel="next" title="Traffic Ops - Migrating from 2.0 to 2.2" href="migration_from_20_to_22.html"/>
<link rel="prev" title="Traffic Ops - Default Profiles" href="default_profiles.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li>Traffic Ops - Migrating from 1.x to 2.x</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/traffic_ops/migration_from_10_to_20.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/traffic_ops/migration_from_10_to_20.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -180,7 +194,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="configuration.html" class="btn btn-neutral float-right" title="Traffic Ops - Configuring">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="migration_from_20_to_22.html" class="btn btn-neutral float-right" title="Traffic Ops - Migrating from 2.0 to 2.2">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="default_profiles.html" class="btn btn-neutral" title="Traffic Ops - Default Profiles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -206,16 +220,16 @@
<h2>Setup the traffic_ops_db directory<a class="headerlink" href="#setup-the-traffic-ops-db-directory" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p>Modify /opt dir permission to make it writable and owned by postgres:postgres</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ sudo chmod 755 /opt
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo chmod 755 /opt
</pre></div>
</div>
<p>Download the Traffic Control tarball for 2.0.0</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ cd /opt
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cd /opt
$ wget https://dist.apache.org/repos/dist/release/incubator/trafficcontrol/<tarball_version>
</pre></div>
</div>
<p>Extract the <strong>traffic_ops_db</strong> dir to <strong>/opt/traffic_ops_db</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ tar -zxvf trafficcontrol-incubating-<version>.tar.gz --strip=1 trafficcontrol-incubating-<version>/traffic_ops_db
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ tar -zxvf trafficcontrol-incubating-<version>.tar.gz --strip=1 trafficcontrol-incubating-<version>/traffic_ops_db
$ sudo chown -R postgres:postgres /opt/traffic_ops_db
</pre></div>
</div>
@@ -223,14 +237,14 @@
</div>
<div class="section" id="migration-preparation">
<h2>Migration Preparation<a class="headerlink" href="#migration-preparation" title="Permalink to this headline">¶</a></h2>
-<p>Be sure there is connectivity between your MySQL server’s IP address/port and your Postgres server’s IP address/port.</p>
+<p>Be sure there is connectivity between your MySQL server’s IP address/port and your Postgres server’s IP address/port.</p>
</div>
<div class="section" id="navigating-the-database-migration">
<h2>Navigating the Database Migration<a class="headerlink" href="#navigating-the-database-migration" title="Permalink to this headline">¶</a></h2>
<p>Begin the database migration after settings up the <strong>/opt/traffic_ops_db</strong> directory</p>
<blockquote>
<div><p>Switch to the postgres user so permissions stay intact.</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>$ su - postgres
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>$ su - postgres
$ cd /opt/traffic_ops_db/
</pre></div>
</div>
@@ -239,7 +253,7 @@
<li><p class="first">Configure the <strong>/opt/traffic_ops_db/pg-migration/mysql-to-postgres.env</strong> migration for your source MySQL and target Postgres settings</p>
</li>
<li><p class="first">Run the migration, watch the console output for any errors (it may take some time)</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>$ ./migrate.sh
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>$ ./migrate.sh
</pre></div>
</div>
</li>
@@ -255,7 +269,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="configuration.html" class="btn btn-neutral float-right" title="Traffic Ops - Configuring">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="migration_from_20_to_22.html" class="btn btn-neutral float-right" title="Traffic Ops - Migrating from 2.0 to 2.2">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="default_profiles.html" class="btn btn-neutral" title="Traffic Ops - Default Profiles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -282,16 +296,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_ops/migration_from_20_to_22.html b/docs/latest/admin/traffic_ops/migration_from_20_to_22.html
new file mode 100644
index 0000000..5b6eca8
--- /dev/null
+++ b/docs/latest/admin/traffic_ops/migration_from_20_to_22.html
@@ -0,0 +1,434 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Traffic Ops - Migrating from 2.0 to 2.2 — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="Administrator’s Guide" href="../index.html"/>
+ <link rel="next" title="Traffic Ops - Configuring" href="configuration.html"/>
+ <link rel="prev" title="Traffic Ops - Migrating from 1.x to 2.x" href="migration_from_10_to_20.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
+
+ <li>Traffic Ops - Migrating from 2.0 to 2.2</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/admin/traffic_ops/migration_from_20_to_22.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="configuration.html" class="btn btn-neutral float-right" title="Traffic Ops - Configuring">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="migration_from_10_to_20.html" class="btn btn-neutral" title="Traffic Ops - Migrating from 1.x to 2.x"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="traffic-ops-migrating-from-2-0-to-2-2">
+<h1>Traffic Ops - Migrating from 2.0 to 2.2<a class="headerlink" href="#traffic-ops-migrating-from-2-0-to-2-2" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="per-deliveryservice-routing-names">
+<h2>Per-DeliveryService Routing Names<a class="headerlink" href="#per-deliveryservice-routing-names" title="Permalink to this headline">¶</a></h2>
+<p>Before this release, DNS Delivery Services were hardcoded to use the name “edge”, i.e. “edge.myds.mycdn.com”, and HTTP Delivery Services use the name “tr” (or previously “ccr”), i.e. “tr.myds.mycdn.com”. As of 2.2, Routing Names will default to “cdn” if left unspecified and can be set to any arbitrary non-dotted hostname.</p>
+<p>Pre-2.2 the HTTP Routing Name is configurable via the http.routing.name option in in the Traffic Router http.properties config file. If your CDN uses that option to change the name from “tr” to something else, then you will need to perform the following steps for each CDN affected:</p>
+<ol class="arabic simple">
+<li>In Traffic Ops, create the following profile parameter (double-check for typos, trailing spaces, etc):</li>
+</ol>
+<blockquote>
+<div><ul class="simple">
+<li><strong>name</strong>: upgrade_http_routing_name</li>
+<li><strong>config file</strong>: temp</li>
+<li><strong>value</strong>: whatever value is used for the affected CDN’s http.routing.name</li>
+</ul>
+</div></blockquote>
+<ol class="arabic simple" start="2">
+<li>Add this parameter to a single profile in the affected CDN</li>
+</ol>
+<p>With those profile parameters in place Traffic Ops can be safely upgraded to 2.2. Before taking a post-upgrade snapshot, make sure to check your Delivery Service example URLs for unexpected Routing Name changes. Once Traffic Ops has been upgraded to 2.2 and a post-upgrade snapshot has been taken, your Traffic Routers can be upgraded to 2.2 (Traffic Routers must be upgraded after Traffic Ops so that they can work with custom per-DeliveryService Routing Names).</p>
+</div>
+<div class="section" id="apache-traffic-server-7-x-cachekey-plugin">
+<h2>Apache Traffic Server 7.x (Cachekey Plugin)<a class="headerlink" href="#apache-traffic-server-7-x-cachekey-plugin" title="Permalink to this headline">¶</a></h2>
+<p>In Traffic Ops 2.2 we have added support for Apache Traffic Server 7.x. With 7.x comes support for the new cachekey plugin which replaces the cacheurl plugin which is now deprecated.
+While not needed immediately it is recommended to start replacing cacheurl usages with cachekey as soon as possible because ATS 6.x already supports the new cachekey plugin.</p>
+<p>It is also recommended to thoroughly vet your cachekey replacement by comparing with an existing key value. There are inconsistencies in the 6.x version of cachekey which have been
+fixed in 7.x (or require this patch(<a class="reference external" href="https://github.com/apache/trafficserver/commit/244288fab01bdad823f9de19dcece62a7e2a0c11">cachekeypatch</a>) on 6.x to match 7.x). So to ensure you have a matching key value you should use the xdebug plugin before fully implementing your cachekey replacement.</p>
+<p>First if you are currently using a regex for your delivery service you will have to remove that existing value. Then you will need to make a new DS profile and assign parameters in
+it to the cachekey.config file.</p>
+<p>Some common parameters are</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>static-prefix - This is used for a simple domain replacement
+separator - Used by cachekey and in general is always a single space
+remove-path - Removes path information from the URL
+remove-all-params - Removes parameters from the URL
+capture-prefix-uri - This is usually used in combination with remove-path and remove-all-params.
+ Capture-prefix-uri will let you use your own full regex value for non simple cases
+</pre></div>
+</div>
+<div class="section" id="examples-of-cacheurl-to-cachekey-replacements">
+<h3>Examples of Cacheurl to Cachekey Replacements<a class="headerlink" href="#examples-of-cacheurl-to-cachekey-replacements" title="Permalink to this headline">¶</a></h3>
+<p><strong>Original regex value:</strong></p>
+<p><code class="docutils literal notranslate"><span class="pre">http://test.net/(.*)</span> <span class="pre">http://test-cdn.net/$1</span></code></p>
+<p><strong>Cachekey parameters:</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="26%" />
+<col width="51%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">File</th>
+<th class="head">Value</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>static-prefix</td>
+<td>cachekey.config</td>
+<td><code class="docutils literal notranslate"><span class="pre">http://test-cdn.net/</span></code></td>
+</tr>
+<tr class="row-odd"><td>separator</td>
+<td>cachekey.config</td>
+<td>(empty space)</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Original regex value:</strong></p>
+<p><code class="docutils literal notranslate"><span class="pre">http://([^?]+)(?:?|$)</span> <span class="pre">http://test-cdn.net/$1</span></code></p>
+<p><strong>Cachekey parameters:</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="18%" />
+<col width="57%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">File</th>
+<th class="head">Value</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>remove-path</td>
+<td>cachekey.config</td>
+<td>true</td>
+</tr>
+<tr class="row-odd"><td>remove-all-params</td>
+<td>cachekey.config</td>
+<td>true</td>
+</tr>
+<tr class="row-even"><td>separator</td>
+<td>cachekey.config</td>
+<td>(empty space)</td>
+</tr>
+<tr class="row-odd"><td>capture-prefix-uri</td>
+<td>cachekey.config</td>
+<td><code class="docutils literal notranslate"><span class="pre">/https?:\/\/([^?]*)/http:\/\/test-cdn.net\/$1/</span></code></td>
+</tr>
+</tbody>
+</table>
+<p>Also note the <code class="docutils literal notranslate"><span class="pre">s?</span></code> used here so that both http and https requests will end up with the same key value</p>
+<p><strong>Original regex value:</strong></p>
+<p><code class="docutils literal notranslate"><span class="pre">http://test.net/([^?]+)(?:\?|$)</span> <span class="pre">http://test-cdn.net/$1</span></code></p>
+<p><strong>Cachekey parameters:</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="25%" />
+<col width="48%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">File</th>
+<th class="head">Value</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>static-prefix</td>
+<td>cachekey.config</td>
+<td><code class="docutils literal notranslate"><span class="pre">http://test-cdn.net/</span></code></td>
+</tr>
+<tr class="row-odd"><td>separator</td>
+<td>cachekey.config</td>
+<td>(empty space)</td>
+</tr>
+<tr class="row-even"><td>remove-all-params</td>
+<td>cachekey.config</td>
+<td>true</td>
+</tr>
+</tbody>
+</table>
+<p>Further documentation on the cachekey plugin can be found at <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cachekey.en.html">ApacheTrafficServerDocs</a></p>
+</div>
+</div>
+<div class="section" id="apache-traffic-server-7-x-logging">
+<h2>Apache Traffic Server 7.x (Logging)<a class="headerlink" href="#apache-traffic-server-7-x-logging" title="Permalink to this headline">¶</a></h2>
+<p>Trafficserver v7 has changed the logging format. Previously this was an xml file and now it is a lua file. Traffic Control compensates for this
+automatically depending upon the filename used for the logging parameters. Previously the file used was <code class="docutils literal notranslate"><span class="pre">logs_xml.config</span></code>, for ATS 7 it is now
+<code class="docutils literal notranslate"><span class="pre">logging.config</span></code>. The same parameters will work this new file, <code class="docutils literal notranslate"><span class="pre">LogFormat.Format</span></code>, <code class="docutils literal notranslate"><span class="pre">LogFormat.Name</span></code>, <code class="docutils literal notranslate"><span class="pre">LogObject.Format</span></code> etc.</p>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="configuration.html" class="btn btn-neutral float-right" title="Traffic Ops - Configuring">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="migration_from_10_to_20.html" class="btn btn-neutral" title="Traffic Ops - Migrating from 1.x to 2.x"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/admin/traffic_ops/using.html b/docs/latest/admin/traffic_ops/using.html
index d4690b7..2b41856 100644
--- a/docs/latest/admin/traffic_ops/using.html
+++ b/docs/latest/admin/traffic_ops/using.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Ops - Using — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Ops - Using — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Administrator’s Guide" href="../index.html"/>
<link rel="next" title="Managing Traffic Ops Extensions" href="extensions.html"/>
<link rel="prev" title="Traffic Ops - Configuring" href="configuration.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Administrator’s Guide</a> »</li>
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
<li>Traffic Ops - Using</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/traffic_ops/using.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/traffic_ops/using.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -295,10 +309,10 @@
<td>Select the parameter list by profile first, then get a table of just the parameters for that profile.</td>
</tr>
<tr class="row-even"><td>Export Profile</td>
-<td>Profiles can be exported from one Traffic Ops instance to another using ‘Select Profile’ and under the “Profile Details” dialog for the desired profile</td>
+<td>Profiles can be exported from one Traffic Ops instance to another using ‘Select Profile’ and under the “Profile Details” dialog for the desired profile</td>
</tr>
<tr class="row-odd"><td>Import Profile</td>
-<td>Profiles can be imported from one Traffic Ops instance to another using the button “Import Profile” after using the “Export Profile” feature</td>
+<td>Profiles can be imported from one Traffic Ops instance to another using the button “Import Profile” after using the “Export Profile” feature</td>
</tr>
<tr class="row-even"><td>Orphaned Parameters</td>
<td>A table of parameters that are not associated to any profile of cache group. These parameters either should be deleted or associated with a profile of cache group.</td>
@@ -307,7 +321,7 @@
</table>
</li>
<li><p class="first"><strong>Tools</strong></p>
-<p>Tools for working with Traffic Ops and it’s servers. Hover over this tab to get the following options:</p>
+<p>Tools for working with Traffic Ops and it’s servers. Hover over this tab to get the following options:</p>
<table border="1" class="docutils">
<colgroup>
<col width="13%" />
@@ -429,7 +443,7 @@
<li><strong>Edge Cache Group</strong>: the edge cache group short name or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.</li>
<li><strong>Healthy</strong>: indicates if this cache is healthy according to the Health Protocol. A row with ALL in any of the columns will always show a <img alt="checkmark" src="../../_images/good.png" />, this column is valid only for individual EDGE caches.</li>
<li><strong>Admin</strong>: shows the administrative status of the server.</li>
-<li><strong>Connections</strong>: the number of connections this cache (or group of caches) has open (<code class="docutils literal"><span class="pre">ats.proxy.process.http.current_client_connections</span></code> from ATS).</li>
+<li><strong>Connections</strong>: the number of connections this cache (or group of caches) has open (<code class="docutils literal notranslate"><span class="pre">ats.proxy.process.http.current_client_connections</span></code> from ATS).</li>
<li><strong>Mbps Out</strong>: the bandwidth being served out if this cache (or group of caches)</li>
</ul>
<p>Since the top line has ALL, ALL, ALL, it shows the total connections and bandwidth for all caches managed by this instance of Traffic Ops.</p>
@@ -440,7 +454,7 @@
</div>
<div class="section" id="server-checks">
<span id="rl-server-checks"></span><h3>Server Checks<a class="headerlink" href="#server-checks" title="Permalink to this headline">¶</a></h3>
-<p>The server checks page is inteded to give an overview of the Servers managed by Traffic Control as well as their status. This data comes from <a class="reference external" href="traffic_ops_extensions.html">Traffic Ops extensions</a>.</p>
+<p>The server checks page is intended to give an overview of the Servers managed by Traffic Control as well as their status. This data comes from <a class="reference external" href="traffic_ops_extensions.html">Traffic Ops extensions</a>.</p>
<table border="1" class="docutils">
<colgroup>
<col width="8%" />
@@ -493,12 +507,12 @@
</div>
<div class="section" id="daily-summary">
<h3>Daily Summary<a class="headerlink" href="#daily-summary" title="Permalink to this headline">¶</a></h3>
-<p>Displays daily max gbps and bytes served for all CDNs. In order for the graphs to appear, the ‘daily_bw_url’ and ‘daily_served_url’ parameters need to be be created, assigned to the global profile, and have a value of a grafana graph. For more information on configuring grafana, see the <a class="reference external" href="traffic_stats.html">Traffic Stats</a> section.</p>
+<p>Displays daily max gbps and bytes served for all CDNs. In order for the graphs to appear, the ‘daily_bw_url’ and ‘daily_served_url’ parameters need to be be created, assigned to the global profile, and have a value of a grafana graph. For more information on configuring grafana, see the <a class="reference external" href="../traffic_stats.html">Traffic Stats</a> section.</p>
</div>
</div>
<div class="section" id="server">
<span id="rl-server"></span><h2>Server<a class="headerlink" href="#server" title="Permalink to this headline">¶</a></h2>
-<p>This view shows a table of all the servers in Traffic Ops. The table columns show the most important details of the server. The <strong>IPAddrr</strong> column is clickable to launch an <code class="docutils literal"><span class="pre">ssh://</span></code> link to this server. The <img alt="graph" src="../../_images/graph.png" /> icon will link to a Traffic Stats graph of this server for caches, and the <img alt="info" src="../../_images/info.png" /> will link to the server status pages for other server types.</p>
+<p>This view shows a table of all the servers in Traffic Ops. The table columns show the most important details of the server. The <strong>IPAddrr</strong> column is clickable to launch an <code class="docutils literal notranslate"><span class="pre">ssh://</span></code> link to this server. The <img alt="graph" src="../../_images/graph.png" /> icon will link to a Traffic Stats graph of this server for caches, and the <img alt="info" src="../../_images/info.png" /> will link to the server status pages for other server types.</p>
<div class="section" id="server-types">
<h3>Server Types<a class="headerlink" href="#server-types" title="Permalink to this headline">¶</a></h3>
<p>These are the types of servers that can be managed in Traffic Ops:</p>
@@ -556,166 +570,235 @@
<p>The fields in the Delivery Service view are:</p>
<table border="1" class="docutils">
<colgroup>
-<col width="19%" />
-<col width="81%" />
+<col width="7%" />
+<col width="93%" />
</colgroup>
-<thead valign="bottom">
-<tr class="row-odd"><th class="head">Name</th>
-<th class="head">Description</th>
-</tr>
-</thead>
<tbody valign="top">
-<tr class="row-even"><td>XML ID</td>
-<td>A unique string that identifies this delivery service.</td>
+<tr class="row-odd"><td>Name</td>
+<td>Description</td>
+</tr>
+<tr class="row-even"><td>Active</td>
+<td>Whether or not this delivery service is active on the CDN and is capable of traffic.</td>
</tr>
<tr class="row-odd"><td>Content Routing Type</td>
-<td>The type of content routing this delivery service will use. See <a class="reference internal" href="#rl-ds-types"><span class="std std-ref">Delivery Service Types</span></a>.</td>
+<td>DNS is the standard routing type for most CDN services. HTTP Redirect is a specialty routing service that is primarily used for video and large file downloads where localization and latency are significant concerns.
+A “Live” routing type should be used for all live services. See <a class="reference internal" href="#rl-ds-types"><span class="std std-ref">Delivery Service Types</span></a>.</td>
</tr>
-<tr class="row-even"><td>Protocol</td>
+<tr class="row-even"><td>Key (XML ID)</td>
+<td>This id becomes a part of the CDN service domain in the form <code class="docutils literal notranslate"><span class="pre">http://cdn.service-key.company.com/</span></code>. Must be all lowercase, no spaces or special characters. May contain dashes.</td>
+</tr>
+<tr class="row-odd"><td>Display Name</td>
+<td>Name of the service that appears in the Traffic portal. No character restrictions.</td>
+</tr>
+<tr class="row-even"><td>Tenant</td>
+<td>Name of company or division of company who owns account. Allows you to group your services and control access. Tenants are setup as a simple hierarchy where you may create parent / child accounts.</td>
+</tr>
+<tr class="row-odd"><td>CDN</td>
+<td>The CDN in which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td>Routing Name</td>
+<td>The routing name to use for the delivery FQDN, i.e. <code class="docutils literal notranslate"><span class="pre"><routing-name>.<deliveryservice>.<cdn-domain></span></code>. It must be a valid hostname without periods. <a class="footnote-reference" href="#id9" id="id1">[2]</a></td>
+</tr>
+<tr class="row-odd"><td>Protocol</td>
<td><p class="first">The protocol to serve this delivery service to the clients with:</p>
<ul class="last simple">
-<li>0 http</li>
-<li>1 https</li>
-<li>2 both http and https</li>
+<li>HTTP: Delivery only HTTP traffic</li>
+<li>HTTPS: Delivery only HTTPS traffic</li>
+<li>HTTP AND HTTPS: Deliver both types of traffic.</li>
+<li>HTTP TO HTTPS: Delivery HTTP traffic as HTTPS traffic</li>
</ul>
</td>
</tr>
-<tr class="row-odd"><td>DSCP Tag</td>
-<td>The DSCP value to mark IP packets to the client with.</td>
+<tr class="row-even"><td>DSCP Tag</td>
+<td>The Differentiated Services Code Point (DSCP) value to mark IP packets to the client with.</td>
</tr>
-<tr class="row-even"><td>Signed URLs</td>
-<td>Use Signed URLs? See <a class="reference internal" href="#rl-signed-urls"><span class="std std-ref">Token Based Authentication</span></a>.</td>
+<tr class="row-odd"><td>Signing Algorithm</td>
+<td><p class="first">Type of URL signing method to sign the URLs:</p>
+<ul class="simple">
+<li>null: token based auth is not enabled for this delivery service.</li>
+<li>“url_sig”: URL Sign token based auth is enabled for this delivery service.</li>
+<li>“uri_signing”: URI Signing token based auth is enabled for this delivery service.</li>
+</ul>
+<p class="last">See <a class="reference internal" href="#rl-signed-urls"><span class="std std-ref">Token Based Authentication</span></a>.</p>
+</td>
+</tr>
+<tr class="row-even"><td>Deep Caching</td>
+<td>Enables clients to be routed to the closest possible “deep” edge caches on a per Delivery Service basis.
+See <a class="reference external" href="http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_router.html#deep-caching-deep-coverage-zone-topology">Deep Caching</a></td>
</tr>
<tr class="row-odd"><td>Query String Handling</td>
<td><p class="first">How to treat query strings:</p>
<ul class="simple">
-<li>0 use in cache key and hand up to origin -this means each unique query string Is treated as a unique URL.</li>
-<li>1 Do not use in cache key, but pass up to origin - this means a 2 URLs that are the same except for the query string will match, and cache HIT, while the origin still sees original query string in the request.</li>
-<li>2 Drop at edge - this means a 2 URLs that are the same except for the query string will match, and cache HIT, while the origin will not see original query string in the request.</li>
+<li>0 use in cache key and hand up to origin: Each unique query string is treated as a unique URL.</li>
+<li>1 Do not use in cache key, but pass up to origin: 2 URLs that are the same except for the query string will match and cache HIT, while the origin still sees original query string in the request.</li>
+<li>2 Drop at edge: 2 URLs that are the same except for the query string will match and cache HIT, while the origin will not see original query string in the request.</li>
</ul>
-<p class="last"><strong>Note:</strong> Choosing to drop query strings at the edge will preclude the use of a Regex Remap Expression. See <a class="reference internal" href="#rl-regex-remap"><span class="std std-ref">Regex Remap Expression</span></a>.
-To set the qstring without the use of regex remap, or for further options, see <a class="reference internal" href="#rl-qstring-handling"><span class="std std-ref">Qstring Handling</span></a>.</p>
+<p><strong>Note:</strong> Choosing to drop query strings at the edge will preclude the use of a Regex Remap Expression. See <a class="reference internal" href="#rl-regex-remap"><span class="std std-ref">Regex Remap Expression</span></a>.</p>
+<p class="last">To set the qstring without the use of regex remap, or for further options, see <a class="reference internal" href="#rl-qstring-handling"><span class="std std-ref">Qstring Handling</span></a>.</p>
</td>
</tr>
-<tr class="row-even"><td>Geo Limit?</td>
-<td><p class="first">Some services are intended to be limited by geography. The possible settings are are:</p>
+<tr class="row-even"><td>Geolocation Provider</td>
+<td>Choose which Geolocation database provider, company that collects data on the location of IP addresses, to use.</td>
+</tr>
+<tr class="row-odd"><td>Anonymous Blocking</td>
+<td>Set to true to enable blocking of anonymous IPs for this delivery service. <strong>Note:</strong> Requires Geolocation provider’s Anonymous IP database.</td>
+</tr>
+<tr class="row-even"><td>Geo Limit</td>
+<td><p class="first">Some services are intended to be limited by geography. The possible settings are:</p>
<ul class="last simple">
-<li>None - Do not limit by geography.</li>
-<li>CZF only - If the requesting IP is not in the Coverage Zone File, do not serve the request.</li>
-<li>CZF + US - If the requesting IP is not in the Coverage Zone File or not in the United States, do not serve the request.</li>
+<li>None: Do not limit by geography.</li>
+<li>CZF only: If the requesting IP is not in the Coverage Zone File, do not serve the request.</li>
+<li>CZF + US: If the requesting IP is not in the Coverage Zone File or not in the United States, do not serve the request.</li>
</ul>
</td>
</tr>
-<tr class="row-odd"><td>Geo Limit Redirect URL</td>
-<td>(for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See <a class="reference internal" href="../traffic_router.html#rl-tr-ngb"><span class="std std-ref">GeoLimit Failure Redirect feature</span></a></td>
+<tr class="row-odd"><td>Geo Limit Countries</td>
+<td>How (if at all) is this service to be limited by geography. Example Country Codes: CA, IN, PR.</td>
</tr>
-<tr class="row-even"><td>Bypass FQDN</td>
-<td>(for HTTP routed delivery services only) This is the FQDN Traffic Router will redirect to (with the same path) when the max Bps or Max Tps for this deliveryservice are exceeded.</td>
+<tr class="row-even"><td>Geo Limit Redirect URL</td>
+<td>Traffic Router will redirect to this URL when Geo Limit check fails. See <a class="reference internal" href="../traffic_router.html#rl-tr-ngb"><span class="std std-ref">GeoLimit Failure Redirect feature</span></a></td>
</tr>
-<tr class="row-odd"><td>Bypass Ipv4</td>
-<td>(For DNS routed delivery services only) This is the address to respond to A requests with when the the max Bps or Max Tps for this delivery service are exceeded.</td>
+<tr class="row-odd"><td>Regional Geoblocking</td>
+<td>Define regional geo-blocking rules for delivery services in a JSON format and set it to True/False.
+See <a class="reference external" href="http://traffic-control-cdn.readthedocs.io/en/latest/admin/quick_howto/regionalgeo.html#configure-regional-geo-blocking-rgb">regional geo-blocking</a></td>
</tr>
-<tr class="row-even"><td>Bypass IPv6</td>
-<td>(For DNS routed delivery services only) This is the address to respond to AAAA requests with when the the max Bps or Max Tps for this delivery service are exceeded.</td>
+<tr class="row-even"><td>IPv6 Routing Enabled</td>
+<td>Default is “True”, entering “False” allows you to turn off CDN response to IPv6 requests</td>
</tr>
-<tr class="row-odd"><td>IPv6 Routing Enabled?</td>
-<td>When set to yes, the Traffic Router will respond to AAAA DNS requests for the tr. and edge. names of this delivery service. Otherwise, only A records will be served.</td>
-</tr>
-<tr class="row-even"><td>Range Request Handling</td>
-<td><p class="first">(experimental) How to treat range requests:</p>
+<tr class="row-odd"><td>Range Request Handling</td>
+<td><p class="first">How to treat range requests:</p>
<ul class="last simple">
-<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
-<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
-<li>2 Use the cache_range_requests plugin.</li>
+<li>0: Do not cache (ranges requested from files that are already cached due to a non range request will be a HIT)</li>
+<li>1: Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2: Use the cache_range_requests plugin.</li>
</ul>
</td>
</tr>
+<tr class="row-even"><td>DNS Bypass IP</td>
+<td>IPv4 address to overflow requests when the Max Bps or Max Tps for this delivery service exceeds.</td>
+</tr>
+<tr class="row-odd"><td>DNS Bypass IPv6</td>
+<td>IPv6 address to overflow requests when the Max Bps or Max Tps for this delivery service exceeds.</td>
+</tr>
+<tr class="row-even"><td>DNS Bypass CNAME</td>
+<td>Domain name to overflow requests when the Max Bps or Max Tps for this delivery service exceeds.</td>
+</tr>
+<tr class="row-odd"><td>DNS Bypass TTL</td>
+<td>TTL for the DNS bypass domain or IP when threshold exceeds</td>
+</tr>
+<tr class="row-even"><td>HTTP Bypass FQDN</td>
+<td>Traffic Router will redirect to this FQDN (with the same path) when the Max Bps or Max Tps for this delivery service exceeds.</td>
+</tr>
<tr class="row-odd"><td>Delivery Service DNS TTL</td>
-<td>The Time To Live on the DNS record for the Traffic Router A and AAAA records (<code class="docutils literal"><span class="pre">tr.<deliveryservice>.<cdn-domain></span></code>) for a HTTP delivery service <em>or</em> for the A and
-AAAA records of the edge name (<code class="docutils literal"><span class="pre">edge.<deliveryservice>.<cdn-domain></span></code>).</td>
+<td>The Time To Live on the DNS record for the Traffic Router A and AAAA records. Setting too high or too low will result in poor caching performance.</td>
</tr>
-<tr class="row-even"><td>Origin Server Base URL</td>
-<td>The Origin Server’s base URL. This includes the protocol (http or https). Example: <code class="docutils literal"><span class="pre">http://movies.origin.com</span></code></td>
+<tr class="row-even"><td>Fair Queuing Pacing Rate Bps</td>
+<td>The maximum bytes per second a cache will delivery on any single TCP connection. This uses the Linux kernel’s Fair Queuing setsockopt (SO_MAX_PACING_RATE) to limit the rate of delivery. Traffic exceeding this speed will only be rate-limited and not diverted. This option requires net.core.default_qdisc = fq in /etc/sysctl.conf.</td>
</tr>
-<tr class="row-odd"><td>Use Multi Site Origin Feature</td>
-<td>Enable the Multi Site Origin feature for this delivery service. See <a class="reference internal" href="#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<tr class="row-odd"><td>Global Max Mbps</td>
+<td>The maximum bits per second this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used (depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used.</td>
</tr>
-<tr class="row-even"><td>Profile</td>
-<td>The profile for this delivery service.</td>
+<tr class="row-even"><td>Global Max TPS</td>
+<td>The maximum transactions per se this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used (depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used.</td>
</tr>
-<tr class="row-odd"><td>Maximum Bits per Second allowed globally</td>
-<td>The maximum bits per second this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used
-(depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used.</td>
+<tr class="row-odd"><td>Max DNS Answers</td>
+<td>It is used to restrict the number of cache IP addresses that the CCR will hand back. A numeric value from 1 to 15 which determines how many caches your content will be spread across in a particular site. When a customer requests your content they will get 1 to 15 IP addresses back they can use. These are rotated in each response. Ideally the number will reflect the amount of traffic. 1 = trial account with very little traffic, 2 = small production service. Add 1 more server for every 20 Gbps of traffic you expect at peak. So 20 Gbps = 3, 40 Gbps = 4, 60 Gbps = 5</td>
</tr>
-<tr class="row-even"><td>Maximum Transactions per Second allowed globally</td>
-<td>The maximum transactions per se this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used
-(depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used.</td>
+<tr class="row-even"><td>Initial Dispersion</td>
+<td>Determines number of machines content will be placed on within a cache group. Setting too high will result in poor caching performance.</td>
</tr>
-<tr class="row-odd"><td>Geo Miss Default Latitude</td>
+<tr class="row-odd"><td>Origin Server Base URL</td>
+<td>The Origin Server’s base URL which includes the protocol (http or https). Example: <code class="docutils literal notranslate"><span class="pre">http://movies.origin.com</span></code>
+Must be a domain only, no directories or IP addresses</td>
+</tr>
+<tr class="row-even"><td>Use Multi Site Origin Feature</td>
+<td>Set True/False to enable/disable the Multi Site Origin feature for this delivery service. See <a class="reference internal" href="#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-odd"><td>Delivery Service Profile</td>
+<td>Only used if a delivery service uses configurations that specifically require a profile. Example: MSO configurations or cachekey plugin would require a ds profile to be used.</td>
+</tr>
+<tr class="row-even"><td>Geo Miss Default Latitude</td>
<td>Default Latitude for this delivery service. When client localization fails for both Coverage Zone and Geo Lookup, this the client will be routed as if it was at this lat.</td>
</tr>
-<tr class="row-even"><td>Geo Miss Default Longitude</td>
+<tr class="row-odd"><td>Geo Miss Default Longitude</td>
<td>Default Longitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this long.</td>
</tr>
-<tr class="row-odd"><td>Edge Header Rewrite Rules</td>
-<td>Header Rewrite rules to apply for this delivery service at the EDGE tier. See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id6" id="id1">[1]</a></td>
+<tr class="row-even"><td>Edge Header Rewrite Rules</td>
+<td><p class="first">Headers can be added or altered at each layer of the CDN. You must tell us four things: the action, the header name, the header value, and the direction to apply. The action will tell us whether we are adding, removing, or replacing headers. The header name and header value will determine the full header text. The direction will determine whether we add it before we respond to a request or before we make a request further up the chain in the server hierarchy. Examples include:</p>
+<ul class="simple">
+<li>Action: Set</li>
+<li>Header Name: X-CDN</li>
+<li>Header Value: Foo</li>
+<li>Direction: Edge Response to Client</li>
+</ul>
+<p class="last">See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id8" id="id2">[1]</a></p>
+</td>
</tr>
-<tr class="row-even"><td>Mid Header Rewrite Rules</td>
-<td>Header Rewrite rules to apply for this delivery service at the MID tier. See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id6" id="id2">[1]</a></td>
+<tr class="row-odd"><td>Mid Header Rewrite Rules</td>
+<td><p class="first">Headers can be added or altered at each layer of the CDN. You must tell us four things: the action, the header name, the header value, and the direction to apply. The action will tell us whether we are adding, removing, or replacing headers. The header name and header value will determine the full header text. The direction will determine whether we add it before we respond to a request or before we make a request further up the chain in the server hierarchy. Examples include:</p>
+<ul class="simple">
+<li>Action: Set</li>
+<li>Header Name: Host</li>
+<li>Header Value: code_abc123</li>
+<li>Direction: Mid Request to Origin</li>
+</ul>
+<p class="last">See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id8" id="id3">[1]</a></p>
+</td>
</tr>
-<tr class="row-odd"><td>Regex Remap Expression</td>
-<td><p class="first">Regex Remap rule to apply to this delivery service at the Edge tier. See <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html">ATS documentation on regex_remap</a>. <a class="footnote-reference" href="#id6" id="id3">[1]</a></p>
+<tr class="row-even"><td>Traffic Router Additional Response Headers</td>
+<td>List of header name:value pairs separated by __RETURN__. Listed pairs will be included in all TR HTTP responses.</td>
+</tr>
+<tr class="row-odd"><td>Traffic Router Log Request Headers</td>
+<td>List of header keys separated by __RETURN__. Listed headers will be included in TR access log entries under the “rh=” token.</td>
+</tr>
+<tr class="row-even"><td>Regex remap expression</td>
+<td><p class="first">Allows remapping of incoming requests URL using regex pattern matching to search/replace text.
+See <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html">ATS documentation on regex_remap</a>. <a class="footnote-reference" href="#id8" id="id4">[1]</a></p>
<p class="last"><strong>Note:</strong> you will not be able to save a Regex Remap Expression if you have Query String Handling set to drop query strings at the edge. See <a class="reference internal" href="#rl-regex-remap"><span class="std std-ref">Regex Remap Expression</span></a>.</p>
</td>
</tr>
-<tr class="row-even"><td>Cache URL expression</td>
-<td>Cache URL rule to apply to this delivery service. See <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cacheurl.en.html">ATS documentation on cacheurl</a>. <a class="footnote-reference" href="#id6" id="id4">[1]</a></td>
+<tr class="row-odd"><td>Cache URL expression</td>
+<td><p class="first">Allows you to manipulate the cache key of the incoming requests. Normally, the cache key is the origin domain. This can be changed so that multiple services can share a cache key, can also be used to preserve cached content if service origin is changed.</p>
+<p><strong>Note:</strong> Only valid in ATS 6.X and earlier. Must be empty if using ATS 7.X and/or the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cachekey.en.html">cachekey plugin</a>. <a class="footnote-reference" href="#id8" id="id5">[1]</a></p>
+<p class="last">See <a class="reference external" href="https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/plugins/cacheurl.en.html">ATS documentation on cacheurl</a>. <a class="footnote-reference" href="#id8" id="id6">[1]</a></p>
+</td>
</tr>
-<tr class="row-odd"><td>Raw remap text</td>
-<td>For HTTP and DNS deliveryservices, this will get added to the end of the remap line on the cache verbatim. For ANY_MAP deliveryservices this is the remap line. <a class="footnote-reference" href="#id6" id="id5">[1]</a></td>
+<tr class="row-even"><td>Raw remap text</td>
+<td>For HTTP and DNS delivery services, this will get added to the end of the remap line on the cache verbatim. For ANY_MAP delivery services this is the remap line. <a class="footnote-reference" href="#id8" id="id7">[1]</a></td>
</tr>
-<tr class="row-even"><td>Long Description</td>
-<td>Long description for this delivery service. To be consumed from the APIs by downstream tools (Portal).</td>
+<tr class="row-odd"><td>Long Description</td>
+<td>Free text field that describes the purpose of the delivery service and will be displayed in the portal as a description field. For example, you can use this field to describe your service.</td>
</tr>
-<tr class="row-odd"><td>Customer</td>
-<td>Customer description for this delivery service. To be consumed from the APIs by downstream tools (Portal).</td>
+<tr class="row-even"><td>Long Description 2</td>
+<td>Free text field not currently used in configuration. For example, you can use this field to describe your customer type.</td>
</tr>
-<tr class="row-even"><td>Service</td>
-<td>Service description for this delivery service. To be consumed from the APIs by downstream tools (Portal).</td>
+<tr class="row-odd"><td>Long Description 3</td>
+<td>Free text field not currently used in configuration.</td>
</tr>
-<tr class="row-odd"><td>Info URL</td>
-<td>Info URL for this delivery service. To be consumed from the APIs by downstream tools (Portal).</td>
+<tr class="row-even"><td>Info URL</td>
+<td>Free text field allowing you to enter a URL which provides information about the service.</td>
</tr>
-<tr class="row-even"><td>Check Path</td>
+<tr class="row-odd"><td>Check Path</td>
<td>A path (ex: /crossdomain.xml) to verify the connection to the origin server with. This can be used by Check Extension scripts to do periodic health checks against the delivery service.</td>
</tr>
-<tr class="row-odd"><td>Origin Shield (Pipe Delimited String)</td>
-<td>Experimental. Origin Shield string.</td>
+<tr class="row-even"><td>Origin Shield (Pipe Delimited String)</td>
+<td>Add another forward proxy upstream of the mid caches. Example: go_direct=true will allow the Mid to hit the origin directly instead of failing if the origin shield is down. Experimental Feature.</td>
</tr>
-<tr class="row-even"><td>Active</td>
-<td>When this is set to no Traffic Router will not serve DNS or HTTP responses for this delivery service.</td>
-</tr>
-<tr class="row-odd"><td>Last Updated</td>
-<td>(Read Only) The last time this delivery service was updated.</td>
-</tr>
-<tr class="row-even"><td>Number of edges assigned</td>
-<td>(Read Only - change by clicking the <strong>Server Assignments</strong> button at the bottom) The number of EDGE caches assigned to this delivery service. See <a class="reference internal" href="#rl-assign-edges"><span class="std std-ref">Server Assignments</span></a>.</td>
-</tr>
-<tr class="row-odd"><td>Number of static DNS entries</td>
-<td>(Read Only - change by clicking the <strong>Static DNS</strong> button at the bottom) The number of static DNS entries for this delivery service. See <a class="reference internal" href="#rl-static-dns"><span class="std std-ref">Static DNS Entries</span></a>.</td>
-</tr>
-<tr class="row-even"><td>Example delivery URL</td>
-<td>(Read Only) An example of how the delivery URL may start. This could be multiple rows if multiple HOST_REGEXP entries have been entered.</td>
-</tr>
-<tr class="row-odd"><td>Regular expressions for this delivery service</td>
-<td>A subtable of the regular expressions to use when routing traffic for this delivery service. See <a class="reference internal" href="#rl-ds-regexp"><span class="std std-ref">Delivery Service Regexp</span></a>.</td>
+<tr class="row-odd"><td>Logs Enabled</td>
+<td>Allows you to turn on/off logging for the service</td>
</tr>
</tbody>
</table>
-<table class="docutils footnote" frame="void" id="id6" rules="none">
+<table class="docutils footnote" frame="void" id="id8" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
-<tr><td class="label">[1]</td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id3">3</a>, <a class="fn-backref" href="#id4">4</a>, <a class="fn-backref" href="#id5">5</a>)</em> These fields are not validated by Traffic Ops to be correct syntactically, and can cause Traffic Server to not start if invalid. Please use with caution.</td></tr>
+<tr><td class="label">[1]</td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id3">2</a>, <a class="fn-backref" href="#id4">3</a>, <a class="fn-backref" href="#id5">4</a>, <a class="fn-backref" href="#id6">5</a>, <a class="fn-backref" href="#id7">6</a>)</em> These fields are not validated by Traffic Ops to be correct syntactically, and can cause Traffic Server to not start if invalid. Please use with caution.</td></tr>
+</tbody>
+</table>
+<table class="docutils footnote" frame="void" id="id9" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label"><a class="fn-backref" href="#id1">[2]</a></td><td>It is not recommended to change the Routing Name of a Delivery Service after deployment because this changes its Delivery FQDN (i.e. <code class="docutils literal notranslate"><span class="pre"><routing-name>.<deliveryservice>.<cdn-domain></span></code>), which means that SSL certificates may need to be updated and clients using the Delivery Service will need to be transitioned to the new Delivery URL.</td></tr>
</tbody>
</table>
<div class="section" id="delivery-service-types">
@@ -745,37 +828,36 @@
<td>HTTP Content Routing, but the caches will not actually cache the content, they act as just proxies. The MID tier is bypassed.</td>
</tr>
<tr class="row-odd"><td>HTTP_LIVE</td>
-<td>HTTP Content routing, but where for “standard” HTTP content routing the objects are stored on disk, for this delivery service type the objects are stored
+<td>HTTP Content routing, but where for “standard” HTTP content routing the objects are stored on disk, for this delivery service type the objects are stored
on the RAM disks. Use this for linear TV. The MID tier is bypassed for this type.</td>
</tr>
<tr class="row-even"><td>HTTP_LIVE_NATNL</td>
<td>HTTP Content routing, same as HTTP_LIVE, but the MID tier is NOT bypassed.</td>
</tr>
<tr class="row-odd"><td>DNS_LIVE_NATNL</td>
-<td>DNS Content routing, but where for “standard” DNS content routing the objects are stored on disk, for this delivery service type the objects are stored
+<td>DNS Content routing, but where for “standard” DNS content routing the objects are stored on disk, for this delivery service type the objects are stored
on the RAM disks. Use this for linear TV. The MID tier is NOT bypassed for this type.</td>
</tr>
<tr class="row-even"><td>DNS_LIVE</td>
<td>DNS Content routing, same as DNS_LIVE_NATNL, but the MID tier is bypassed.</td>
</tr>
<tr class="row-odd"><td>ANY_MAP</td>
-<td>ANY_MAP is not known to Traffic Router. For this deliveryservice, the “Raw remap text” field in the input form will be used as the remap line on the cache.</td>
+<td>ANY_MAP is not known to Traffic Router. For this deliveryservice, the “Raw remap text” field in the input form will be used as the remap line on the cache.</td>
</tr>
<tr class="row-even"><td>STEERING</td>
-<td>The Delivery Service will be used to route to other delivery services. The target delivery services Traffic Router and the routing weights for those delivery services will be defined by an admin or steering user. For more information see the <a class="reference external" href="traffic_router.html#steering-feature">steering feature</a> documentation</td>
+<td>The Delivery Service will be used to route to other delivery services. The target delivery services and the routing weights for those delivery services will be defined by an admin or steering user. For more information see the <a class="reference external" href="../traffic_router.html#steering-feature">steering feature</a> documentation</td>
+</tr>
+<tr class="row-odd"><td>CLIENT_STEERING</td>
+<td>Similar to STEERING except that a client can send a request to Traffic Router with a query param of <cite>trred=false</cite>, and Traffic Router will return an HTTP 200 response with a body that contains a list of Delivery Service URLs that the client can connect to. Therefore, the client is doing the steering, not the Traffic Router.</td>
</tr>
</tbody>
</table>
-<div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">Once created, the Traffic Ops user interface does not allow you to change the delivery service type; the drop down is greyed out. There are many things that can go wrong when changing the type, and it is safer to delete the delivery service, and recreate it.</p>
-</div>
</div>
<div class="section" id="federations">
-<h3>Federations<a class="headerlink" href="#federations" title="Permalink to this headline">¶</a></h3>
+<span id="rl-federations"></span><h3>Federations<a class="headerlink" href="#federations" title="Permalink to this headline">¶</a></h3>
<blockquote>
-<div><p>Federations allow for other (federated) CDNs (at a different ISP, MSO, etc) to add a list of resolvers and a CNAME to a delivery service Traffic Ops. When a request is made from one of federated CDN’s clients, Traffic Router will return the CNAME configured in the federation mapping. This allows the federated CDN to serve the content without the content provider changing the URL, or having to manage multiple URLs.</p>
-<p>Before adding a federation in the Traffic Ops UI, a user with the federations role needs to be created. This user will be assigned to the federation and will be able to add resolvers to the federation via the Traffic Ops <a class="reference external" href="../development/traffic_ops_api/v12/federation.html">Federation API</a>.</p>
+<div><p>Federations allow for other (federated) CDNs (at a different ISP, MSO, etc) to add a list of resolvers and a CNAME to a delivery service Traffic Ops. When a request is made from one of federated CDN’s clients, Traffic Router will return the CNAME configured in the federation mapping. This allows the federated CDN to serve the content without the content provider changing the URL, or having to manage multiple URLs.</p>
+<p>Before adding a federation in the Traffic Ops UI, a user with the federations role needs to be created. This user will be assigned to the federation and will be able to add resolvers to the federation via the Traffic Ops <a class="reference external" href="../../development/traffic_ops_api/v12/federation.html">Federation API</a>.</p>
</div></blockquote>
</div>
<div class="section" id="header-rewrite-options-and-dscp">
@@ -796,39 +878,39 @@
<td>A newline</td>
</tr>
<tr class="row-odd"><td>__CACHE_IPV4__</td>
-<td>The cache’s IPv4 address</td>
+<td>The cache’s IPv4 address</td>
</tr>
</tbody>
</table>
<p>The deliveryservice screen also allows you to set the DSCP value of traffic sent to the client. This setting also results in a header_rewrite rule to be generated and applied to at the edge.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">The DSCP setting in the UI is <em>only</em> for setting traffic towards the client, and gets applied <em>after</em> the initial TCP handshake is complete, and the HTTP request is received (before that the cache can’t determine what deliveryservice this request is for, and what DSCP to apply), so the DSCP feature can not be used for security settings - the TCP SYN-ACK is not going to be DSCP marked.</p>
+<p class="last">The DSCP setting in the UI is <em>only</em> for setting traffic towards the client, and gets applied <em>after</em> the initial TCP handshake is complete, and the HTTP request is received (before that the cache can’t determine what deliveryservice this request is for, and what DSCP to apply), so the DSCP feature can not be used for security settings - the TCP SYN-ACK is not going to be DSCP marked.</p>
</div>
</div>
<div class="section" id="token-based-authentication">
<span id="rl-signed-urls"></span><span id="index-6"></span><h3>Token Based Authentication<a class="headerlink" href="#token-based-authentication" title="Permalink to this headline">¶</a></h3>
-<p>Token based authentication or <em>signed URLs</em> is implemented using the Traffic Server <code class="docutils literal"><span class="pre">url_sig</span></code> plugin. To sign a URL at the signing portal take the full URL, without any query string, and add on a query string with the following parameters:</p>
+<p>Token based authentication or <em>signed URLs</em> is implemented using the Traffic Server <code class="docutils literal notranslate"><span class="pre">url_sig</span></code> plugin. To sign a URL at the signing portal take the full URL, without any query string, and add on a query string with the following parameters:</p>
<dl class="docutils">
<dt>Client IP address</dt>
<dd><p class="first">The client IP address that this signature is valid for.</p>
-<p class="last"><code class="docutils literal"><span class="pre">C=<client</span> <span class="pre">IP</span> <span class="pre">address></span></code></p>
+<p class="last"><code class="docutils literal notranslate"><span class="pre">C=<client</span> <span class="pre">IP</span> <span class="pre">address></span></code></p>
</dd>
<dt>Expiration</dt>
<dd><p class="first">The Expiration time (seconds since epoch) of this signature.</p>
-<p class="last"><code class="docutils literal"><span class="pre">E=<expiration</span> <span class="pre">time</span> <span class="pre">in</span> <span class="pre">secs</span> <span class="pre">since</span> <span class="pre">unix</span> <span class="pre">epoch></span></code></p>
+<p class="last"><code class="docutils literal notranslate"><span class="pre">E=<expiration</span> <span class="pre">time</span> <span class="pre">in</span> <span class="pre">secs</span> <span class="pre">since</span> <span class="pre">unix</span> <span class="pre">epoch></span></code></p>
</dd>
<dt>Algorithm</dt>
<dd><p class="first">The Algorithm used to create the signature. Only 1 (HMAC_SHA1)
and 2 (HMAC_MD5) are supported at this time</p>
-<p class="last"><code class="docutils literal"><span class="pre">A=<algorithm</span> <span class="pre">number></span></code></p>
+<p class="last"><code class="docutils literal notranslate"><span class="pre">A=<algorithm</span> <span class="pre">number></span></code></p>
</dd>
<dt>Key index</dt>
<dd><p class="first">Index of the key used. This is the index of the key in the
configuration file on the cache. The set of keys is a shared
secret between the signing portal and the edge caches. There
is one set of keys per reverse proxy domain (fqdn).</p>
-<p class="last"><code class="docutils literal"><span class="pre">K=<key</span> <span class="pre">index</span> <span class="pre">used></span></code></p>
+<p class="last"><code class="docutils literal notranslate"><span class="pre">K=<key</span> <span class="pre">index</span> <span class="pre">used></span></code></p>
</dd>
<dt>Parts</dt>
<dd><p class="first">Parts to use for the signature, always excluding the scheme
@@ -840,12 +922,12 @@
<div>1: use fqdn and all of URl path
0110: use part1 and part 2 of path only
01: use everything except the fqdn</div></blockquote>
-<p class="last"><code class="docutils literal"><span class="pre">P=<parts</span> <span class="pre">string</span> <span class="pre">(0's</span> <span class="pre">and</span> <span class="pre">1's)></span></code></p>
+<p class="last"><code class="docutils literal notranslate"><span class="pre">P=<parts</span> <span class="pre">string</span> <span class="pre">(0's</span> <span class="pre">and</span> <span class="pre">1's)></span></code></p>
</dd>
<dt>Signature</dt>
<dd><p class="first">The signature over the parts + the query string up to and
-including “S=”.</p>
-<p class="last"><code class="docutils literal"><span class="pre">S=<signature></span></code></p>
+including “S=”.</p>
+<p class="last"><code class="docutils literal notranslate"><span class="pre">S=<signature></span></code></p>
</dd>
</dl>
<div class="admonition seealso">
@@ -897,68 +979,68 @@
http.uncacheable_requests_bypass_parent</td>
<td>records.config</td>
<td>INT 1</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-even"><td>CONFIG proxy.config.
http.parent_proxy_routing_enable</td>
<td>records.config</td>
<td>INT 1</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-odd"><td>CONFIG proxy.config.
http.parent_proxy.retry_time</td>
<td>records.config</td>
<td>INT 300</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-even"><td>CONFIG proxy.config.
http.parent_proxy.fail_threshold</td>
<td>records.config</td>
<td>INT 10</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-odd"><td>CONFIG proxy.config.
http.parent_proxy.total_connect_attempts</td>
<td>records.config</td>
<td>INT 4</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-even"><td>CONFIG proxy.config.
http.parent_proxy.per_parent_connect_attempts</td>
<td>records.config</td>
<td>INT 2</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-odd"><td>CONFIG proxy.config.
http.parent_proxy.connect_attempts_timeout</td>
<td>records.config</td>
<td>INT 30</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-even"><td>CONFIG proxy.config.
http.forward.proxy_auth_to_parent</td>
<td>records.config</td>
<td>INT 0</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-odd"><td>CONFIG proxy.config.
http.parent_proxy_routing_enable</td>
<td>records.config</td>
<td>INT 0</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-even"><td>CONFIG proxy.config.
http.parent_proxy.file</td>
<td>records.config</td>
<td>STRING
parent.config</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-odd"><td>CONFIG proxy.config.
http.parent_proxy.connect_attempts_timeout</td>
<td>records.config</td>
<td>INT 3</td>
-<td> </td>
+<td> </td>
</tr>
<tr class="row-even"><td>algorithm</td>
<td>parent.config</td>
@@ -994,7 +1076,7 @@
<tr class="row-odd"><td>weight</td>
<td>parent.config</td>
<td>1.0</td>
-<td>The weight of this parent, translates to the number of replicas in the consistent hash ring. This parameter only has effect with algorithm at the client set to “consistent_hash”</td>
+<td>The weight of this parent, translates to the number of replicas in the consistent hash ring. This parameter only has effect with algorithm at the client set to “consistent_hash”</td>
</tr>
<tr class="row-even"><td>port</td>
<td>parent.config</td>
@@ -1011,7 +1093,7 @@
</div>
<div class="section" id="qstring-handling">
<span id="rl-qstring-handling"></span><h3>Qstring Handling<a class="headerlink" href="#qstring-handling" title="Permalink to this headline">¶</a></h3>
-<p>Delivery services have a Query String Handling option that, when set to ignore, will automatically add a regex remap to that delivery service’s config. There may be times this is not preferred, or there may be requirements for one delivery service or server(s) to behave differently. When this is required, the psel.qstring_handling parameter can be set in either the delivery service profile or the server profile, but it is important to note that the server profile will override ALL delivery services assigned to servers with this profile parameter. If the parameter is not set for the server profile but is present for the Delivery Service profile, this will override the setting in the delivery service. A value of “ignore” will not result in the addition of regex remap configuration.</p>
+<p>Delivery services have a Query String Handling option that, when set to ignore, will automatically add a regex remap to that delivery service’s config. There may be times this is not preferred, or there may be requirements for one delivery service or server(s) to behave differently. When this is required, the psel.qstring_handling parameter can be set in either the delivery service profile or the server profile, but it is important to note that the server profile will override ALL delivery services assigned to servers with this profile parameter. If the parameter is not set for the server profile but is present for the Delivery Service profile, this will override the setting in the delivery service. A value of “ignore” will not result in the addition of regex remap configuration.</p>
<table border="1" class="docutils">
<colgroup>
<col width="10%" />
@@ -1034,7 +1116,7 @@
</ul>
</td>
<td>Sets qstring handling without the use of regex remap for a delivery service when assigned to a delivery service profile, and overrides qstring handling for all delivery services
-for associated servers when assigned to a server profile. Value must be “consider” or “ignore”.</td>
+for associated servers when assigned to a server profile. Value must be “consider” or “ignore”.</td>
</tr>
</tbody>
</table>
@@ -1043,10 +1125,10 @@
<span id="rl-multi-site-origin"></span><h3>Multi Site Origin<a class="headerlink" href="#multi-site-origin" title="Permalink to this headline">¶</a></h3>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">The configuration of this feature changed significantly between ATS version 5 and >= 6. Some configuration in Traffic Control is different as well. This documentation assumes ATS 6 or higher. See <a class="reference internal" href="../quick_howto/multi_site_ats5.html#rl-multi-site-origin-qht-ats5"><span class="std std-ref">Configure Multi Site Origin (5.x)</span></a> for the ATS version 5.x configuration details.</p>
+<p class="last">The configuration of this feature changed significantly between ATS version 5 and >= 6. Some configuration in Traffic Control is different as well. This documentation assumes ATS 6 or higher. See <a class="reference internal" href="../quick_howto/multi_site.html#rl-multi-site-origin-qht"><span class="std std-ref">Configure Multi Site Origin</span></a> for more details.</p>
</div>
-<p>Normally, the mid servers are not aware of any redundancy at the origin layer. With Multi Site Origin enabled this changes - Traffic Server (and Traffic Ops) are now made aware of the fact there are multiple origins, and can be configured to do more advanced failover and loadbalancing actions. A prerequisite for MSO to work is that the multiple origin sites serve identical content with identical paths, and both are configured to serve the same origin hostname as is configured in the deliveryservice <cite>Origin Server Base URL</cite> field. See the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html">Apache Traffic Server docs</a> for more information on that cache’s implementation.</p>
-<p>With This feature enabled, origin servers (or origin server VIP names for a site) are going to be entered as servers in to the Traiffic Ops UI. Server type is “ORG”.</p>
+<p>Normally, the mid servers are not aware of any redundancy at the origin layer. With Multi Site Origin enabled this changes - Traffic Server (and Traffic Ops) are now made aware of the fact there are multiple origins, and can be configured to do more advanced failover and loadbalancing actions. A prerequisite for MSO to work is that the multiple origin sites serve identical content with identical paths, and both are configured to serve the same origin hostname as is configured in the deliveryservice <cite>Origin Server Base URL</cite> field. See the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html">Apache Traffic Server docs</a> for more information on that cache’s implementation.</p>
+<p>With This feature enabled, origin servers (or origin server VIP names for a site) are going to be entered as servers in to the Traiffic Ops UI. Server type is “ORG”.</p>
<p>Parameters in the mid profile that influence this feature:</p>
<table border="1" class="docutils">
<colgroup>
@@ -1094,24 +1176,24 @@
<tr class="row-even"><td>mso.parent_retry</td>
<td>parent.config</td>
<td>-</td>
-<td>Either <code class="docutils literal"><span class="pre">simple_retry</span></code>, <code class="docutils literal"><span class="pre">dead_server_retry</span></code> or <code class="docutils literal"><span class="pre">both</span></code>.</td>
+<td>Either <code class="docutils literal notranslate"><span class="pre">simple_retry</span></code>, <code class="docutils literal notranslate"><span class="pre">dead_server_retry</span></code> or <code class="docutils literal notranslate"><span class="pre">both</span></code>.</td>
</tr>
<tr class="row-odd"><td>mso.algorithm</td>
<td>parent.config</td>
<td>consistent_hash</td>
-<td><p class="first">The algorithm to use. <code class="docutils literal"><span class="pre">consisten_hash</span></code>, <code class="docutils literal"><span class="pre">strict</span></code>, <code class="docutils literal"><span class="pre">true</span></code>, <code class="docutils literal"><span class="pre">false</span></code>, or <code class="docutils literal"><span class="pre">latched</span></code>.</p>
+<td><p class="first">The algorithm to use. <code class="docutils literal notranslate"><span class="pre">consisten_hash</span></code>, <code class="docutils literal notranslate"><span class="pre">strict</span></code>, <code class="docutils literal notranslate"><span class="pre">true</span></code>, <code class="docutils literal notranslate"><span class="pre">false</span></code>, or <code class="docutils literal notranslate"><span class="pre">latched</span></code>.</p>
<ul class="last simple">
-<li><code class="docutils literal"><span class="pre">consisten_hash</span></code> - spreads requests across multiple parents simultaneously based on hash of content URL.</li>
-<li><code class="docutils literal"><span class="pre">strict</span></code> - strict Round Robin spreads requests across multiple parents simultaneously based on order of requests.</li>
-<li><code class="docutils literal"><span class="pre">true</span></code> - same as strict, but ensures that requests from the same IP always go to the same parent if available.</li>
-<li><code class="docutils literal"><span class="pre">false</span></code> - uses only a single parent at any given time and switches to a new parent only if the current parent fails.</li>
-<li><code class="docutils literal"><span class="pre">latched</span></code> - same as false, but now, a failed parent will not be retried.</li>
+<li><code class="docutils literal notranslate"><span class="pre">consisten_hash</span></code> - spreads requests across multiple parents simultaneously based on hash of content URL.</li>
+<li><code class="docutils literal notranslate"><span class="pre">strict</span></code> - strict Round Robin spreads requests across multiple parents simultaneously based on order of requests.</li>
+<li><code class="docutils literal notranslate"><span class="pre">true</span></code> - same as strict, but ensures that requests from the same IP always go to the same parent if available.</li>
+<li><code class="docutils literal notranslate"><span class="pre">false</span></code> - uses only a single parent at any given time and switches to a new parent only if the current parent fails.</li>
+<li><code class="docutils literal notranslate"><span class="pre">latched</span></code> - same as false, but now, a failed parent will not be retried.</li>
</ul>
</td>
</tr>
<tr class="row-even"><td>mso.unavailable_server_retry_response_codes</td>
<td>parent.config</td>
-<td>“503”</td>
+<td>“503”</td>
<td>Quoted, comma separated list of HTTP status codes that count as a unavailable_server_retry_response_code.</td>
</tr>
<tr class="row-odd"><td>mso.max_unavailable_server_retries</td>
@@ -1121,7 +1203,7 @@
</tr>
<tr class="row-even"><td>mso.simple_retry_response_codes</td>
<td>parent.config</td>
-<td>“404”</td>
+<td>“404”</td>
<td>Quoted, comma separated list of HTTP status codes that count as a simple retry response code.</td>
</tr>
<tr class="row-odd"><td>mso.max_simple_retries</td>
@@ -1186,7 +1268,15 @@
</tr>
<tr class="row-odd"><td>coveragezone.polling.url</td>
<td>CRConfig.json</td>
-<td>The location (URL) to retrieve the coverage zone map file in XML format from.</td>
+<td>The location (URL) to retrieve the coverage zone map file in JSON format from.</td>
+</tr>
+<tr class="row-even"><td>deepcoveragezone.polling.interval</td>
+<td>CRConfig.json</td>
+<td>How often to refresh the deep coverage zone map in ms</td>
+</tr>
+<tr class="row-odd"><td>deepcoveragezone.polling.url</td>
+<td>CRConfig.json</td>
+<td>The location (URL) to retrieve the deep coverage zone map file in JSON format from.</td>
</tr>
<tr class="row-even"><td>tld.soa.expire</td>
<td>CRConfig.json</td>
@@ -1238,7 +1328,7 @@
</tr>
<tr class="row-even"><td>api.cache-control.max-age</td>
<td>CRConfig.json</td>
-<td>The value of the <code class="docutils literal"><span class="pre">Cache-Control:</span> <span class="pre">max-age=</span></code> header in the API responses of Traffic Router.</td>
+<td>The value of the <code class="docutils literal notranslate"><span class="pre">Cache-Control:</span> <span class="pre">max-age=</span></code> header in the API responses of Traffic Router.</td>
</tr>
<tr class="row-odd"><td>api.auth.url</td>
<td>CRConfig.json</td>
@@ -1286,7 +1376,7 @@
</tr>
<tr class="row-even"><td>signaturemanager.expiration.multiplier</td>
<td>CRConfig.json</td>
-<td>Multiplier used in conjunction with a zone’s maximum TTL to calculate DNSSEC signature durations; defaults to 5</td>
+<td>Multiplier used in conjunction with a zone’s maximum TTL to calculate DNSSEC signature durations; defaults to 5</td>
</tr>
<tr class="row-odd"><td>zonemanager.threadpool.scale</td>
<td>CRConfig.json</td>
@@ -1314,13 +1404,13 @@
<div class="section" id="regex-remap-expression">
<span id="rl-regex-remap"></span><span id="index-7"></span><h3>Regex Remap Expression<a class="headerlink" href="#regex-remap-expression" title="Permalink to this headline">¶</a></h3>
<p>The regex remap expression allows to to use a regex and resulting match group(s) in order to modify the request URIs that are sent to origin. For example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>^/original/(.*) http://origin.example.com/remapped/$1
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>^/original/(.*) http://origin.example.com/remapped/$1
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p>If <strong>Query String Handling</strong> is set to <code class="docutils literal"><span class="pre">2</span> <span class="pre">Drop</span> <span class="pre">at</span> <span class="pre">edge</span></code>, then you will not be allowed to save a regex remap expression, as dropping query strings actually relies on a regex remap of its own. However, if there is a need to both drop query strings <strong>and</strong> remap request URIs, this can be accomplished by setting <strong>Query String Handling</strong> to <code class="docutils literal"><span class="pre">1</span> <span class="pre">Do</span> <span class="pre">not</span> <span class="pre">use</span> <span class="pre">in</span> <span class="pre">cache</span> <span class="pre">key,</span> <span class="pre">but</span> <span class="pre">pass</span> <span class="pre">up</span> <span class="pre">to</span> <span class="pre">origin</span></code>, and then using a custom regex remap expression to do the necessary remapping, while simultaneously dropping query strings. The following example will capture the original request URI up to, but not including, the query string and then forward to a remapped URI:</p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span>^/([^?]*).* http://origin.example.com/remapped/$1
+<p>If <strong>Query String Handling</strong> is set to <code class="docutils literal notranslate"><span class="pre">2</span> <span class="pre">Drop</span> <span class="pre">at</span> <span class="pre">edge</span></code>, then you will not be allowed to save a regex remap expression, as dropping query strings actually relies on a regex remap of its own. However, if there is a need to both drop query strings <strong>and</strong> remap request URIs, this can be accomplished by setting <strong>Query String Handling</strong> to <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">Do</span> <span class="pre">not</span> <span class="pre">use</span> <span class="pre">in</span> <span class="pre">cache</span> <span class="pre">key,</span> <span class="pre">but</span> <span class="pre">pass</span> <span class="pre">up</span> <span class="pre">to</span> <span class="pre">origin</span></code>, and then using a custom regex remap expression to do the necessary remapping, while simultaneously dropping query strings. The following example will capture the original request URI up to, but not including, the query string and then forward to a remapped URI:</p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span>^/([^?]*).* http://origin.example.com/remapped/$1
</pre></div>
</div>
</div>
@@ -1360,14 +1450,14 @@
</tr>
</tbody>
</table>
-<p>The <strong>Order</strong> entry defines the order in which the regular expressions get evaluated. To support <code class="docutils literal"><span class="pre">CNAMES</span></code> from domains outside of the Traffic Control top level DNS domain, enter multiple <code class="docutils literal"><span class="pre">HOST_REGEXP</span></code> lines.</p>
+<p>The <strong>Order</strong> entry defines the order in which the regular expressions get evaluated. To support <code class="docutils literal notranslate"><span class="pre">CNAMES</span></code> from domains outside of the Traffic Control top level DNS domain, enter multiple <code class="docutils literal notranslate"><span class="pre">HOST_REGEXP</span></code> lines.</p>
<dl class="docutils">
<dt>Example:</dt>
<dd>Example foo.</dd>
</dl>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">In most cases is is sufficient to have just one entry in this table that has a <code class="docutils literal"><span class="pre">HOST_REGEXP</span></code> Type, and Order <code class="docutils literal"><span class="pre">0</span></code>. For the <em>movies</em> delivery service in the Kabletown CDN, the entry is simply single <code class="docutils literal"><span class="pre">HOST_REGEXP</span></code> set to <code class="docutils literal"><span class="pre">.*\.movies\..*</span></code>. This will match every url that has a hostname that ends with <code class="docutils literal"><span class="pre">movies.cdn1.kabletown.net</span></code>, since <code class="docutils literal"><span class="pre">cdn1.kabletown.net</span></code> is the Kabletown CDN’s DNS domain.</p>
+<p class="last">In most cases is is sufficient to have just one entry in this table that has a <code class="docutils literal notranslate"><span class="pre">HOST_REGEXP</span></code> Type, and Order <code class="docutils literal notranslate"><span class="pre">0</span></code>. For the <em>movies</em> delivery service in the Kabletown CDN, the entry is simply single <code class="docutils literal notranslate"><span class="pre">HOST_REGEXP</span></code> set to <code class="docutils literal notranslate"><span class="pre">.*\.movies\..*</span></code>. This will match every url that has a hostname that ends with <code class="docutils literal notranslate"><span class="pre">movies.cdn1.kabletown.net</span></code>, since <code class="docutils literal notranslate"><span class="pre">cdn1.kabletown.net</span></code> is the Kabletown CDN’s DNS domain.</p>
</div>
</div>
<div class="section" id="static-dns-entries">
@@ -1381,39 +1471,103 @@
<div class="section" id="the-coverage-zone-file-and-asn-table">
<span id="rl-asn-czf"></span><h3>The Coverage Zone File and ASN Table<a class="headerlink" href="#the-coverage-zone-file-and-asn-table" title="Permalink to this headline">¶</a></h3>
<p>The Coverage Zone File (CZF) should contain a cachegroup name to network prefix mapping in the form:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"coverageZones"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"cache-group-01"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"coordinates"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mf">1.1</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mf">2.2</span>
+ <span class="p">},</span>
<span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"1234:5678::\/64"</span><span class="p">,</span>
- <span class="s2">"1234:5679::\/64"</span>
+ <span class="s2">"1234:5678::/64"</span><span class="p">,</span>
+ <span class="s2">"1234:5679::/64"</span>
<span class="p">],</span>
<span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"192.168.8.0\/24"</span><span class="p">,</span>
- <span class="s2">"192.168.9.0\/24"</span>
+ <span class="s2">"192.168.8.0/24"</span><span class="p">,</span>
+ <span class="s2">"192.168.9.0/24"</span>
<span class="p">]</span>
- <span class="p">}</span>
+ <span class="p">},</span>
<span class="s2">"cache-group-02"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"coordinates"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mf">3.3</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mf">4.4</span>
+ <span class="p">},</span>
<span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"1234:567a::\/64"</span><span class="p">,</span>
- <span class="s2">"1234:567b::\/64"</span>
+ <span class="s2">"1234:567a::/64"</span><span class="p">,</span>
+ <span class="s2">"1234:567b::/64"</span>
<span class="p">],</span>
<span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"192.168.4.0\/24"</span><span class="p">,</span>
- <span class="s2">"192.168.5.0\/24"</span>
+ <span class="s2">"192.168.4.0/24"</span><span class="p">,</span>
+ <span class="s2">"192.168.5.0/24"</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
-<p>The CZF is an input to the Traffic Control CDN, and as such does not get generated by Traffic Ops, but rather, it gets consumed by Traffic Router. Some popular IP management systems output a very similar file to the CZF but in stead of a cachegroup an ASN will be listed. Traffic Ops has the “Networks (ASNs)” view to aid with the conversion of files like that to a Traffic Control CZF file; this table is not used anywhere in Traffic Ops, but can be used to script the conversion using the API.</p>
+<p>The CZF is an input to the Traffic Control CDN, and as such does not get generated by Traffic Ops, but rather, it gets consumed by Traffic Router. Some popular IP management systems output a very similar file to the CZF but in stead of a cachegroup an ASN will be listed. Traffic Ops has the “Networks (ASNs)” view to aid with the conversion of files like that to a Traffic Control CZF file; this table is not used anywhere in Traffic Ops, but can be used to script the conversion using the API.</p>
<p>The script that generates the CZF file is not part of Traffic Control, since it is different for each situation.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The <code class="docutils literal notranslate"><span class="pre">"coordinates"</span></code> section is optional and may be used by Traffic Router for localization in the case of a CZF “hit” where the zone name does not map to a Cache Group name in Traffic Ops (i.e. Traffic Router will route to the closest Cache Group(s) geographically).</p>
+</div>
+</div>
+<div class="section" id="the-deep-coverage-zone-file">
+<span id="rl-deep-czf"></span><h3>The Deep Coverage Zone File<a class="headerlink" href="#the-deep-coverage-zone-file" title="Permalink to this headline">¶</a></h3>
+<p>The Deep Coverage Zone File (DCZF) format is similar to the CZF format but adds a <code class="docutils literal notranslate"><span class="pre">caches</span></code> list under each <code class="docutils literal notranslate"><span class="pre">deepCoverageZone</span></code>:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"deepCoverageZones"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"location-01"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"coordinates"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mf">5.5</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mf">6.6</span>
+ <span class="p">},</span>
+ <span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1234:5678::/64"</span><span class="p">,</span>
+ <span class="s2">"1234:5679::/64"</span>
+ <span class="p">],</span>
+ <span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"192.168.8.0/24"</span><span class="p">,</span>
+ <span class="s2">"192.168.9.0/24"</span>
+ <span class="p">],</span>
+ <span class="s2">"caches"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"edge-01"</span><span class="p">,</span>
+ <span class="s2">"edge-02"</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+ <span class="s2">"location-02"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"coordinates"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mf">7.7</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mf">8.8</span>
+ <span class="p">},</span>
+ <span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1234:567a::/64"</span><span class="p">,</span>
+ <span class="s2">"1234:567b::/64"</span>
+ <span class="p">],</span>
+ <span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"192.168.4.0/24"</span><span class="p">,</span>
+ <span class="s2">"192.168.5.0/24"</span>
+ <span class="p">],</span>
+ <span class="s2">"caches"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"edge-02"</span><span class="p">,</span>
+ <span class="s2">"edge-03"</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>Each entry in the <code class="docutils literal notranslate"><span class="pre">caches</span></code> list is the hostname of an edge cache registered in Traffic Ops which will be used for “deep” caching in that Deep Coverage Zone. Unlike a regular CZF, coverage zones in the DCZF do not map to a Cache Group in Traffic Ops, so currently the deep coverage zone name only needs to be unique.</p>
+<p>If the Traffic Router gets a DCZF “hit” for a requested Delivery Service that has Deep Caching enabled, the client will be routed to an available “deep” cache from that zone’s <code class="docutils literal notranslate"><span class="pre">caches</span></code> list.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The <code class="docutils literal notranslate"><span class="pre">"coordinates"</span></code> section is optional.</p>
+</div>
</div>
</div>
<div class="section" id="parameters-and-profiles">
<span id="rl-working-with-profiles"></span><h2>Parameters and Profiles<a class="headerlink" href="#parameters-and-profiles" title="Permalink to this headline">¶</a></h2>
-<p>Parameters are shared between profiles if the set of <code class="docutils literal"><span class="pre">{</span> <span class="pre">name,</span> <span class="pre">config_file,</span> <span class="pre">value</span> <span class="pre">}</span></code> is the same. To change a value in one profile but not in others, the parameter has to be removed from the profile you want to change it in, and a new parameter entry has to be created (<strong>Add Parameter</strong> button at the bottom of the Parameters view), and assigned to that profile. It is easy to create new profiles from the <strong>Misc > Profiles</strong> view - just use the <strong>Add/Copy Profile</strong> button at the bottom of the profile view to copy an existing profile to a new one. Profiles can be exported from one system and imported to another using the profile view as well. It makes no sense for a parameter to not be assigned to a single profile - in that case it really has no function. To find parameters like that use the <strong>Parameters > Orphaned Parameters</strong> view. It is easy to create orphaned parameters by removing all profiles, or not assigning a profile directly after creating the parameter.</p>
+<p>Parameters are shared between profiles if the set of <code class="docutils literal notranslate"><span class="pre">{</span> <span class="pre">name,</span> <span class="pre">config_file,</span> <span class="pre">value</span> <span class="pre">}</span></code> is the same. To change a value in one profile but not in others, the parameter has to be removed from the profile you want to change it in, and a new parameter entry has to be created (<strong>Add Parameter</strong> button at the bottom of the Parameters view), and assigned to that profile. It is easy to create new profiles from the <strong>Misc > Profiles</strong> view - just use the <strong>Add/Copy Profile</strong> button at the bottom of the profile view to copy an existing profile to a new one. Profiles can be exported from one system and imported to another using the profile view as well. It makes no sense for a parameter to not be assigned to a single profile - in that case it really has no function. To find parameters like that use the <strong>Parameters > Orphaned Parameters</strong> view. It is easy to create orphaned parameters by removing all profiles, or not assigning a profile directly after creating the parameter.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="configuration.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a> in the <em>Configuring Traffic Ops</em> section.</p>
@@ -1423,8 +1577,8 @@
<h2>Tools<a class="headerlink" href="#tools" title="Permalink to this headline">¶</a></h2>
<div class="section" id="generate-iso">
<span id="rl-generate-iso"></span><span id="index-11"></span><h3>Generate ISO<a class="headerlink" href="#generate-iso" title="Permalink to this headline">¶</a></h3>
-<p>Generate ISO is a tool for building custom ISOs for building caches on remote hosts. Currently it only supports Centos 6, but if you’re brave and pure of heart you MIGHT be able to get it to work with other unix-like OS’s.</p>
-<p>The interface is <em>mostly</em> self explainatory as it’s got hints.</p>
+<p>Generate ISO is a tool for building custom ISOs for building caches on remote hosts. Currently it only supports Centos 6, but if you’re brave and pure of heart you MIGHT be able to get it to work with other unix-like OS’s.</p>
+<p>The interface is <em>mostly</em> self explainatory as it’s got hints.</p>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
@@ -1446,7 +1600,7 @@
<td>This is the FQDN of the server to be installed. It is required.</td>
</tr>
<tr class="row-odd"><td>Root password:</td>
-<td>If you don’t put anything here it will default to the salted MD5 of “Fred”. Whatever put is MD5 hashed and writte to disk.</td>
+<td>If you don’t put anything here it will default to the salted MD5 of “Fred”. Whatever put is MD5 hashed and writte to disk.</td>
</tr>
<tr class="row-even"><td>DHCP:</td>
<td>if yes, other IP settings will be ignored</td>
@@ -1473,26 +1627,26 @@
<td>If unsure, set to 1500</td>
</tr>
<tr class="row-even"><td>Specify disk for OS install:</td>
-<td>Optional. Typical values are “sda”.</td>
+<td>Optional. Typical values are “sda”.</td>
</tr>
</tbody>
</table>
<p>When you click the <strong>Download ISO</strong> button the folling occurs (all paths relative to the top level of the directory specified in _osversions.cfg_):</p>
<ol class="arabic simple">
<li>Reads /etc/resolv.conf to get a list of nameservers. This is a rather ugly hack that is in place until we get a way of configuring it in the interface.</li>
-<li>Writes a file in the ks_scripts/state.out that contains directory from _osversions.cfg_ and the mkisofs string that we’ll call later.</li>
+<li>Writes a file in the ks_scripts/state.out that contains directory from _osversions.cfg_ and the mkisofs string that we’ll call later.</li>
<li>Writes a file in the ks_scripts/network.cfg that is a bunch of key=value pairs that set up networking.</li>
-<li>Creates an MD5 hash of the password you specify and writes it to ks_scripts/password.cfg. Note that if you do not specify a password “Fred” is used. Also note that we have experienced some issues with webbrowsers autofilling that field.</li>
+<li>Creates an MD5 hash of the password you specify and writes it to ks_scripts/password.cfg. Note that if you do not specify a password “Fred” is used. Also note that we have experienced some issues with webbrowsers autofilling that field.</li>
<li>Writes out a disk configuration file to ks_scripts/disk.cfg.</li>
<li>mkisofs is called against the directory configured in _osversions.cfg_ and an ISO is generated in memory and delivered to your webbrowser.</li>
</ol>
<p>You now have a customized ISO that can be used to install Red Hat and derivative Linux installations with some modifications to your ks.cfg file.</p>
<p>Kickstart/Anaconda will mount the ISO at /mnt/stage2 during the install process (at least with 6).</p>
<p>You can directly include the password file anywhere in your ks.cfg file (usually in the top) by doing %include /mnt/stage2/ks_scripts/password.cfg</p>
-<p>What we currently do is have 2 scripts, one to do hard drive configuration and one to do network configuration. Both are relatively specific to the environment they were created in, and both are <em>probably</em> wrong for other organizations, however they are currently living in the “misc” directory as examples of how to do things.</p>
+<p>What we currently do is have 2 scripts, one to do hard drive configuration and one to do network configuration. Both are relatively specific to the environment they were created in, and both are <em>probably</em> wrong for other organizations, however they are currently living in the “misc” directory as examples of how to do things.</p>
<p>We trigger those in a %pre section in ks.cfg and they will write config files to /tmp. We will then include those files in the appropriate places using %pre.</p>
<p>For example this is a section of our ks.cfg file:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">packages</span><span class="o">.</span><span class="n">txt</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">packages</span><span class="o">.</span><span class="n">txt</span>
<span class="o">%</span><span class="n">pre</span>
<span class="n">python</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">create_network_line</span><span class="o">.</span><span class="n">py</span>
@@ -1500,8 +1654,8 @@
<span class="o">%</span><span class="n">end</span>
</pre></div>
</div>
-<p>These two scripts will then run _before_ anaconda sets up it’s internal structures, then a bit further up in the ks.cfg file (outside of the %pre %end block) we do an</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">password</span><span class="o">.</span><span class="n">cfg</span>
+<p>These two scripts will then run _before_ anaconda sets up it’s internal structures, then a bit further up in the ks.cfg file (outside of the %pre %end block) we do an</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">password</span><span class="o">.</span><span class="n">cfg</span>
<span class="o">...</span>
<span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">network_line</span>
@@ -1512,14 +1666,14 @@
<p>This snarfs up the contents and inlines them.</p>
<p>If you only have one kind of hardware on your CDN it is probably best to just put the drive config right in the ks.cfg.</p>
<p>If you have simple networking needs (we use bonded interfaces in most, but not all locations and we have several types of hardware meaning different ethernet interface names at the OS level etc.) then something like this:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span>
<span class="n">source</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">network</span><span class="o">.</span><span class="n">cfg</span>
<span class="n">echo</span> <span class="s2">"network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY --nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME"</span> <span class="o">>></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">network</span><span class="o">.</span><span class="n">cfg</span>
<span class="c1"># Note that this is an example and may not work at all.</span>
</pre></div>
</div>
<p>You could also put this in the %pre section. Lots of ways to solve it.</p>
-<p>We have included the two scripts we use in the “misc” directory of the git repo:</p>
+<p>We have included the two scripts we use in the “misc” directory of the git repo:</p>
<ul class="simple">
<li>kickstart_create_network_line.py</li>
<li>kickstart_drive_config.sh</li>
@@ -1528,7 +1682,7 @@
</div>
<div class="section" id="queue-updates-and-snapshot-crconfig">
<span id="rl-queue-updates"></span><h3>Queue Updates and Snapshot CRConfig<a class="headerlink" href="#queue-updates-and-snapshot-crconfig" title="Permalink to this headline">¶</a></h3>
-<p>When changing delivery services special care has to be taken so that Traffic Router will not send traffic to caches for delivery services that the cache doesn’t know about yet. In general, when adding delivery services, or adding servers to a delivery service, it is best to update the caches before updating Traffic Router and Traffic Monitor. When deleting delivery services, or deleting server assignments to delivery services, it is best to update Traffic Router and Traffic Monitor first and then the caches. Updating the cache configuration is done through the <em>Queue Updates</em> menu, and updating Traffic Monitor and Traffic Router config is done through the <em>Snapshot CRConfig</em> menu.</p>
+<p>When changing delivery services special care has to be taken so that Traffic Router will not send traffic to caches for delivery services that the cache doesn’t know about yet. In general, when adding delivery services, or adding servers to a delivery service, it is best to update the caches before updating Traffic Router and Traffic Monitor. When deleting delivery services, or deleting server assignments to delivery services, it is best to update Traffic Router and Traffic Monitor first and then the caches. Updating the cache configuration is done through the <em>Queue Updates</em> menu, and updating Traffic Monitor and Traffic Router config is done through the <em>Snapshot CRConfig</em> menu.</p>
<div class="section" id="queue-updates">
<span id="index-12"></span><h4>Queue Updates<a class="headerlink" href="#queue-updates" title="Permalink to this headline">¶</a></h4>
<p>Every 15 minutes the caches should run a <em>syncds</em> to get all changes needed from Traffic Ops. The files that will be updated by the syncds job are:</p>
@@ -1553,7 +1707,7 @@
<li>When the Queue Updates for this Server? (all) window opens, click <strong>OK</strong>.</li>
</ol>
</div></blockquote>
-<p>To schedule updates for just one cache, use the “Server Checks” page, and click the <img alt="checkmark" src="../../_images/good.png" /> in the <em>UPD</em> column. The UPD column of Server Checks page will change show a <img alt="clock" src="../../_images/clock-black.png" /> when updates are pending for that cache.</p>
+<p>To schedule updates for just one cache, use the “Server Checks” page, and click the <img alt="checkmark" src="../../_images/good.png" /> in the <em>UPD</em> column. The UPD column of Server Checks page will change show a <img alt="clock" src="../../_images/clock-black.png" /> when updates are pending for that cache.</p>
</div>
<div class="section" id="snapshot-crconfig">
<span id="rl-snapshot-crconfig"></span><span id="index-13"></span><h4>Snapshot CRConfig<a class="headerlink" href="#snapshot-crconfig" title="Permalink to this headline">¶</a></h4>
@@ -1565,9 +1719,9 @@
</li>
<li><p class="first">Verify the selection of the correct CDN from the Choose CDN drop down and click <strong>Diff CRConfig</strong>.
On initial selection of this, the CRConfig Diff window says the following:</p>
-<p>There is no existing CRConfig for [cdn] to diff against... Is this the first snapshot???
+<p>There is no existing CRConfig for [cdn] to diff against… Is this the first snapshot???
If you are not sure why you are getting this message, please do not proceed!
-To proceed writing the snapshot anyway click the ‘Write CRConfig’ button below.</p>
+To proceed writing the snapshot anyway click the ‘Write CRConfig’ button below.</p>
<p>If there is an older version of the CRConfig, a window will pop up showing the differences
between the active CRConfig and the CRConfig about to be written.</p>
</li>
@@ -1587,7 +1741,7 @@
<p>Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the <em>regex_revalidate</em> ATS plugin. This forces a <em>revalidation</em> of the content, rather than a new get.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">This method forces a HTTP <em>revalidation</em> of the content, and not a new <em>GET</em> - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> or <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> as applicable.</p>
+<p class="last">This method forces a HTTP <em>revalidation</em> of the content, and not a new <em>GET</em> - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a <code class="docutils literal notranslate"><span class="pre">200</span> <span class="pre">OK</span></code> or <code class="docutils literal notranslate"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> as applicable.</p>
</div>
<p>To invalidate content:</p>
<blockquote>
@@ -1598,8 +1752,8 @@
<blockquote>
<div><ul class="simple">
<li>Select the <strong>Delivery Service</strong></li>
-<li>Enter the <strong>Path Regex</strong> - this should be a <a class="reference external" href="http://www.pcre.org/">PCRE</a> compatible regular expression for the path to match for forcing the revalidation. Be careful to only match on the content you need to remove - revalidation is an expensive operation for many origins, and a simple <code class="docutils literal"><span class="pre">/.*</span></code> can cause an overload condition of the origin.</li>
-<li>Enter the <strong>Time To Live</strong> - this is how long the revalidation rule will be active for. It usually makes sense to make this the same as the <code class="docutils literal"><span class="pre">Cache-Control</span></code> header from the origin which sets the object time to live in cache (by <code class="docutils literal"><span class="pre">max-age</span></code> or <code class="docutils literal"><span class="pre">Expires</span></code>). Entering a longer TTL here will make the caches do unnecessary work.</li>
+<li>Enter the <strong>Path Regex</strong> - this should be a <a class="reference external" href="http://www.pcre.org/">PCRE</a> compatible regular expression for the path to match for forcing the revalidation. Be careful to only match on the content you need to remove - revalidation is an expensive operation for many origins, and a simple <code class="docutils literal notranslate"><span class="pre">/.*</span></code> can cause an overload condition of the origin.</li>
+<li>Enter the <strong>Time To Live</strong> - this is how long the revalidation rule will be active for. It usually makes sense to make this the same as the <code class="docutils literal notranslate"><span class="pre">Cache-Control</span></code> header from the origin which sets the object time to live in cache (by <code class="docutils literal notranslate"><span class="pre">max-age</span></code> or <code class="docutils literal notranslate"><span class="pre">Expires</span></code>). Entering a longer TTL here will make the caches do unnecessary work.</li>
<li>Enter the <strong>Start Time</strong> - this is the start time when the revalidation rule will be made active. It is pre-populated with the current time, leave as is to schedule ASAP.</li>
</ul>
</div></blockquote>
@@ -1610,7 +1764,7 @@
</div>
<div class="section" id="manage-dnssec-keys">
<h2>Manage DNSSEC Keys<a class="headerlink" href="#manage-dnssec-keys" title="Permalink to this headline">¶</a></h2>
-<p>In order to support <a class="reference external" href="https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions">DNSSEC</a> in Traffic Router, Traffic Ops provides some actions for managing DNSSEC keys for a CDN and associated Delivery Services. DNSSEC Keys consist of a Key Signing Keys (KSK) which are used to sign other DNSKEY records as well as Zone Signing Keys (ZSK) which are used to sign other records. DNSSEC Keys are stored in <a class="reference external" href="../overview/traffic_vault.html">Traffic Vault</a> and should only be accessible to Traffic Ops. Other applications needing access to this data, such as Traffic Router, must use the Traffic Ops <a class="reference external" href="../development/traffic_ops_api/v12/cdn.html#dnssec-keys">DNSSEC APIs</a> to retrieve this information.</p>
+<p>In order to support <a class="reference external" href="https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions">DNSSEC</a> in Traffic Router, Traffic Ops provides some actions for managing DNSSEC keys for a CDN and associated Delivery Services. DNSSEC Keys consist of a Key Signing Keys (KSK) which are used to sign other DNSKEY records as well as Zone Signing Keys (ZSK) which are used to sign other records. DNSSEC Keys are stored in <a class="reference external" href="../../overview/traffic_vault.html">Traffic Vault</a> and should only be accessible to Traffic Ops. Other applications needing access to this data, such as Traffic Router, must use the Traffic Ops <a class="reference external" href="../../development/traffic_ops_api/v12/cdn.html#dnssec-keys">DNSSEC APIs</a> to retrieve this information.</p>
<dl class="docutils">
<dt>To Manage DNSSEC Keys:</dt>
<dd><ol class="first arabic simple">
@@ -1690,16 +1844,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_portal/installation.html b/docs/latest/admin/traffic_portal/installation.html
new file mode 100644
index 0000000..997e80f
--- /dev/null
+++ b/docs/latest/admin/traffic_portal/installation.html
@@ -0,0 +1,331 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Traffic Portal Administration — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="Administrator’s Guide" href="../index.html"/>
+ <link rel="next" title="Traffic Portal - Using" href="usingtrafficportal.html"/>
+ <link rel="prev" title="Managing Traffic Ops Extensions" href="../traffic_ops/extensions.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
+
+ <li>Traffic Portal Administration</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/admin/traffic_portal/installation.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="usingtrafficportal.html" class="btn btn-neutral float-right" title="Traffic Portal - Using">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../traffic_ops/extensions.html" class="btn btn-neutral" title="Managing Traffic Ops Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="traffic-portal-administration">
+<h1>Traffic Portal Administration<a class="headerlink" href="#traffic-portal-administration" title="Permalink to this headline">¶</a></h1>
+<p>The following are requirements to ensure an accurate set up:</p>
+<ul class="simple">
+<li>CentOS 6.7 or 7</li>
+<li>Node.js 6.0.x or above</li>
+</ul>
+<p><strong>Installing Traffic Portal</strong></p>
+<blockquote>
+<div><ul class="simple">
+<li>Download the Traffic Portal RPM from <a class="reference external" href="https://builds.apache.org/view/S-Z/view/TrafficControl/job/incubator-trafficcontrol-master-build/">Apache Jenkins</a> or build the Traffic Portal RPM from source (./pkg -v traffic_portal_build).</li>
+<li>Copy the Traffic Portal RPM to your server</li>
+<li>curl –silent –location <a class="reference external" href="https://rpm.nodesource.com/setup_6.x">https://rpm.nodesource.com/setup_6.x</a> | sudo bash -</li>
+<li>sudo yum install -y nodejs</li>
+<li>sudo yum install -y <traffic_portal rpm></li>
+</ul>
+</div></blockquote>
+<p><strong>Configuring Traffic Portal</strong></p>
+<blockquote>
+<div><ul class="simple">
+<li>update /etc/traffic_portal/conf/config.js (if upgrade, reconcile config.js with config.js.rpmnew and then delete config.js.rpmnew)</li>
+<li>update /opt/traffic_portal/public/traffic_portal_properties.json (if upgrade, reconcile traffic_portal_properties.json with traffic_portal_properties.json.rpmnew and then delete traffic_portal_properties.json.rpmnew)</li>
+<li>[OPTIONAL] update /opt/traffic_portal/public/resources/assets/css/custom.css (to customize traffic portal skin)</li>
+</ul>
+</div></blockquote>
+<p><strong>Starting Traffic Portal</strong></p>
+<blockquote>
+<div><ul class="simple">
+<li>sudo service traffic_portal start</li>
+</ul>
+</div></blockquote>
+<p><strong>Stopping Traffic Portal</strong></p>
+<blockquote>
+<div><ul class="simple">
+<li>sudo service traffic_portal stop</li>
+</ul>
+</div></blockquote>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="usingtrafficportal.html" class="btn btn-neutral float-right" title="Traffic Portal - Using">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../traffic_ops/extensions.html" class="btn btn-neutral" title="Managing Traffic Ops Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/admin/traffic_portal/usingtrafficportal.html b/docs/latest/admin/traffic_portal/usingtrafficportal.html
new file mode 100644
index 0000000..0774c0f
--- /dev/null
+++ b/docs/latest/admin/traffic_portal/usingtrafficportal.html
@@ -0,0 +1,1363 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Traffic Portal - Using — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="Administrator’s Guide" href="../index.html"/>
+ <link rel="next" title="Traffic Monitor Administration (Legacy)" href="../traffic_monitor.html"/>
+ <link rel="prev" title="Traffic Portal Administration" href="installation.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
+
+ <li>Traffic Portal - Using</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/admin/traffic_portal/usingtrafficportal.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor Administration (Legacy)">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="installation.html" class="btn btn-neutral" title="Traffic Portal Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="traffic-portal-using">
+<span id="usingtrafficportal"></span><h1>Traffic Portal - Using<a class="headerlink" href="#traffic-portal-using" title="Permalink to this headline">¶</a></h1>
+<p>Traffic Portal is the official replacement for the legacy Traffic Ops UI. Traffic Portal consumes the Traffic Ops API. The following high-level items are available in the Traffic Portal menu.</p>
+<img alt="../../_images/tp_menu.png" src="../../_images/tp_menu.png" />
+<div class="section" id="dashboard">
+<h2>Dashboard<a class="headerlink" href="#dashboard" title="Permalink to this headline">¶</a></h2>
+<p>The Dashboard is the default landing page for Traffic Portal. It provides a real-time view into the main performance indicators of the CDNs managed by Traffic Control. It also displays various statistics about the overall health of your CDN.</p>
+<ul class="simple">
+<li><strong>Current Bandwidth</strong>: The current bandwidth of all of your CDNs.</li>
+<li><strong>Current Connections</strong>: The current number of connections to all of your CDNs.</li>
+<li><strong>Healthy Caches</strong>: Number of healthy caches across all CDNs. Click the link to view the healthy caches on the cache stats page.</li>
+<li><strong>Unhealthy Caches</strong>: Number of unhealthy caches across all CDNs. Click the link to view the unhealthy caches on the cache stats page.</li>
+<li><strong>Online Caches</strong>: Number of online caches. Traffic Monitor will not monitor the state of ONLINE servers. True health is unknown.</li>
+<li><strong>Reported Caches</strong>: Number of caches with REPORTED status.</li>
+<li><strong>Offline Caches</strong>: Number of caches with OFFLINE status.</li>
+<li><strong>Admin Down Caches</strong>: Number of caches with ADMIN_DOWN status.</li>
+</ul>
+<p>Each component of this view is updated at the intervals defined in tp.domain.com/traffic_portal_properties.json.</p>
+</div>
+<div class="section" id="cdns">
+<h2>CDNs<a class="headerlink" href="#cdns" title="Permalink to this headline">¶</a></h2>
+<p>A table of CDNs with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Domain</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>DNSSEC Enabled</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>CDN management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new CDN</li>
+<li>update an existing CDN</li>
+<li>delete an existing CDN</li>
+<li>queue/clear updates on all servers in a CDN</li>
+<li>diff CDN snapshot</li>
+<li>create CDN snapshot</li>
+<li>manage CDN DNSSEC keys</li>
+<li>manage CDN federations</li>
+<li>view CDN delivery services</li>
+<li>view CDN profiles</li>
+<li>view CDN servers</li>
+</ul>
+</div>
+<div class="section" id="monitor">
+<h2>Monitor<a class="headerlink" href="#monitor" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="10%" />
+<col width="90%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Option</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Cache Checks</td>
+<td>A real time view into the status of each cache.
+This view is sourced by the Traffic Monitor data thru the Traffic Ops API and is updated on demand.
+See <a class="reference internal" href="#tp-cache-checks"><span class="std std-ref">Cache Checks</span></a> for details.</td>
+</tr>
+<tr class="row-odd"><td>Cache Stats</td>
+<td>A table showing the results of the periodic check extension scripts that are run. See <a class="reference internal" href="#tp-cache-stats"><span class="std std-ref">Cache Stats</span></a> for details.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div>
+<div class="section" id="services">
+<h2>Services<a class="headerlink" href="#services" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="77%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Option</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Delivery Services</td>
+<td>Settings for your delivery services. Only the delivery services defined by a user’s tenancy are visible.
+See <a class="reference internal" href="#tp-delivery-services"><span class="std std-ref">Delivery Services</span></a> for details.</td>
+</tr>
+<tr class="row-odd"><td>Delivery Service Requests</td>
+<td>If enabled in tp.domain.com/traffic_portal_properties.json, all delivery service changes (create, update and
+delete) are captured as a delivery service request and must be reviewed before fulfillment/deployment.
+See <a class="reference internal" href="#tp-delivery-service-requests"><span class="std std-ref">Delivery Service Requests</span></a> for details.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div>
+<div class="section" id="configure">
+<h2>Configure<a class="headerlink" href="#configure" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="10%" />
+<col width="90%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Option</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Servers</td>
+<td>Manage servers. See <a class="reference internal" href="#tp-servers"><span class="std std-ref">Servers</span></a></td>
+</tr>
+<tr class="row-odd"><td>Profiles</td>
+<td>Manage profiles. See <a class="reference internal" href="#tp-profiles"><span class="std std-ref">Profiles</span></a></td>
+</tr>
+<tr class="row-even"><td>Parameters</td>
+<td>Manage parameters. See <a class="reference internal" href="#tp-parameters"><span class="std std-ref">Parameters</span></a></td>
+</tr>
+<tr class="row-odd"><td>Types</td>
+<td>Manage types. See <a class="reference internal" href="#tp-types"><span class="std std-ref">Types</span></a></td>
+</tr>
+<tr class="row-even"><td>Statuses</td>
+<td>Manage server statuses. See <a class="reference internal" href="#tp-statuses"><span class="std std-ref">Statuses</span></a></td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div>
+<div class="section" id="topology">
+<h2>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="89%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Option</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Cache Groups</td>
+<td>Manage cache groups. See <a class="reference internal" href="#tp-cache-groups"><span class="std std-ref">Cache Groups</span></a></td>
+</tr>
+<tr class="row-odd"><td>Phys Locations</td>
+<td>Manage profiles. See <a class="reference internal" href="#tp-phys-locations"><span class="std std-ref">Phys Locations</span></a></td>
+</tr>
+<tr class="row-even"><td>Divisions</td>
+<td>Manage divisions. See <a class="reference internal" href="#tp-divisions"><span class="std std-ref">Divisions</span></a></td>
+</tr>
+<tr class="row-odd"><td>Regions</td>
+<td>Manage regions. See <a class="reference internal" href="#tp-regions"><span class="std std-ref">Regions</span></a></td>
+</tr>
+<tr class="row-even"><td>ASNs</td>
+<td>Manage autonomous system numbers (ASN). See <a class="reference internal" href="#tp-asns"><span class="std std-ref">ASNs</span></a></td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div>
+<div class="section" id="tools">
+<h2>Tools<a class="headerlink" href="#tools" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="86%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Option</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Invalidate Content</td>
+<td>Manage invalidate content jobs. See <a class="reference internal" href="#tp-jobs"><span class="std std-ref">Invalidate Content</span></a></td>
+</tr>
+<tr class="row-odd"><td>Generate ISO</td>
+<td>Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See <a class="reference internal" href="#tp-gen-iso"><span class="std std-ref">Generate ISO</span></a></td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div>
+<div class="section" id="user-admin">
+<h2>User Admin<a class="headerlink" href="#user-admin" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="86%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Option</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Users</td>
+<td>Manage users. See <a class="reference internal" href="#tp-users"><span class="std std-ref">Users</span></a></td>
+</tr>
+<tr class="row-odd"><td>Tenants</td>
+<td>Manage tenants. See <a class="reference internal" href="#tp-tenants"><span class="std std-ref">Tenants</span></a></td>
+</tr>
+<tr class="row-even"><td>Roles</td>
+<td>Manage roles. See <a class="reference internal" href="#tp-roles"><span class="std std-ref">Roles</span></a></td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div>
+<div class="section" id="other">
+<h2>Other<a class="headerlink" href="#other" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div><p>Custom menu items. By default, you get a link to Traffic Control docs. See <a class="reference internal" href="#tp-menu-other"><span class="std std-ref">Custom Menu Items</span></a></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="86%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Option</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Docs</td>
+<td>Link to trafficcontrol.apache.org</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div>
+<hr class="docutils" />
+<div class="section" id="id1">
+<h2>Monitor<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
+<img alt="../../_images/tp_menu_monitor.png" src="../../_images/tp_menu_monitor.png" />
+<div class="section" id="cache-checks">
+<span id="tp-cache-checks"></span><h3>Cache Checks<a class="headerlink" href="#cache-checks" title="Permalink to this headline">¶</a></h3>
+<p>The cache checks page is intended to give an overview of the caches managed by Traffic Control as well as their status.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="7%" />
+<col width="93%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Hostname</td>
+<td>Cache host name</td>
+</tr>
+<tr class="row-odd"><td>Profile</td>
+<td>The name of the profile applied to the cache</td>
+</tr>
+<tr class="row-even"><td>Status</td>
+<td>The status of the cache (ONLINE, REPORTED, ADMIN_DOWN, OFFLINE)</td>
+</tr>
+<tr class="row-odd"><td>UPD</td>
+<td>Config updates pending for an edge or mid</td>
+</tr>
+<tr class="row-even"><td>RVL</td>
+<td>Content invalidation requests are pending for and edge or mid</td>
+</tr>
+<tr class="row-odd"><td>ILO</td>
+<td>Ping the iLO interface for EDGE or MID servers</td>
+</tr>
+<tr class="row-even"><td>10G</td>
+<td>Ping the IPv4 address of the EDGE or MID servers</td>
+</tr>
+<tr class="row-odd"><td>FQDN</td>
+<td>DNS check that matches what the DNS servers responds with compared to
+what Traffic Ops has.</td>
+</tr>
+<tr class="row-even"><td>DSCP</td>
+<td>Checks the DSCP value of packets from the edge server to the Traffic
+Ops server.</td>
+</tr>
+<tr class="row-odd"><td>10G6</td>
+<td>Ping the IPv6 address of the EDGE or MID servers</td>
+</tr>
+<tr class="row-even"><td>MTU</td>
+<td>Ping the EDGE or MID using the configured MTU from Traffic Ops</td>
+</tr>
+<tr class="row-odd"><td>RTR</td>
+<td>Content Router checks. Checks the health of the Content Routers. Checks the health of the caches using the Content Routers.</td>
+</tr>
+<tr class="row-even"><td>CHR</td>
+<td>Cache Hit Ratio in percent.</td>
+</tr>
+<tr class="row-odd"><td>CDU</td>
+<td>Total Cache Disk Usage in percent.</td>
+</tr>
+<tr class="row-even"><td>ORT</td>
+<td>Operational Readiness Test. Uses the ORT script on the edge and mid servers to determine if the configuration in Traffic Ops matches the
+configuration on the edge or mid. The user that this script runs as must have an ssh key on the edge servers.</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="cache-stats">
+<span id="tp-cache-stats"></span><h3>Cache Stats<a class="headerlink" href="#cache-stats" title="Permalink to this headline">¶</a></h3>
+<p>Displays health by cache group/profile.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="9%" />
+<col width="91%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Profile</td>
+<td>Name of the profile applied to the edge or mid cache</td>
+</tr>
+<tr class="row-odd"><td>Host</td>
+<td>ALL or grouped by profile</td>
+</tr>
+<tr class="row-even"><td>Cache Group</td>
+<td>Cache Group Name</td>
+</tr>
+<tr class="row-odd"><td>Healthy</td>
+<td>True/False as determined by Traffic Monitor</td>
+</tr>
+<tr class="row-even"><td>Status</td>
+<td>Status of the cache or cache group</td>
+</tr>
+<tr class="row-odd"><td>Connections</td>
+<td>Number of connections</td>
+</tr>
+<tr class="row-even"><td>MbpsOut</td>
+<td>MbpsOut</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="section" id="id2">
+<h2>Services<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
+<img alt="../../_images/tp_menu_services.png" src="../../_images/tp_menu_services.png" />
+<div class="section" id="delivery-services">
+<span id="tp-delivery-services"></span><h3>Delivery Services<a class="headerlink" href="#delivery-services" title="Permalink to this headline">¶</a></h3>
+<p>A table of your delivery services with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Key (XML ID)</td>
+<td>A unique string that identifies this delivery service.</td>
+</tr>
+<tr class="row-odd"><td>Tenant</td>
+<td>The tenant that the delivery service is assigned to.</td>
+</tr>
+<tr class="row-even"><td>Origin</td>
+<td>The Origin Server’s base URL. This includes the protocol (http or https). Example: <code class="docutils literal notranslate"><span class="pre">http://movies.origin.com</span></code></td>
+</tr>
+<tr class="row-odd"><td>Active</td>
+<td>When this is set to false, Traffic Router will not serve DNS or HTTP responses for this delivery service.</td>
+</tr>
+<tr class="row-even"><td>Type</td>
+<td>The type of content routing this delivery service will use. See <a class="reference internal" href="../traffic_ops/using.html#rl-ds-types"><span class="std std-ref">Delivery Service Types</span></a>.</td>
+</tr>
+<tr class="row-odd"><td>Protocol</td>
+<td><p class="first">The protocol to serve this delivery service to the clients with:</p>
+<ul class="last simple">
+<li>HTTP</li>
+<li>HTTPS</li>
+<li>HTTP and HTTPS</li>
+<li>HTTP to HTTPS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td>CDN</td>
+<td>The CDN that the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td>IPv6 Enabled</td>
+<td>When set to true, the Traffic Router will respond to AAAA DNS requests for the routed name of this delivery service.
+Otherwise, only A records will be served.</td>
+</tr>
+<tr class="row-even"><td>DSCP</td>
+<td>The DSCP value to mark IP packets to the client with.</td>
+</tr>
+<tr class="row-odd"><td>Signing Algorithm</td>
+<td>See <a class="reference internal" href="../traffic_ops/using.html#rl-signed-urls"><span class="std std-ref">Token Based Authentication</span></a>.
+- None
+- URL Signature Keys
+- URI Signing Keys</td>
+</tr>
+<tr class="row-even"><td>Query String Handling</td>
+<td><p class="first">How to treat query strings:</p>
+<ul class="simple">
+<li>use in cache key and hand up to origin (each unique query string is treated as a unique URL.)</li>
+<li>do not use in cache key, but pass up to origin (2 URLs that are the same except for the query string will match,
+and cache HIT, while the origin still sees original query string in the request.)</li>
+<li>drop at edge (2 URLs that are the same except for the query string will match, and cache HIT, while the origin
+will not see original query string in the request.)</li>
+</ul>
+<p>Dropping query strings at the edge will preclude the use of a Regex Remap Expression. See <a class="reference internal" href="../traffic_ops/using.html#rl-regex-remap"><span class="std std-ref">Regex Remap Expression</span></a>.</p>
+<p class="last">To set the qstring without the use of regex remap, or for further options, see <a class="reference internal" href="../traffic_ops/using.html#rl-qstring-handling"><span class="std std-ref">Qstring Handling</span></a>.</p>
+</td>
+</tr>
+<tr class="row-odd"><td>Last Updated</td>
+<td>Timestamp when the delivery service was last updated.</td>
+</tr>
+</tbody>
+</table>
+<p>Delivery service management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new delivery service</li>
+<li>clone an existing delivery service</li>
+<li>update an existing delivery service</li>
+<li>delete an existing delivery service</li>
+<li>compare delivery services</li>
+<li>manage delivery service SSL keys</li>
+<li>manage delivery service URL signature keys</li>
+<li>manage delivery service URI signing keys</li>
+<li>view and assign delivery service servers</li>
+<li>create, update and delete delivery service regexes</li>
+<li>view and create delivery service invalidate content jobs</li>
+<li>manage steering targets</li>
+</ul>
+</div>
+<div class="section" id="delivery-service-requests">
+<span id="tp-delivery-service-requests"></span><h3>Delivery Service Requests<a class="headerlink" href="#delivery-service-requests" title="Permalink to this headline">¶</a></h3>
+<p>A table of your delivery service requests with the following columns:</p>
+<img alt="../../_images/tp_table_ds_requests1.png" src="../../_images/tp_table_ds_requests1.png" />
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Delivery Service</td>
+<td>A unique string that identifies the delivery service that the request is associated with.
+This unique string is also known as delivery service key or XML ID.</td>
+</tr>
+<tr class="row-odd"><td>Type</td>
+<td><p class="first">The type of delivery service request:</p>
+<ul class="last simple">
+<li>create (a request to create a new delivery service)</li>
+<li>update (a request to update an existing delivery service)</li>
+<li>delete (a request to delete an existing delivery service)</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td>Status</td>
+<td><p class="first">The status of the delivery service request:</p>
+<ul class="last simple">
+<li>draft (the delivery service request is NOT ready for review and fulfillment)</li>
+<li>submitted (the delivery service request is ready for review and fulfillment)</li>
+<li>rejected (the delivery service request has been rejected and cannot be modified)</li>
+<li>pending (the delivery service request has been fulfilled but the changes have yet to be deployed)</li>
+<li>complete (the delivery service request has been fulfilled and the changes have been deployed)</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td>Author</td>
+<td>The user responsible for creating the delivery service request.</td>
+</tr>
+<tr class="row-even"><td>Assignee</td>
+<td>The user responsible for fulfilling the delivery service request. Currently, the operations role or above is
+required to assign delivery service requests.</td>
+</tr>
+<tr class="row-odd"><td>Last Edited By</td>
+<td>The last user to edit the delivery service request.</td>
+</tr>
+<tr class="row-even"><td>Created</td>
+<td>Relative time indicating when the delivery service was created.</td>
+</tr>
+<tr class="row-odd"><td>Actions</td>
+<td><p class="first">Actions that can be performed on a delivery service request:</p>
+<ul class="last simple">
+<li>fulfill (Implement the changes captured in the delivery service request.)</li>
+<li>reject (Reject the changes captured in the delivery service request.)</li>
+<li>delete (Delete the delivery service request.)</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<p>Delivery service request management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new delivery service request</li>
+<li>update an existing delivery service request</li>
+<li>delete an existing delivery service request</li>
+<li>update the status of a delivery service request</li>
+<li>assign a delivery service request</li>
+<li>reject a delivery service request</li>
+<li>fulfill a delivery service request</li>
+<li>complete a delivery service request</li>
+</ul>
+<p>See <a class="reference internal" href="../quick_howto/ds_requests.html#ds-requests"><span class="std std-ref">Delivery Service Requests</span></a> for details.</p>
+</div>
+</div>
+<div class="section" id="id3">
+<h2>Configure<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
+<img alt="../../_images/tp_menu_configure.png" src="../../_images/tp_menu_configure.png" />
+<div class="section" id="servers">
+<span id="tp-servers"></span><h3>Servers<a class="headerlink" href="#servers" title="Permalink to this headline">¶</a></h3>
+<p>A table of servers with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>UPD</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Host</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Domain</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>IP</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>IPv6</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Status</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Type</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Profile</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>CDN</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Cache Group</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>ISO</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Server management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new server</li>
+<li>update an existing server</li>
+<li>delete an existing server</li>
+<li>queue/clear updates on a server</li>
+<li>update server status</li>
+<li>view server delivery services</li>
+<li>view server config files</li>
+<li>clone delivery service assignments</li>
+<li>assign delivery services to server</li>
+</ul>
+</div>
+<div class="section" id="profiles">
+<span id="tp-profiles"></span><h3>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline">¶</a></h3>
+<p>A table of profiles with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Type</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Routing Disabled</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Description</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>CDN</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Profile management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new profile</li>
+<li>update an existing profile</li>
+<li>delete an existing profile</li>
+<li>clone a profile</li>
+<li>export a profile</li>
+<li>view profile parameters</li>
+<li>view profile delivery services</li>
+<li>view profile servers</li>
+</ul>
+<p>See <a class="reference internal" href="../traffic_ops/using.html#rl-working-with-profiles"><span class="std std-ref">Parameters and Profiles</span></a> for details.</p>
+</div>
+<div class="section" id="parameters">
+<span id="tp-parameters"></span><h3>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h3>
+<p>A table of parameters with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Config File</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Value</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Parameter management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new parameter</li>
+<li>update an existing parameter</li>
+<li>delete an existing parameter</li>
+<li>view parameter profiles</li>
+</ul>
+</div>
+<div class="section" id="types">
+<span id="tp-types"></span><h3>Types<a class="headerlink" href="#types" title="Permalink to this headline">¶</a></h3>
+<p>A table of types with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Use In Table</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Description</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Type management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new type</li>
+<li>update an existing type</li>
+<li>delete an existing type</li>
+<li>view delivery services assigned to a type</li>
+<li>view servers assigned to a type</li>
+<li>view cache groups assigned to a type</li>
+</ul>
+</div>
+<div class="section" id="statuses">
+<span id="tp-statuses"></span><h3>Statuses<a class="headerlink" href="#statuses" title="Permalink to this headline">¶</a></h3>
+<p>A table of statuses with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Description</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Status management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new status</li>
+<li>update an existing status</li>
+<li>delete an existing status</li>
+<li>view status servers</li>
+</ul>
+</div>
+</div>
+<div class="section" id="id4">
+<h2>Topology<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
+<img alt="../../_images/tp_menu_topology.png" src="../../_images/tp_menu_topology.png" />
+<div class="section" id="cache-groups">
+<span id="tp-cache-groups"></span><h3>Cache Groups<a class="headerlink" href="#cache-groups" title="Permalink to this headline">¶</a></h3>
+<p>A table of cache groups with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Short Name</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Type</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Latitude</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Longitude</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Cache group management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new cache group</li>
+<li>update an existing cache group</li>
+<li>delete an existing cache group</li>
+<li>queue/clear updates for all servers in a cache group</li>
+<li>view cache group ASNs</li>
+<li>view and assign cache group parameters</li>
+<li>view cache group servers</li>
+</ul>
+</div>
+<div class="section" id="phys-locations">
+<span id="tp-phys-locations"></span><h3>Phys Locations<a class="headerlink" href="#phys-locations" title="Permalink to this headline">¶</a></h3>
+<p>A table of physical locations with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Short Name</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Address</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>City</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>State</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Region</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Physical location management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new physical location</li>
+<li>update an existing physical location</li>
+<li>delete an existing physical location</li>
+<li>view physical location servers</li>
+</ul>
+</div>
+<div class="section" id="divisions">
+<span id="tp-divisions"></span><h3>Divisions<a class="headerlink" href="#divisions" title="Permalink to this headline">¶</a></h3>
+<p>A table of divisions with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Division management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new division</li>
+<li>update an existing division</li>
+<li>delete an existing division</li>
+<li>view division regions</li>
+</ul>
+</div>
+<div class="section" id="regions">
+<span id="tp-regions"></span><h3>Regions<a class="headerlink" href="#regions" title="Permalink to this headline">¶</a></h3>
+<p>A table of regions with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Division</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Region management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new region</li>
+<li>update an existing region</li>
+<li>delete an existing region</li>
+<li>view region physical locations</li>
+</ul>
+</div>
+<div class="section" id="asns">
+<span id="tp-asns"></span><h3>ASNs<a class="headerlink" href="#asns" title="Permalink to this headline">¶</a></h3>
+<p>A table of ASNs with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>ASN</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Cache Group</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>ASN management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new ASN</li>
+<li>update an existing ASN</li>
+<li>delete an existing ASN</li>
+</ul>
+</div>
+</div>
+<div class="section" id="id5">
+<h2>Tools<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
+<img alt="../../_images/tp_menu_tools.png" src="../../_images/tp_menu_tools.png" />
+<div class="section" id="invalidate-content">
+<span id="tp-jobs"></span><h3>Invalidate Content<a class="headerlink" href="#invalidate-content" title="Permalink to this headline">¶</a></h3>
+<p>A table of invalidate content jobs with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Delivery Service</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Asset URL</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Parameters</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Start</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Created By</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Invalidate content includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new invalidate content job</li>
+</ul>
+</div>
+<div class="section" id="generate-iso">
+<span id="tp-gen-iso"></span><h3>Generate ISO<a class="headerlink" href="#generate-iso" title="Permalink to this headline">¶</a></h3>
+<p>See <a class="reference internal" href="../traffic_ops/using.html#rl-generate-iso"><span class="std std-ref">Generate ISO</span></a></p>
+</div>
+</div>
+<div class="section" id="id6">
+<h2>User Admin<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
+<img alt="../../_images/tp_menu_user_admin.png" src="../../_images/tp_menu_user_admin.png" />
+<div class="section" id="users">
+<span id="tp-users"></span><h3>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h3>
+<p>A table of users with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Full Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Username</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Email</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Tenant</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Role</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>User management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>register a new user</li>
+<li>create a new user</li>
+<li>update an existing user</li>
+<li>view delivery services visible to a user</li>
+</ul>
+</div>
+<div class="section" id="tenants">
+<span id="tp-tenants"></span><h3>Tenants<a class="headerlink" href="#tenants" title="Permalink to this headline">¶</a></h3>
+<p>A table of tenants with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Active</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Parent</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Tenant management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>create a new tenant</li>
+<li>update an existing tenant</li>
+<li>delete an existing tenant</li>
+<li>view users assigned to a tenant</li>
+<li>view delivery services assigned to a tenant</li>
+</ul>
+</div>
+<div class="section" id="roles">
+<span id="tp-roles"></span><h3>Roles<a class="headerlink" href="#roles" title="Permalink to this headline">¶</a></h3>
+<p>A table of roles with the following columns:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Name</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>Privilege Level</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>Description</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p>Role management includes the ability to (where applicable):</p>
+<ul class="simple">
+<li>view all roles</li>
+</ul>
+</div>
+</div>
+<div class="section" id="id7">
+<h2>Other<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2>
+<img alt="../../_images/tp_menu_other.png" src="../../_images/tp_menu_other.png" />
+<div class="section" id="custom-menu-items">
+<span id="tp-menu-other"></span><h3>Custom Menu Items<a class="headerlink" href="#custom-menu-items" title="Permalink to this headline">¶</a></h3>
+<p>This section is configurable in tp.domain.com/traffic_portal_properties.json in the customMenu section.</p>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor Administration (Legacy)">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="installation.html" class="btn btn-neutral" title="Traffic Portal Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/admin/traffic_router.html b/docs/latest/admin/traffic_router.html
index ba1ea23..ba9d936 100644
--- a/docs/latest/admin/traffic_router.html
+++ b/docs/latest/admin/traffic_router.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Router Administration — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Router Administration — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Stats Administration" href="traffic_stats.html"/>
<link rel="prev" title="Traffic Monitor Administration" href="traffic_monitor_golang.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Administrator’s Guide</a> »</li>
+ <li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Router Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_router.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_router.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -194,16 +208,17 @@
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
-<li><a class="reference internal" href="#traffic-router-administration" id="id4">Traffic Router Administration</a><ul>
-<li><a class="reference internal" href="#installing-traffic-router" id="id5">Installing Traffic Router</a></li>
-<li><a class="reference internal" href="#configuring-traffic-router" id="id6">Configuring Traffic Router</a></li>
-<li><a class="reference internal" href="#dnssec" id="id7">DNSSEC</a></li>
-<li><a class="reference internal" href="#troubleshooting-and-log-files" id="id8">Troubleshooting and log files</a></li>
-<li><a class="reference internal" href="#event-log-file-format" id="id9">Event Log File Format</a></li>
-<li><a class="reference internal" href="#geolimit-failure-redirect-feature" id="id10">GeoLimit Failure Redirect feature</a></li>
-<li><a class="reference internal" href="#steering-feature" id="id11">Steering feature</a></li>
-<li><a class="reference internal" href="#https-for-http-type-delivery-services" id="id12">HTTPS for Http Type Delivery Services</a></li>
-<li><a class="reference internal" href="#tuning-recommendations" id="id13">Tuning Recommendations</a></li>
+<li><a class="reference internal" href="#traffic-router-administration" id="id5">Traffic Router Administration</a><ul>
+<li><a class="reference internal" href="#installing-traffic-router" id="id6">Installing Traffic Router</a></li>
+<li><a class="reference internal" href="#configuring-traffic-router" id="id7">Configuring Traffic Router</a></li>
+<li><a class="reference internal" href="#dnssec" id="id8">DNSSEC</a></li>
+<li><a class="reference internal" href="#troubleshooting-and-log-files" id="id9">Troubleshooting and log files</a></li>
+<li><a class="reference internal" href="#event-log-file-format" id="id10">Event Log File Format</a></li>
+<li><a class="reference internal" href="#geolimit-failure-redirect-feature" id="id11">GeoLimit Failure Redirect feature</a></li>
+<li><a class="reference internal" href="#deep-caching-deep-coverage-zone-topology" id="id12">Deep Caching - Deep Coverage Zone Topology</a></li>
+<li><a class="reference internal" href="#steering-feature" id="id13">Steering feature</a></li>
+<li><a class="reference internal" href="#https-for-http-type-delivery-services" id="id14">HTTPS for Http Type Delivery Services</a></li>
+<li><a class="reference internal" href="#tuning-recommendations" id="id15">Tuning Recommendations</a></li>
</ul>
</li>
</ul>
@@ -226,14 +241,14 @@
<ol class="arabic">
<li><p class="first">If no suitable profile exists, create a new profile for Traffic Router.</p>
</li>
-<li><p class="first">Enter the Traffic Router server into Traffic Ops, assign it to a Traffic Router profile, and ensure that its status is set to <code class="docutils literal"><span class="pre">ONLINE</span></code>.</p>
+<li><p class="first">Enter the Traffic Router server into Traffic Ops, assign it to a Traffic Router profile, and ensure that its status is set to <code class="docutils literal notranslate"><span class="pre">ONLINE</span></code>.</p>
</li>
<li><p class="first">Ensure the FQDN of the Traffic Router is resolvable in DNS. This FQDN must be resolvable by the clients expected to use this CDN.</p>
</li>
-<li><p class="first">Install a traffic router: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">install</span> <span class="pre">traffic_router</span></code>.</p>
+<li><p class="first">Install a traffic router: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">install</span> <span class="pre">traffic_router</span></code>.</p>
</li>
<li><dl class="first docutils">
-<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><span class="std std-ref">Configuration files</span></a></dt>
+<dt>Edit <code class="docutils literal notranslate"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><span class="std std-ref">Configuration files</span></a></dt>
<dd><p class="first"># traffic_monitor.properties: url that should normally point to this file
traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.properties</p>
<p class="last"># Frequency for reloading this file
@@ -242,8 +257,8 @@
</dl>
</li>
<li><dl class="first docutils">
-<dt>Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code>, and test lookups with dig and curl against that server.</dt>
-<dd><p class="first last">To restart, <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">stop</span></code>, kill the traffic router process, and <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code>
+<dt>Start Tomcat: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code>, and test lookups with dig and curl against that server.</dt>
+<dd><p class="first last">To restart, <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">stop</span></code>, kill the traffic router process, and <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code>
Also, crconfig previously recieved will be cached, and needs to be removed manually to actually be reloaded /opt/traffic_router/db/cr-config.json</p>
</dd>
</dl>
@@ -253,21 +268,21 @@
</ol>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">Once the CRConfig is snapshotted, live traffic will be sent to the new Traffic Routers provided that their status is set to <code class="docutils literal"><span class="pre">ONLINE</span></code>.</p>
+<p class="last">Once the CRConfig is snapshotted, live traffic will be sent to the new Traffic Routers provided that their status is set to <code class="docutils literal notranslate"><span class="pre">ONLINE</span></code>.</p>
</div>
<ol class="arabic simple" start="8">
-<li>Ensure that the parent domain (e.g.: kabletown.net) for the CDN’s top level domain (e.g.: cdn.kabletown.net) contains a delegation (NS records) for the new Traffic Router, and that the value specified matches the FQDN used in step 3.</li>
+<li>Ensure that the parent domain (e.g.: kabletown.net) for the CDN’s top level domain (e.g.: cdn.kabletown.net) contains a delegation (NS records) for the new Traffic Router, and that the value specified matches the FQDN used in step 3.</li>
</ol>
</div>
<div class="section" id="configuring-traffic-router">
<h2><a class="toc-backref" href="#contents">Configuring Traffic Router</a><a class="headerlink" href="#configuring-traffic-router" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">Starting with Traffic Router 1.5, many of the configuration files under <code class="docutils literal"><span class="pre">/opt/traffic_router/conf</span></code> are only needed to override the default configuration values for Traffic Router. Most of the given default values will work well for any CDN. Critical values that must be changed are hostnames and credentials for communicating with other Traffic Control components such as Traffic Ops and Traffic Monitor.</p>
+<p class="last">Starting with Traffic Router 1.5, many of the configuration files under <code class="docutils literal notranslate"><span class="pre">/opt/traffic_router/conf</span></code> are only needed to override the default configuration values for Traffic Router. Most of the given default values will work well for any CDN. Critical values that must be changed are hostnames and credentials for communicating with other Traffic Control components such as Traffic Ops and Traffic Monitor.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">Pre-existing installations having configuration files in <code class="docutils literal"><span class="pre">/opt/traffic_router/conf</span></code> will still be used and honored for Traffic Router 1.5 and onward.</p>
+<p class="last">Pre-existing installations having configuration files in <code class="docutils literal notranslate"><span class="pre">/opt/traffic_router/conf</span></code> will still be used and honored for Traffic Router 1.5 and onward.</p>
</div>
<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops/using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops/using.html#rl-ccr-profile"><span class="std std-ref">Traffic Router Profile</span></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p>
<div class="section" id="configuration-files">
@@ -304,7 +319,7 @@
<td>The interval in milliseconds which Traffic Router will reload this configuration file</td>
<td>60000</td>
</tr>
-<tr class="row-even"><td rowspan="6">dns.properties</td>
+<tr class="row-even"><td rowspan="5">dns.properties</td>
<td>dns.tcp.port</td>
<td>TCP port that Traffic Router will use for incoming DNS requests</td>
<td>53</td>
@@ -325,25 +340,16 @@
<td>Path to auto generated zone files for reference</td>
<td>/opt/traffic_router/var/auto-zones</td>
</tr>
-<tr class="row-odd"><td>dns.routing.name</td>
-<td>The label (A/AAAA) Traffic Router will use for the entry point for a DNS delivery service</td>
-<td>edge (e.g.: edge.mydeliveryservice.kabletown.net)</td>
-</tr>
-<tr class="row-even"><td rowspan="2">traffic_ops.properties</td>
+<tr class="row-odd"><td rowspan="2">traffic_ops.properties</td>
<td>traffic_ops.username</td>
<td>Username to access the APIs in Traffic Ops (must be in the admin role)</td>
<td>admin</td>
</tr>
-<tr class="row-odd"><td>traffic_ops.password</td>
+<tr class="row-even"><td>traffic_ops.password</td>
<td>Password for the user specified in traffic_ops.username</td>
<td>N/A</td>
</tr>
-<tr class="row-even"><td>http.properties</td>
-<td>http.routing.name</td>
-<td>The label (A/AAAA) Traffic Router will use for the entry point for an HTTP delivery service</td>
-<td>tr (e.g.: tr.mydeliveryservice.kabletown.net)</td>
-</tr>
-<tr class="row-odd"><td rowspan="8">cache.properties</td>
+<tr class="row-odd"><td rowspan="10">cache.properties</td>
<td>cache.geolocation.database</td>
<td>Full path to the local copy of the MaxMind geolocation binary database file</td>
<td>/opt/traffic_router/db/GeoIP2-City.mmdb</td>
@@ -360,6 +366,14 @@
<td>The interval in milliseconds which Traffic Router will poll for a new coverage zone file</td>
<td>10800000</td>
</tr>
+<tr class="row-odd"><td>cache.dczmap.database</td>
+<td>Full path to the local copy of the deep coverage zone file</td>
+<td>/opt/traffic_router/db/dczmap.json</td>
+</tr>
+<tr class="row-even"><td>cache.dczmap.database.refresh.period</td>
+<td>The interval in milliseconds which Traffic Router will poll for a new deep coverage zone file</td>
+<td>10800000</td>
+</tr>
<tr class="row-odd"><td>cache.health.json</td>
<td>Full path to the local copy of the health state</td>
<td>/opt/traffic_router/db/health.json</td>
@@ -395,9 +409,9 @@
</div>
<div class="section" id="operation">
<h3>Operation<a class="headerlink" href="#operation" title="Permalink to this headline">¶</a></h3>
-<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops/using.html#rl-ccr-profile"><span class="std std-ref">Traffic Router Profile</span></a> documentation for more information.</p>
-<p>Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service’s zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD’s zone. A DS record is generated from each zone’s KSK and is placed in the CDN TLD’s zone (e.g.: cdn.kabletown.net); the DS record for the CDN TLD must be placed in its parent zone, which is not managed by Traffic Control.</p>
-<p>The DNSKEY to DS record relationship allows resolvers to validate signatures across zone delegation points; with Traffic Control, we control all delegation points below the CDN’s TLD, <strong>however, the DS record for the CDN TLD must be placed in the parent zone (e.g.: kabletown.net), which is not managed by Traffic Control</strong>. As such, the DS record (available in the Traffic Ops DNSSEC administration UI) must be placed in the parent zone prior to enabling DNSSEC, and prior to generating a new CDN KSK. Based on your deployment’s DNS configuration, this might be a manual process or it might be automated; either way, extreme care and diligence must be taken and knowledge of the management of the upstream zone is imperative for a successful DNSSEC deployment.</p>
+<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops/using.html#rl-ccr-profile"><span class="std std-ref">Traffic Router Profile</span></a> documentation for more information.</p>
+<p>Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service’s zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD’s zone. A DS record is generated from each zone’s KSK and is placed in the CDN TLD’s zone (e.g.: cdn.kabletown.net); the DS record for the CDN TLD must be placed in its parent zone, which is not managed by Traffic Control.</p>
+<p>The DNSKEY to DS record relationship allows resolvers to validate signatures across zone delegation points; with Traffic Control, we control all delegation points below the CDN’s TLD, <strong>however, the DS record for the CDN TLD must be placed in the parent zone (e.g.: kabletown.net), which is not managed by Traffic Control</strong>. As such, the DS record (available in the Traffic Ops DNSSEC administration UI) must be placed in the parent zone prior to enabling DNSSEC, and prior to generating a new CDN KSK. Based on your deployment’s DNS configuration, this might be a manual process or it might be automated; either way, extreme care and diligence must be taken and knowledge of the management of the upstream zone is imperative for a successful DNSSEC deployment.</p>
</div>
<div class="section" id="rolling-zone-signing-keys">
<h3>Rolling Zone Signing Keys<a class="headerlink" href="#rolling-zone-signing-keys" title="Permalink to this headline">¶</a></h3>
@@ -406,13 +420,13 @@
</div>
<div class="section" id="troubleshooting-and-log-files">
<h2><a class="toc-backref" href="#contents">Troubleshooting and log files</a><a class="headerlink" href="#troubleshooting-and-log-files" title="Permalink to this headline">¶</a></h2>
-<p>Traffic Router log files are in <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log</span></code>, and Tomcat log files are in <code class="docutils literal"><span class="pre">/opt/tomcat/logs</span></code>. Application related logging is in <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log/traffic_router.log</span></code>, while access logs are written to <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log/access.log</span></code>.</p>
+<p>Traffic Router log files are in <code class="docutils literal notranslate"><span class="pre">/opt/traffic_router/var/log</span></code>, and Tomcat log files are in <code class="docutils literal notranslate"><span class="pre">/opt/tomcat/logs</span></code>. Application related logging is in <code class="docutils literal notranslate"><span class="pre">/opt/traffic_router/var/log/traffic_router.log</span></code>, while access logs are written to <code class="docutils literal notranslate"><span class="pre">/opt/traffic_router/var/log/access.log</span></code>.</p>
</div>
<div class="section" id="event-log-file-format">
<h2><a class="toc-backref" href="#contents">Event Log File Format</a><a class="headerlink" href="#event-log-file-format" title="Permalink to this headline">¶</a></h2>
<div class="section" id="summary">
<h3>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h3>
-<p>All access events to Traffic Router are logged to the file <code class="docutils literal"><span class="pre">/opt/traffic_router/var/log/access.log</span></code>
+<p>All access events to Traffic Router are logged to the file <code class="docutils literal notranslate"><span class="pre">/opt/traffic_router/var/log/access.log</span></code>
This file grows up to 200Mb and gets rolled into older log files, 10 log files total are kept (total of up to 2Gb of logged events per traffic router)</p>
<p>Traffic Router logs access events in a format that largely following <a class="reference external" href="https://docs.trafficserver.apache.org/en/6.0.x/admin/event-logging-formats.en.html">ATS event logging format</a></p>
</div>
@@ -420,7 +434,7 @@
<div class="section" id="sample-message">
<h3>Sample Message<a class="headerlink" href="#sample-message" title="Permalink to this headline">¶</a></h3>
<p>Items within brackets below are detailed under the HTTP and DNS sections</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">result</span><span class="p">]</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">result</span><span class="p">]</span>
<span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">HTTP</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">HTTP</span> <span class="n">result</span><span class="p">]</span>
</pre></div>
</div>
@@ -445,8 +459,8 @@
<table border="1" class="docutils">
<colgroup>
<col width="4%" />
-<col width="50%" />
-<col width="46%" />
+<col width="47%" />
+<col width="49%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
@@ -469,7 +483,7 @@
</tr>
<tr class="row-odd"><td>rtype</td>
<td>Routing Result Type</td>
-<td>One of ERROR, CZ, GEO, MISS, STATIC_ROUTE, DS_REDIRECT, DS_MISS, INIT, FED</td>
+<td>One of ERROR, CZ, DEEP_CZ, GEO, MISS, STATIC_ROUTE, DS_REDIRECT, DS_MISS, INIT, FED</td>
</tr>
<tr class="row-even"><td>rloc</td>
<td>GeoLocation of result</td>
@@ -477,7 +491,7 @@
</tr>
<tr class="row-odd"><td>rdtl</td>
<td>Result Details Associated with unusual conditions</td>
-<td>One of DS_NOT_FOUND, DS_NO_BYPASS, DS_BYPASS, DS_CZ_ONLY</td>
+<td>One of DS_NOT_FOUND, DS_NO_BYPASS, DS_BYPASS, DS_CZ_ONLY, DS_CZ_BACKUP_CG</td>
</tr>
<tr class="row-even"><td>rerr</td>
<td>Message about internal Traffic Router Error</td>
@@ -503,31 +517,48 @@
<tr class="row-odd"><td>CZ</td>
<td>The result was derived from Coverage Zone data based on the address in the chi field</td>
</tr>
-<tr class="row-even"><td>GEO</td>
+<tr class="row-even"><td>DEEP_CZ</td>
+<td>The result was derived from Deep Coverage Zone data based on the address in the chi field</td>
+</tr>
+<tr class="row-odd"><td>GEO</td>
<td>The result was derived from geolocation service based on the address in the chi field</td>
</tr>
-<tr class="row-odd"><td>MISS</td>
+<tr class="row-even"><td>MISS</td>
<td>Traffic Router was unable to resolve a DNS request or find a cache for the requested resource</td>
</tr>
-<tr class="row-even"><td>STATIC_ROUTE</td>
+<tr class="row-odd"><td>STATIC_ROUTE</td>
<td>_*DNS Only*_ No DNS Delivery Service supports the hostname portion of the requested url</td>
</tr>
-<tr class="row-odd"><td>DS_MISS</td>
-<td>_*HTTP Only*_ No HTTP Delivery Service supports either this request’s URL path or headers</td>
+<tr class="row-even"><td>DS_MISS</td>
+<td>_*HTTP Only*_ No HTTP Delivery Service supports either this request’s URL path or headers</td>
</tr>
-<tr class="row-even"><td>DS_REDIRECT</td>
+<tr class="row-odd"><td>DS_REDIRECT</td>
<td>The result is using the Bypass Destination configured for the matched Delivery Service when that Delivery Service is unavailable or does not have the requested resource</td>
</tr>
-<tr class="row-odd"><td>FED</td>
+<tr class="row-even"><td>FED</td>
<td>_*DNS Only*_ The result was obtained through federated coverage zone data outside of any delivery service</td>
</tr>
+<tr class="row-odd"><td>GEO_REDIRECT</td>
+<td>The request was redirected (302) based on the National Geo blocking (Geo Limit Redirect URL) configured on the Delivery Service.</td>
+</tr>
+<tr class="row-even"><td>RGALT</td>
+<td>The request was redirected (302) to the Regional Geo blocking URL. Regional Geo blocking is enabled on the Delivery Service and is configured through the
+regional_geoblock.polling.url setting for the Traffic Router profile.</td>
+</tr>
+<tr class="row-odd"><td>RGDENY</td>
+<td>_*DNS Only*_ The result was obtained through federated coverage zone data outside of any delivery service The request was regionally blocked because there was no rule
+for the request made.</td>
+</tr>
+<tr class="row-even"><td>“-“</td>
+<td>The request was not redirected. This is usually a result of a DNS request to the Traffic Router or an explicit denial for that request.</td>
+</tr>
</tbody>
</table>
<p><strong>rdtl meanings</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="16%" />
-<col width="84%" />
+<col width="22%" />
+<col width="78%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Name</th>
@@ -551,7 +582,22 @@
<td>Traffic Router did not find a resource supported by coverage zone data and was unable to determine the geolocation of the requesting client</td>
</tr>
<tr class="row-odd"><td>GEO_NO_CACHE_FOUND</td>
-<td>Traffic Router could not find a resource via geolocation data based on the requesting client’s geolocation</td>
+<td>Traffic Router could not find a resource via geolocation data based on the requesting client’s geolocation</td>
+</tr>
+<tr class="row-even"><td>NO_DETAILS</td>
+<td>This entry is for a standard request.</td>
+</tr>
+<tr class="row-odd"><td>REGIONAL_GEO_ALTERNATE_WITHOUT_CACHE</td>
+<td>This goes with the rtype RGDENY. The URL is being regionally Geo blocked.</td>
+</tr>
+<tr class="row-even"><td>REGIONAL_GEO_NO_RULE</td>
+<td>The request was blocked because there was no rule in the Delivery Service for the request.</td>
+</tr>
+<tr class="row-odd"><td>“-“</td>
+<td>The request was not redirected. This is usually a result of a DNS request to the Traffic Router or an explicit denial for that request.</td>
+</tr>
+<tr class="row-even"><td>DS_CZ_BACKUP_CG</td>
+<td>Traffic Router found a backup cache via fallback (cr-config’s edgeLocation) / coordinates (CZF) configuration</td>
</tr>
</tbody>
</table>
@@ -560,7 +606,7 @@
<div class="section" id="http-specifics">
<h3>HTTP Specifics<a class="headerlink" href="#http-specifics" title="Permalink to this headline">¶</a></h3>
<p>Sample Message</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1452197640.936</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">69.241</span><span class="o">.</span><span class="mf">53.218</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">0</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"Accept: */*"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"myheader: asdasdasdasfasg"</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1452197640.936</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">69.241</span><span class="o">.</span><span class="mf">53.218</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://foo.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">0</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"Accept: */*"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"myheader: asdasdasdasfasg"</span>
</pre></div>
</div>
<p><strong>Request Fields</strong></p>
@@ -591,7 +637,7 @@
</tr>
<tr class="row-odd"><td>rh</td>
<td>One or more of these key value pairs may exist in a logged event and are controlled by the configuration of the matched Delivery Service</td>
-<td>Key value pair of the format “name: value”</td>
+<td>Key value pair of the format “name: value”</td>
</tr>
</tbody>
</table>
@@ -620,7 +666,7 @@
<div class="section" id="dns-specifics">
<h3>DNS Specifics<a class="headerlink" href="#dns-specifics" title="Permalink to this headline">¶</a></h3>
<p>Sample Message</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">123</span> <span class="n">xn</span><span class="o">=</span><span class="mi">65535</span> <span class="n">fqdn</span><span class="o">=</span><span class="n">www</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">.</span> <span class="nb">type</span><span class="o">=</span><span class="n">A</span> <span class="n">class</span><span class="o">=</span><span class="n">IN</span> <span class="n">ttl</span><span class="o">=</span><span class="mi">12345</span> <span class="n">rcode</span><span class="o">=</span><span class="n">NOERROR</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">ans</span><span class="o">=</span><span class="s2">"192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">123</span> <span class="n">xn</span><span class="o">=</span><span class="mi">65535</span> <span class="n">fqdn</span><span class="o">=</span><span class="n">www</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">.</span> <span class="nb">type</span><span class="o">=</span><span class="n">A</span> <span class="n">class</span><span class="o">=</span><span class="n">IN</span> <span class="n">ttl</span><span class="o">=</span><span class="mi">12345</span> <span class="n">rcode</span><span class="o">=</span><span class="n">NOERROR</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">ans</span><span class="o">=</span><span class="s2">"192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"</span>
</pre></div>
</div>
<p><strong>Request Fields</strong></p>
@@ -644,12 +690,12 @@
<tr class="row-odd"><td>fqdn</td>
<td>The qname field from the client DNS request message (i.e. The
fully qualified domain name the client is requesting be resolved)</td>
-<td>A series of DNS labels/domains separated by ‘.’
-characters and ending with a ‘.’ character (see <a class="reference external" href="http://www.zytrax.com/books/dns/ch15/#qname">qname</a>)</td>
+<td>A series of DNS labels/domains separated by ‘.’
+characters and ending with a ‘.’ character (see <a class="reference external" href="http://www.zytrax.com/books/dns/ch15/#qname">qname</a>)</td>
</tr>
<tr class="row-even"><td>type</td>
<td>The qtype field from the client DNS request message (i.e.
-the type of resolution that’s requested such as IPv4, IPv6)</td>
+the type of resolution that’s requested such as IPv4, IPv6)</td>
<td><dl class="first last docutils">
<dt>Examples are A (IpV4), AAAA (IpV6), NS (Name Service),</dt>
<dd>SOA (Start of Authority), and CNAME, (see <a class="reference external" href="http://www.zytrax.com/books/dns/ch15/#qtype">qtype</a>)</dd>
@@ -682,7 +728,7 @@
</thead>
<tbody valign="top">
<tr class="row-even"><td>ttl</td>
-<td>The ‘time to live’ in seconds for the answer provided by Traffic
+<td>The ‘time to live’ in seconds for the answer provided by Traffic
Router (clients can reliably use this answer for this long without
re-querying traffic router)</td>
<td>A number from 0 to 4294967295</td>
@@ -702,35 +748,79 @@
<span id="rl-tr-ngb"></span><h2><a class="toc-backref" href="#contents">GeoLimit Failure Redirect feature</a><a class="headerlink" href="#geolimit-failure-redirect-feature" title="Permalink to this headline">¶</a></h2>
<div class="section" id="id1">
<h3>Overview<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
-<p>This feature is also called ‘National GeoBlock’ feature which is short for ‘NGB’ feature. In this section, the acronym ‘NGB’ will be used for this feature.</p>
-<p>In the past, if the Geolimit check fails (for example, the client ip is not in the ‘US’ region but the geolimit is set to ‘CZF + US’), the router will return 503 response; but with this feature, when the check fails, it will return 302 if the redirect url is set in the delivery service.</p>
+<p>This feature is also called ‘National GeoBlock’ feature which is short for ‘NGB’ feature. In this section, the acronym ‘NGB’ will be used for this feature.</p>
+<p>In the past, if the Geolimit check fails (for example, the client ip is not in the ‘US’ region but the geolimit is set to ‘CZF + US’), the router will return 503 response; but with this feature, when the check fails, it will return 302 if the redirect url is set in the delivery service.</p>
<p>The Geolimit check failure has such scenarios:
-1) When the GeoLimit is set to ‘CZF + only’, if the client ip is not in the the CZ file, the check fails
-2) When the GeoLimit is set to any region, like ‘CZF + US’, if the client ip is not in such region, and the client ip is not in the CZ file, the check fails</p>
+1) When the GeoLimit is set to ‘CZF + only’, if the client ip is not in the the CZ file, the check fails
+2) When the GeoLimit is set to any region, like ‘CZF + US’, if the client ip is not in such region, and the client ip is not in the CZ file, the check fails</p>
</div>
<div class="section" id="configuration">
<h3>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h3>
-<p>To enable the NGB feature, the DS must be configured with the proper redirect url. And the setting lays at ‘Delivery Services’->Edit->’GeoLimit Redirect URL’. If no url is put in this field, the feature is disabled.</p>
+<p>To enable the NGB feature, the DS must be configured with the proper redirect url. And the setting lays at ‘Delivery Services’->Edit->’GeoLimit Redirect URL’. If no url is put in this field, the feature is disabled.</p>
<p>The URL has 3 kinds of formats, which have different meanings:</p>
<ol class="arabic simple">
-<li>URL with no domain. If no domain is in the URL (like ‘vod/dance.mp4’), the router will try to find a proper cache server within the delivery service and return the redirect url with the format like ‘<a class="reference external" href="http:/">http:/</a>/<cache server name>.<delivery service’s FQDN>/<configured relative path>’</li>
+<li>URL with no domain. If no domain is in the URL (like ‘vod/dance.mp4’), the router will try to find a proper cache server within the delivery service and return the redirect url with the format like ‘<a class="reference external" href="http:/">http:/</a>/<cache server name>.<delivery service’s FQDN>/<configured relative path>’</li>
<li>URL with domain that matches with the delivery service. For this URL, the router will also try to find a proper cache server within the delivery service and return the same format url as point 1.</li>
-<li>URL with domain that doesn’t match with the delivery service. For this URL, the router will return the configured url directly to the client.</li>
+<li>URL with domain that doesn’t match with the delivery service. For this URL, the router will return the configured url directly to the client.</li>
</ol>
</div>
</div>
+<div class="section" id="deep-caching-deep-coverage-zone-topology">
+<span id="rl-deep-cache"></span><h2><a class="toc-backref" href="#contents">Deep Caching - Deep Coverage Zone Topology</a><a class="headerlink" href="#deep-caching-deep-coverage-zone-topology" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="id2">
+<h3>Overview<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
+<p>Deep Caching is a feature that enables clients to be routed to the closest
+possible “deep” edge caches on a per Delivery Service basis. The term “deep” is
+used in the networking sense, meaning that the edge caches are located deep in
+the network where the number of network hops to a client is as minimal as
+possible. This deep caching topology is desirable because storing content closer
+to the client gives better bandwidth savings, and sometimes the cost of
+bandwidth usage in the network outweighs the cost of adding storage. While it
+may not be feasible to cache an entire copy of the CDN’s contents in every deep
+location (for the best possible bandwidth savings), storing just a relatively
+small amount of the CDN’s most requested content can lead to very high bandwidth
+savings.</p>
+</div>
+<div class="section" id="getting-started">
+<h3>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h3>
+<p>What you need:</p>
+<ol class="arabic simple">
+<li>Edge caches deployed in “deep” locations and registered in Traffic Ops</li>
+<li>A Deep Coverage Zone File (DCZF) mapping these deep cache hostnames to specific network prefixes (see <a class="reference internal" href="traffic_ops/using.html#rl-deep-czf"><span class="std std-ref">The Deep Coverage Zone File</span></a> for details)</li>
+<li>Deep caching parameters in the Traffic Router Profile (see <a class="reference internal" href="traffic_ops/using.html#rl-ccr-profile"><span class="std std-ref">Traffic Router Profile</span></a> for details):<ul>
+<li><code class="docutils literal notranslate"><span class="pre">deepcoveragezone.polling.interval</span></code></li>
+<li><code class="docutils literal notranslate"><span class="pre">deepcoveragezone.polling.url</span></code></li>
+</ul>
+</li>
+<li>Deep Caching enabled on one or more HTTP Delivery Services (i.e. <code class="docutils literal notranslate"><span class="pre">deepCachingType</span></code> = ALWAYS)</li>
+</ol>
+</div>
+<div class="section" id="how-it-works">
+<h3>How it works<a class="headerlink" href="#how-it-works" title="Permalink to this headline">¶</a></h3>
+<p>Deep Coverage Zone routing is very similar to that of regular Coverage Zone
+routing, except that the DCZF is preferred over the regular CZF for Delivery
+Services with DC (Deep Caching) enabled. If the client requests a DC-enabled
+Delivery Service and their IP address gets a “hit” in the DCZF, Traffic Router
+will attempt to route that client to one of the available deep caches in the
+client’s corresponding zone. If there are no deep caches available for a
+client’s request, Traffic Router will “fall back” to the regular CZF and
+continue regular CZF routing from there.</p>
+</div>
+</div>
<div class="section" id="steering-feature">
<span id="rl-tr-steering"></span><h2><a class="toc-backref" href="#contents">Steering feature</a><a class="headerlink" href="#steering-feature" title="Permalink to this headline">¶</a></h2>
-<div class="section" id="id2">
-<h3>Overview<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
-<p>A Steering delivery service is a delivery service that is used to “steer” traffic to other delivery services. A Steering delivery service will have target delivery services configured for it with weights assigned to them. Traffic Router uses the weights to make a consistent hash ring which it then uses to make sure that requests are routed to a target based on the configured weights. This consistent hash ring is separate from the consistent hash ring used in cache selection.</p>
-<p>Special regular expressions called Filters can also be configured for target delivery services to pin traffic to a specific delivery service. For example, if a filter called .*/news/.* for a target called target-ds-1 is created, any requests to traffic router with ‘news’ in them will be routed to target-ds-1. This will happen regardless of the configured weights.</p>
+<div class="section" id="id3">
+<h3>Overview<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
+<p>A Steering delivery service is a delivery service that is used to “steer” traffic to other delivery services. A Steering delivery service will have target delivery services configured for it with weights assigned to them. Traffic Router uses the weights to make a consistent hash ring which it then uses to make sure that requests are routed to a target based on the configured weights. This consistent hash ring is separate from the consistent hash ring used in cache selection.</p>
+<p>Special regular expressions called Filters can also be configured for target delivery services to pin traffic to a specific delivery service. For example, if a filter called .*/news/.* for a target called target-ds-1 is created, any requests to traffic router with ‘news’ in them will be routed to target-ds-1. This will happen regardless of the configured weights.</p>
<p>A client can bypass the steering functionality by providing a header called X-TC-Steering-Option with the xml_id of the target delivery service to route to. When Traffic Router receives this header it will route to the requested target delivery service regardless of weight configuration.</p>
-<p>Some other points of interest:
-- Steering is currently only available for HTTP delivery services that are a part of the same CDN.
-- A new role called STEERING has been added to the traffic ops database. Only users with Admin or Steering privileges can modify steering assignments for a Delivery Service.
-- A new API has been created in Traffic Ops under /internal. This API is used by a Steering user to add filters and modify assignments. (Filters can only be added via the API).
-- Traffic Router uses the steering API in Traffic Ops to poll for steering assignments, the assignments are then used when routing traffic.</p>
+<p>Some other points of interest:</p>
+<ul class="simple">
+<li>Steering is currently only available for HTTP delivery services that are a part of the same CDN.</li>
+<li>A new role called STEERING has been added to the traffic ops database. Only users with Admin or Steering privileges can modify steering assignments for a Delivery Service.</li>
+<li>A new API has been created in Traffic Ops under /internal. This API is used by a Steering user to add filters and modify assignments. (Filters can only be added via the API).</li>
+<li>Traffic Router uses the steering API in Traffic Ops to poll for steering assignments, the assignments are then used when routing traffic.</li>
+</ul>
<p>A couple simple use cases for steering are:</p>
<ol class="arabic simple">
<li>Migrating traffic from one delivery service to another over time.</li>
@@ -738,8 +828,8 @@
<li>Load balancing between delivery services.</li>
</ol>
</div>
-<div class="section" id="id3">
-<h3>Configuration<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="id4">
+<h3>Configuration<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<p>The following needs to be completed for Steering to work correctly:</p>
<ol class="arabic simple">
<li>Two target delivery services are created in Traffic Ops. They must both be HTTP delivery services part of the same CDN.</li>
@@ -764,8 +854,8 @@
</div>
<p>The summary for setting up https is to:</p>
<ol class="arabic simple">
-<li>Select one of ‘https’, ‘http and https’, or ‘http to https’ for the delivery service</li>
-<li>Generate private keys for the delivery service using a wildcard domain such as <code class="docutils literal"><span class="pre">*.my-delivery-service.my-cdn.example.com</span></code></li>
+<li>Select one of ‘https’, ‘http and https’, or ‘http to https’ for the delivery service</li>
+<li>Generate private keys for the delivery service using a wildcard domain such as <code class="docutils literal notranslate"><span class="pre">*.my-delivery-service.my-cdn.example.com</span></code></li>
<li>Obtain and import signed certificate chain</li>
<li>Snapshot CR Config</li>
</ol>
@@ -778,7 +868,7 @@
<dt><em>http and https</em></dt>
<dd>Traffic Router will redirect both secure and non-secure clients</dd>
<dt><em>http to https</em></dt>
-<dd>Traffic Router will redirect non-secure clients with a 302 and a location that is secure (i.e. starting with ‘https’ instead of ‘http’), secure clients will remain on https</dd>
+<dd>Traffic Router will redirect non-secure clients with a 302 and a location that is secure (i.e. starting with ‘https’ instead of ‘http’), secure clients will remain on https</dd>
<dt><em>http</em></dt>
<dd>Any secure client will get an SSL handshake error. Non-secure clients will experience the same behavior as prior to 1.7</dd>
</dl>
@@ -798,7 +888,7 @@
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">To adjust the frequency when Traffic Router fetches certificates add the parameter ‘certificates.polling.interval’ to CR Config and
+<p class="last">To adjust the frequency when Traffic Router fetches certificates add the parameter ‘certificates.polling.interval’ to CR Config and
setting it to the desired time in milliseconds.</p>
</div>
<div class="admonition note">
@@ -810,14 +900,14 @@
<p class="last">If a snapshot of CR Config is made that involves a delivery service missing its certificates, Traffic Router will ignore <strong>ALL</strong> changes in that CR-Config
until one of the following occurs:
* It receives certificates for that delivery service
-* Another snapshot of CR Config is created and the delivery service without certificates is changed so it’s HTTP protocol is set to ‘http’</p>
+* Another snapshot of CR Config is created and the delivery service without certificates is changed so it’s HTTP protocol is set to ‘http’</p>
</div>
</div>
<div class="section" id="certificate-chain-ordering">
<h3>Certificate Chain Ordering<a class="headerlink" href="#certificate-chain-ordering" title="Permalink to this headline">¶</a></h3>
<p>The ordering of certificates within the certificate bundle matters. It must be:</p>
<ol class="arabic simple">
-<li>Primary Certificate (e.g. the one created for <code class="docutils literal"><span class="pre">*.my-delivery-service.my-cdn.example.com</span></code>)</li>
+<li>Primary Certificate (e.g. the one created for <code class="docutils literal notranslate"><span class="pre">*.my-delivery-service.my-cdn.example.com</span></code>)</li>
<li>Intermediate Certificate(s)</li>
<li>Root Certificate from CA (optional)</li>
</ol>
@@ -832,20 +922,20 @@
<h3>Suggested Way of Setting up an HTTPS Delivery Service<a class="headerlink" href="#suggested-way-of-setting-up-an-https-delivery-service" title="Permalink to this headline">¶</a></h3>
<p>Do the following in Traffic Ops:</p>
<ol class="arabic simple">
-<li>Select one of ‘https’, ‘http and https’, or ‘http to https’ for the protocol field of a delivery service and click ‘Save’.</li>
-<li>Click ‘Manage SSL Keys’.</li>
-<li>Click ‘Generate New Keys’.</li>
+<li>Select one of ‘https’, ‘http and https’, or ‘http to https’ for the protocol field of a delivery service and click ‘Save’.</li>
+<li>Click ‘Manage SSL Keys’.</li>
+<li>Click ‘Generate New Keys’.</li>
<li>Copy the contents of the Certificate Signing Request field and save it locally.</li>
-<li>Click ‘Load Keys’.</li>
-<li>Select ‘http’ for the protocol field of the delivery service and click ‘Save’ (to avoid preventing other CR Config updates from being blocked by Traffic Router)</li>
+<li>Click ‘Load Keys’.</li>
+<li>Select ‘http’ for the protocol field of the delivery service and click ‘Save’ (to avoid preventing other CR Config updates from being blocked by Traffic Router)</li>
<li>Follow your standard procedure for obtaining your signed certificate chain from a CA.</li>
<li>After receiving your certificate chain import it into Traffic Ops.</li>
<li>Edit the delivery service.</li>
<li>Restore your original choice for the protocol field and click save.</li>
-<li>Click ‘Manage SSL Keys’.</li>
-<li>Click ‘Paste Existing Keys’.</li>
+<li>Click ‘Manage SSL Keys’.</li>
+<li>Click ‘Paste Existing Keys’.</li>
<li>Paste the certificate chain into the CRT field.</li>
-<li>Click ‘Load Keys’.</li>
+<li>Click ‘Load Keys’.</li>
<li>Take a new snapshot of CR Config.</li>
</ol>
<p>Once this is done you should be able to test you are getting correctly redirected by Traffic Router using curl commands to https destinations on your delivery service.</p>
@@ -860,11 +950,11 @@
<p>The following is an example of /opt/tomcat/bin/setenv.sh that has been tested on a multi core server running under HTTPS load test requests.
This is following the general recommendation to use the G1 garbage collector for JVM applications running on multi core machines.
In addition to using the G1 garbage collector the InitiatingHeapOccupancyPercent was lowered to run garbage collection more frequently which
-improved overall throughput for Traffic Router and reduced ‘Stop the World’ garbage collection. Note that setting the min and max heap settings
+improved overall throughput for Traffic Router and reduced ‘Stop the World’ garbage collection. Note that setting the min and max heap settings
in setenv.sh will override init scripts in /etc/init.d/tomcat.</p>
<blockquote>
<div><p>/opt/tomcat/bin/setenv.sh:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="ch">#! /bin/sh</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#! /bin/sh</span>
<span class="n">export</span> <span class="n">CATALINA_OPTS</span><span class="o">=</span><span class="s2">"$CATALINA_OPTS -server"</span>
<span class="n">export</span> <span class="n">CATALINA_OPTS</span><span class="o">=</span><span class="s2">"$CATALINA_OPTS -Xms2g -Xmx2g"</span>
<span class="n">export</span> <span class="n">CATALINA_OPTS</span><span class="o">=</span><span class="s2">"$CATALINA_OPTS -XX:+UseG1GC"</span>
@@ -909,16 +999,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_server.html b/docs/latest/admin/traffic_server.html
index 02342ef..9810440 100644
--- a/docs/latest/admin/traffic_server.html
+++ b/docs/latest/admin/traffic_server.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Server Administration — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Server Administration — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Vault Administration" href="traffic_vault.html"/>
<link rel="prev" title="Traffic Stats Administration" href="traffic_stats.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Administrator’s Guide</a> »</li>
+ <li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Server Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_server.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_server.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -194,54 +208,54 @@
<div class="section" id="installing-traffic-server">
<h2>Installing Traffic Server<a class="headerlink" href="#installing-traffic-server" title="Permalink to this headline">¶</a></h2>
<ol class="arabic">
-<li><p class="first">Get the Traffic Server RPM and the astats RPM.</p>
-<p>Sample command:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">wget</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">traffic</span><span class="o">-</span><span class="n">control</span><span class="o">-</span><span class="n">cdn</span><span class="o">.</span><span class="n">net</span><span class="o">/</span><span class="n">downloads</span><span class="o">/</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">0</span><span class="o">/</span><span class="n">RELEASE</span><span class="o">-</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">0</span><span class="o">/</span><span class="n">trafficserver</span><span class="o">-</span><span class="mf">5.3</span><span class="o">.</span><span class="mi">2</span><span class="o">-</span><span class="mf">759.</span><span class="n">ee14bbe</span><span class="o">.</span><span class="n">el6</span><span class="o">.</span><span class="n">x86_64</span><span class="o">.</span><span class="n">rpm</span>
-<span class="n">wget</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">traffic</span><span class="o">-</span><span class="n">control</span><span class="o">-</span><span class="n">cdn</span><span class="o">.</span><span class="n">net</span><span class="o">/</span><span class="n">downloads</span><span class="o">/</span><span class="mf">1.6</span><span class="o">.</span><span class="mi">1</span><span class="o">/</span><span class="n">RELEASE</span><span class="o">-</span><span class="mf">1.6</span><span class="o">.</span><span class="mi">1</span><span class="o">/</span><span class="n">astats_over_http</span><span class="o">-</span><span class="mf">1.2</span><span class="o">-</span><span class="mf">8.</span><span class="n">el6</span><span class="o">.</span><span class="n">x86_64</span><span class="o">.</span><span class="n">rpm</span>
+<li><p class="first">Build the Traffic Server RPM. The best way to do this is to follow the Traffic Server documents:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">docs</span><span class="o">.</span><span class="n">trafficserver</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">en</span><span class="o">/</span><span class="n">latest</span><span class="o">/</span><span class="n">getting</span><span class="o">-</span><span class="n">started</span><span class="o">/</span><span class="n">index</span><span class="o">.</span><span class="n">en</span><span class="o">.</span><span class="n">html</span><span class="c1">#installation</span>
</pre></div>
</div>
-<p>(astats was not released as part of 1.7, so in this examples 1.6.1 was used)</p>
+</li>
+<li><p class="first">Build the astats RPM using the appropriate version number:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">apache</span><span class="o">/</span><span class="n">incubator</span><span class="o">-</span><span class="n">trafficcontrol</span><span class="o">/</span><span class="n">tree</span><span class="o">/<</span><span class="n">version</span><span class="o">>/</span><span class="n">traffic_server</span>
+</pre></div>
+</div>
+<p>Sample link:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">apache</span><span class="o">/</span><span class="n">incubator</span><span class="o">-</span><span class="n">trafficcontrol</span><span class="o">/</span><span class="n">tree</span><span class="o">/</span><span class="n">master</span><span class="o">/</span><span class="n">traffic_server</span>
+</pre></div>
+</div>
</li>
<li><p class="first">Install Traffic Server and astats:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">trafficserver</span><span class="o">-*.</span><span class="n">rpm</span> <span class="n">astats_over_http</span><span class="o">*.</span><span class="n">rpm</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">trafficserver</span><span class="o">-*.</span><span class="n">rpm</span> <span class="n">astats_over_http</span><span class="o">*.</span><span class="n">rpm</span>
</pre></div>
</div>
</li>
<li><p class="first">Add the server using the Traffic Ops web interface:</p>
-<ol class="arabic">
-<li><p class="first">Select <strong>Servers</strong>.</p>
-</li>
-<li><p class="first">Scroll to the bottom of the page and click <strong>Add Server</strong>.</p>
-</li>
+<ol class="arabic simple">
+<li>Select <strong>Servers</strong>.</li>
+<li>Scroll to the bottom of the page and click <strong>Add Server</strong>.</li>
<li><dl class="first docutils">
-<dt>Complete the “Required Info:” section:</dt>
-<dd><ul class="first last simple">
-<li>Set ‘Interface Name’ to the name of the interface from which traffic server delivers content.</li>
-<li>Set ‘Type’ to ‘MID’ or ‘EDGE’.</li>
+<dt>Complete the “Required Info:” section:</dt>
+<dd><ul class="first last">
+<li>Set ‘Interface Name’ to the name of the interface from which traffic server delivers content.</li>
+<li>Set ‘Type’ to ‘MID’ or ‘EDGE’.</li>
</ul>
</dd>
</dl>
</li>
-<li><p class="first">Click <strong>Submit</strong>.</p>
-</li>
-<li><p class="first">Click <strong>Save</strong>.</p>
-</li>
-<li><p class="first">Click <strong>Online Server</strong>.</p>
-</li>
-<li><p class="first">Verify that the server status is now listed as <strong>Reported</strong></p>
-</li>
+<li>Click <strong>Submit</strong>.</li>
+<li>Click <strong>Save</strong>.</li>
+<li>Click <strong>Online Server</strong>.</li>
+<li>Verify that the server status is now listed as <strong>Reported</strong></li>
</ol>
</li>
-<li><p class="first">Install the ORT script and run it in ‘badass’ mode to create the initial configuration, see <a class="reference internal" href="#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a></p>
+<li><p class="first">Install the ORT script and run it in ‘badass’ mode to create the initial configuration, see <a class="reference internal" href="#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a></p>
</li>
-<li><p class="first">Start the service: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">trafficserver</span> <span class="pre">start</span></code></p>
+<li><p class="first">Start the service: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">trafficserver</span> <span class="pre">start</span></code></p>
</li>
-<li><p class="first">Configure traffic server to start automatically: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">chkconfig</span> <span class="pre">trafficserver</span> <span class="pre">on</span></code></p>
+<li><p class="first">Configure traffic server to start automatically: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">systemctl</span> <span class="pre">enable</span> <span class="pre">trafficserver</span></code></p>
</li>
<li><p class="first">Verify that the installation is good:</p>
<ol class="arabic simple">
-<li>Make sure that the service is running: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">trafficserver</span> <span class="pre">status</span></code></li>
-<li>Assuming a traffic monitor is already installed, browse to it, and verify that the traffic server appears in the “Cahce States” table, in white.</li>
+<li>Make sure that the service is running: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">systemctl</span> <span class="pre">status</span> <span class="pre">trafficserver</span></code></li>
+<li>Assuming a traffic monitor is already installed, browse to it, i.e. <a class="reference external" href="http:/">http:/</a>/<trafficmonitorURL>, and verify that the traffic server appears in the “Cache States” table, in white.</li>
</ol>
</li>
</ol>
@@ -250,14 +264,14 @@
<span id="reference-traffic-ops-ort"></span><h2>Configuring Traffic Server<a class="headerlink" href="#configuring-traffic-server" title="Permalink to this headline">¶</a></h2>
<p>All of the Traffic Server application configuration files are generated by Traffic Ops and installed by way of the traffic_ops_ort.pl script.
The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do the initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ sudo /opt/ort/traffic_ops_ort.pl
-Thu May 26 15:52:11 UTC 2016
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo /opt/ort/traffic_ops_ort.pl
====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
Usage: ./traffic_ops_ort.pl <Mode> <Log_Level> <Traffic_Ops_URL> <Traffic_Ops_Login> [optional flags]
<Mode> = interactive - asks questions during config process.
<Mode> = report - prints config differences and exits.
<Mode> = badass - attempts to fix all config differences that it can.
<Mode> = syncds - syncs delivery services with what is configured in Traffic Ops.
+ <Mode> = revalidate - checks for updated revalidations in Traffic Ops and applies them. Requires Traffic Ops 2.1.
<Log_Level> => ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, NONE
@@ -267,6 +281,7 @@
[optional flags]:
dispersion=<time> => wait a random number between 0 and <time> before starting. Default = 300.
+ login_dispersion=<time> => wait a random number between 0 and <time> before login. Default = 0.
retries=<number> => retry connection to Traffic Ops URL <number> times. Default = 3.
wait_for_parents=<0|1> => do not update if parent_pending = 1 in the update json. Default = 1, wait for parents.
====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
@@ -276,48 +291,51 @@
<div class="section" id="installing-the-ort-script">
<h3>Installing the ORT script<a class="headerlink" href="#installing-the-ort-script" title="Permalink to this headline">¶</a></h3>
<ol class="arabic">
-<li><p class="first">The ORT script is not a part of the traffic server distribution. In this sample session, we get it manually from github:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">mkdir</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span>
-<span class="n">sudo</span> <span class="n">wget</span> <span class="o">-</span><span class="n">P</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">raw</span><span class="o">.</span><span class="n">githubusercontent</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">apache</span><span class="o">/</span><span class="n">incubator</span><span class="o">-</span><span class="n">trafficcontrol</span><span class="o">/</span><span class="mf">1.7</span><span class="o">.</span><span class="n">x</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span>
-<span class="n">sudo</span> <span class="n">chmod</span> <span class="o">+</span><span class="n">x</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span>
+<li><p class="first">Build the ORT script RPM from the Apache Build Server and install it:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">builds</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">view</span><span class="o">/</span><span class="n">S</span><span class="o">-</span><span class="n">Z</span><span class="o">/</span><span class="n">view</span><span class="o">/</span><span class="n">TrafficControl</span><span class="o">/</span>
+</pre></div>
+</div>
+<p>Sample command:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">wget</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">builds</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">view</span><span class="o">/</span><span class="n">S</span><span class="o">-</span><span class="n">Z</span><span class="o">/</span><span class="n">view</span><span class="o">/</span><span class="n">TrafficControl</span><span class="o">/</span><span class="n">job</span><span class="o">/</span><span class="n">incubator</span><span class="o">-</span><span class="n">trafficcontrol</span><span class="o">-</span><span class="mf">2.1</span><span class="o">.</span><span class="n">x</span><span class="o">-</span><span class="n">build</span><span class="o">/</span><span class="n">lastSuccessfulBuild</span><span class="o">/</span><span class="n">artifact</span><span class="o">/</span><span class="n">dist</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">-</span><span class="mf">2.1</span><span class="o">.</span><span class="mi">0</span><span class="o">-</span><span class="mf">6807.1</span><span class="n">dcd512f</span><span class="o">.</span><span class="n">el7</span><span class="o">.</span><span class="n">x86_64</span><span class="o">.</span><span class="n">rpm</span>
+<span class="n">sudo</span> <span class="n">yum</span> <span class="n">install</span> <span class="n">traffic_ops_ort</span><span class="o">*.</span><span class="n">rpm</span>
</pre></div>
</div>
</li>
-<li><p class="first">Install modules required by ORT: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">-y</span> <span class="pre">install</span> <span class="pre">perl-JSON</span> <span class="pre">perl-Crypt-SSLeay</span></code></p>
+<li><p class="first">Install modules required by ORT if needed: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">-y</span> <span class="pre">install</span> <span class="pre">perl-JSON</span> <span class="pre">perl-Crypt-SSLeay</span></code></p>
</li>
-<li><p class="first">For initial configuration or when major changes (like a Profile change) need to be made, run the script in “badass mode”. All required rpm packages
+<li><p class="first">For initial configuration or when major changes (like a Profile change) need to be made, run the script in “badass mode”. All required rpm packages
will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted.</p>
<p>Example run below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ sudo /opt/ort/traffic_ops_ort.pl --dispersion=0 badass warn https://ops.$tcDomain admin:admin123
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo /opt/ort/traffic_ops_ort.pl --dispersion=0 badass warn https://ops.$tcDomain admin:admin123
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">First run gives a lot of state errors that are expected. The “badass” mode fixes these issue s. Run it a second time, this should be cleaner.
+<p class="last">First run gives a lot of state errors that are expected. The “badass” mode fixes these issue s. Run it a second time, this should be cleaner.
Also, note that many ERROR messages emitted by ORT are actually information messages. Do not panic.</p>
</div>
</li>
-<li><p class="first">Create a cron entry for running ort in ‘syncds’ mode every 15 minutes.
-This makes traffic control check periodically if ‘Queue Updates’ was run on Traffic Ops, and it so, get the updated configuration.</p>
-<p>Run <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">crontab</span> <span class="pre">-e</span></code> and add the following line</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> <span class="n">syncds</span> <span class="n">warn</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">traffops</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="n">admin</span><span class="p">:</span><span class="n">password</span> <span class="o">--</span><span class="n">login_dispersion</span><span class="o">=</span><span class="mi">30</span> <span class="o">--</span><span class="n">dispersion</span><span class="o">=</span><span class="mi">180</span> <span class="o">></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">syncds</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<li><p class="first">Create a cron entry for running ort in ‘syncds’ mode every 15 minutes.
+This makes traffic control check periodically if ‘Queue Updates’ was run on Traffic Ops, and it so, get the updated configuration.</p>
+<p>Run <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">crontab</span> <span class="pre">-e</span></code> and add the following line</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> <span class="n">syncds</span> <span class="n">warn</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">traffops</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="n">admin</span><span class="p">:</span><span class="n">password</span> <span class="o">--</span><span class="n">login_dispersion</span><span class="o">=</span><span class="mi">30</span> <span class="o">--</span><span class="n">dispersion</span><span class="o">=</span><span class="mi">180</span> <span class="o">></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">syncds</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
</pre></div>
</div>
-<p>Changing <code class="docutils literal"><span class="pre">https://traffops.kabletown.net</span></code>, <code class="docutils literal"><span class="pre">admin</span></code>, and <code class="docutils literal"><span class="pre">password</span></code> to your CDN URL and credentials.</p>
+<p>Changing <code class="docutils literal notranslate"><span class="pre">https://traffops.kabletown.net</span></code>, <code class="docutils literal notranslate"><span class="pre">admin</span></code>, and <code class="docutils literal notranslate"><span class="pre">password</span></code> to your CDN URL and credentials.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">By default, running ort on an edge traffic server waits for it’s parent (mid) servers to download their configuration before
-it downloads it’s own configuration. Because of this, scheduling ort for running every 15 minutes (with 5 minutes default dispersion) means
-that it might take up to ~35 minutes for a “Queue Updates” operation to affect all traffic servers. To customize this dispersion time, use
-the command line option –dispersion=x where x is the number of seconds for the dispersion period. Servers will select a random number from
-within this dispersion period to being pulling down configuration files from Traffic Ops. Another option, –login_dispersion=x can be used.
+<p class="last">By default, running ort on an edge traffic server waits for it’s parent (mid) servers to download their configuration before
+it downloads it’s own configuration. Because of this, scheduling ort for running every 15 minutes (with 5 minutes default dispersion) means
+that it might take up to ~35 minutes for a “Queue Updates” operation to affect all traffic servers. To customize this dispersion time, use
+the command line option –dispersion=x where x is the number of seconds for the dispersion period. Servers will select a random number from
+within this dispersion period to being pulling down configuration files from Traffic Ops. Another option, –login_dispersion=x can be used.
This option creates a dispersion period after the job begins during which ORT will wait before logging in and checking Traffic Ops for updates
to the server. This defaults to 0. If use_reval_pending, a.k.a. Rapid Revalidate is enabled, edges will NOT wait for their parents to download
their configuration before downloading their own.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p>In ‘syncds’ mode, the ort script updates only configurations that might be changed as part of normal operations, such as:</p>
+<p>In ‘syncds’ mode, the ort script updates only configurations that might be changed as part of normal operations, such as:</p>
<ul class="last simple">
<li>Delivery Services</li>
<li>SSL certificates</li>
@@ -329,8 +347,8 @@
</li>
<li><p class="first">If Rapid Revalidate is enabled in Traffic Ops, create a second cron job for revalidation checks. ORT will not check revalidation files if Rapid Revalidate
is enabled. This setting allows for a separate check to be performed every 60 seconds to verify if a revalidation update has been made.</p>
-<p>Run <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">crontab</span> <span class="pre">-e</span></code> and add the following line</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">*/</span><span class="mi">1</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> <span class="n">revalidate</span> <span class="n">warn</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">traffops</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="n">admin</span><span class="p">:</span><span class="n">password</span> <span class="o">--</span><span class="n">login_dispersion</span><span class="o">=</span><span class="mi">30</span> <span class="o">></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">syncds</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<p>Run <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">crontab</span> <span class="pre">-e</span></code> and add the following line</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">*/</span><span class="mi">1</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> <span class="n">revalidate</span> <span class="n">warn</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">traffops</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="n">admin</span><span class="p">:</span><span class="n">password</span> <span class="o">--</span><span class="n">login_dispersion</span><span class="o">=</span><span class="mi">30</span> <span class="o">></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">syncds</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
</pre></div>
</div>
</li>
@@ -372,16 +390,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_stats.html b/docs/latest/admin/traffic_stats.html
index 23a289a..da17dd9 100644
--- a/docs/latest/admin/traffic_stats.html
+++ b/docs/latest/admin/traffic_stats.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Stats Administration — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Stats Administration — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Server Administration" href="traffic_server.html"/>
<link rel="prev" title="Traffic Router Administration" href="traffic_router.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Administrator’s Guide</a> »</li>
+ <li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Stats Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_stats.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_stats.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -197,10 +211,10 @@
<p><strong>Installing Traffic Stats:</strong></p>
<blockquote>
<div><ul class="simple">
-<li>See the <a class="reference external" href="https://trafficcontrol.apache.org/downloads/index.html">downloads</a> page for Traffic Control to get the lastest release.</li>
+<li>See the <a class="reference external" href="https://trafficcontrol.apache.org/downloads/index.html">downloads</a> page for Traffic Control to get the latest release.</li>
<li>Follow our build <a class="reference external" href="https://github.com/apache/incubator-trafficcontrol/tree/master/build">intructions</a> to generate an RPM.</li>
<li>Copy the RPM to your server</li>
-<li>perform the following command: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">rpm</span> <span class="pre">-ivh</span> <span class="pre"><traffic_stats</span> <span class="pre">rpm></span></code></li>
+<li>perform the following command: <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">rpm</span> <span class="pre">-ivh</span> <span class="pre"><traffic_stats</span> <span class="pre">rpm></span></code></li>
</ul>
</div></blockquote>
<p><strong>Installing InfluxDB:</strong></p>
@@ -216,7 +230,7 @@
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<p><strong>Configuring Traffic Stats:</strong></p>
<blockquote>
-<div><p>Traffic Stats’ configuration file can be found in /opt/traffic_stats/conf/traffic_stats.cfg.
+<div><p>Traffic Stats’ configuration file can be found in /opt/traffic_stats/conf/traffic_stats.cfg.
The following values need to be configured:</p>
<blockquote>
<div><ul class="simple">
@@ -253,27 +267,27 @@
</li>
<li><p class="first">Enter the necessary information to configure your data source</p>
</li>
-<li><p class="first">Click on the ‘Home’ dropdown at the top of the screen and choose New at the bottom</p>
+<li><p class="first">Click on the ‘Home’ dropdown at the top of the screen and choose New at the bottom</p>
</li>
<li><p class="first">Click on the green menu bar (with 3 lines) at the top and choose Add Panel -> Graph</p>
</li>
-<li><p class="first">Where it says ‘No Title (click here)’ click and choose edit</p>
+<li><p class="first">Where it says ‘No Title (click here)’ click and choose edit</p>
</li>
<li><p class="first">Choose your data source at the bottom</p>
</li>
<li><p class="first">You can have grafana help you create a query, or you can create your own. Here is a sample query:</p>
<blockquote>
-<div><p><code class="docutils literal"><span class="pre">SELECT</span> <span class="pre">sum(value)*1000</span> <span class="pre">FROM</span> <span class="pre">"monthly"."bandwidth.cdn.1min"</span> <span class="pre">WHERE</span> <span class="pre">$timeFilter</span> <span class="pre">GROUP</span> <span class="pre">BY</span> <span class="pre">time(60s),</span> <span class="pre">cdn</span></code></p>
+<div><p><code class="docutils literal notranslate"><span class="pre">SELECT</span> <span class="pre">sum(value)*1000</span> <span class="pre">FROM</span> <span class="pre">"monthly"."bandwidth.cdn.1min"</span> <span class="pre">WHERE</span> <span class="pre">$timeFilter</span> <span class="pre">GROUP</span> <span class="pre">BY</span> <span class="pre">time(60s),</span> <span class="pre">cdn</span></code></p>
</div></blockquote>
</li>
-<li><p class="first">Once you have the graph the way you want it, click the ‘Save Dashboard’ button at the top</p>
+<li><p class="first">Once you have the graph the way you want it, click the ‘Save Dashboard’ button at the top</p>
</li>
<li><p class="first">You should now have a new saved graph</p>
</li>
</ul>
</div></blockquote>
<p>In order for Traffic Ops users to see Grafana graphs, Grafana will need to allow anonymous access. Information on how to configure anonymous access can be found on the configuration page of the <a class="reference external" href="http://docs.grafana.org/installation/configuration/#authanonymous">Grafana Website</a>.</p>
-<p>Traffic Ops uses custom dashboards to display information about individual delivery services or cache groups. In order for the custom graphs to display correctly, the <a class="reference external" href="https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_stats/grafana/">traffic_ops_*.js</a> files need to be in the <code class="docutils literal"><span class="pre">/usr/share/grafana/public/dashboards/</span></code> directory on the grafana server. If your Grafana server is the same as your Traffic Stats server the RPM install process will take care of putting the files in place. If your grafana server is different from your Traffic Stats server, you will need to manually copy the files to the correct directory.</p>
+<p>Traffic Ops uses custom dashboards to display information about individual delivery services or cache groups. In order for the custom graphs to display correctly, the <a class="reference external" href="https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_stats/grafana/">traffic_ops_*.js</a> files need to be in the <code class="docutils literal notranslate"><span class="pre">/usr/share/grafana/public/dashboards/</span></code> directory on the grafana server. If your Grafana server is the same as your Traffic Stats server the RPM install process will take care of putting the files in place. If your grafana server is different from your Traffic Stats server, you will need to manually copy the files to the correct directory.</p>
<p>More information on custom scripted graphs can be found in the <a class="reference external" href="http://docs.grafana.org/reference/scripting/">scripted dashboards</a> section of the Grafana documentation.</p>
</div></blockquote>
<p><strong>Configuring Traffic Ops for Traffic Stats:</strong></p>
@@ -286,7 +300,7 @@
</div></blockquote>
<p><strong>Configuring Traffic Ops to use Grafana Dashboards</strong></p>
<blockquote>
-<div><p>To configure Traffic Ops to use Grafana Dashboards, you need to enter the following parameters and assign them to the GLOBAL profile. This assumes you followed the above instructions to install and configure InfluxDB and Grafana. You will need to place ‘cdn-stats’,’deliveryservice-stats’, and ‘daily-summary’ with the name of your dashboards.</p>
+<div><p>To configure Traffic Ops to use Grafana Dashboards, you need to enter the following parameters and assign them to the GLOBAL profile. This assumes you followed the above instructions to install and configure InfluxDB and Grafana. You will need to place ‘cdn-stats’,’deliveryservice-stats’, and ‘daily-summary’ with the name of your dashboards.</p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
@@ -343,19 +357,16 @@
</div></blockquote>
<p>Using create_ts_databases.go</p>
<blockquote class="last">
-<div><ol class="arabic">
-<li><p class="first">go to the traffic_stats/influxdb_tools/create directory</p>
-</li>
-<li><p class="first">build it by running <code class="docutils literal"><span class="pre">go</span> <span class="pre">build</span> <span class="pre">create_ts_databases.go</span></code> or simply <code class="docutils literal"><span class="pre">go</span> <span class="pre">build</span></code></p>
-</li>
+<div><ol class="arabic simple">
+<li>go to the traffic_stats/influxdb_tools/create directory</li>
+<li>build it by running <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">build</span> <span class="pre">create_ts_databases.go</span></code> or simply <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">build</span></code></li>
<li><dl class="first docutils">
<dt>Run it:</dt>
<dd><ul class="first last">
-<li><p class="first"><code class="docutils literal"><span class="pre">./create_ts_databases</span> <span class="pre">-help</span></code> or <code class="docutils literal"><span class="pre">./create</span> <span class="pre">-help</span></code></p>
-</li>
+<li><code class="docutils literal notranslate"><span class="pre">./create_ts_databases</span> <span class="pre">-help</span></code> or <code class="docutils literal notranslate"><span class="pre">./create</span> <span class="pre">-help</span></code></li>
<li><dl class="first docutils">
<dt>optional flags:</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li>url - The influxdb url and port</li>
<li>replication - The number of nodes in the cluster</li>
<li>user - The user to use</li>
@@ -364,8 +375,7 @@
</dd>
</dl>
</li>
-<li><p class="first">example: <code class="docutils literal"><span class="pre">./create_ts_databases</span> <span class="pre">-url=localhost:8086</span> <span class="pre">-replication=3</span> <span class="pre">-user=joe</span> <span class="pre">-password=mysecret</span></code> or <code class="docutils literal"><span class="pre">./create</span> <span class="pre">-url=localhost:8086</span> <span class="pre">-replication=3</span> <span class="pre">-user=joe</span> <span class="pre">-password=mysecret</span></code></p>
-</li>
+<li>example: <code class="docutils literal notranslate"><span class="pre">./create_ts_databases</span> <span class="pre">-url=localhost:8086</span> <span class="pre">-replication=3</span> <span class="pre">-user=joe</span> <span class="pre">-password=mysecret</span></code> or <code class="docutils literal notranslate"><span class="pre">./create</span> <span class="pre">-url=localhost:8086</span> <span class="pre">-replication=3</span> <span class="pre">-user=joe</span> <span class="pre">-password=mysecret</span></code></li>
</ul>
</dd>
</dl>
@@ -388,16 +398,15 @@
<div><ol class="arabic">
<li><p class="first">go to the traffic_stats/influxdb_tools/create directory</p>
</li>
-<li><p class="first">build it by running <code class="docutils literal"><span class="pre">go</span> <span class="pre">build</span> <span class="pre">sync_ts_databases.go</span></code> or simply <code class="docutils literal"><span class="pre">go</span> <span class="pre">build</span></code></p>
+<li><p class="first">build it by running <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">build</span> <span class="pre">sync_ts_databases.go</span></code> or simply <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">build</span></code></p>
</li>
<li><dl class="first docutils">
<dt>Run it</dt>
-<dd><ul class="first">
-<li><p class="first"><code class="docutils literal"><span class="pre">./sync_ts_databases</span> <span class="pre">-help</span></code> or <code class="docutils literal"><span class="pre">./sync</span> <span class="pre">-help</span></code></p>
-</li>
+<dd><ul class="first simple">
+<li><code class="docutils literal notranslate"><span class="pre">./sync_ts_databases</span> <span class="pre">-help</span></code> or <code class="docutils literal notranslate"><span class="pre">./sync</span> <span class="pre">-help</span></code></li>
<li><dl class="first docutils">
<dt>required flags:</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li>source-url - The URL of the source database</li>
<li>target-url - The URL of the target database</li>
</ul>
@@ -463,16 +472,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/admin/traffic_vault.html b/docs/latest/admin/traffic_vault.html
index 6bcd894..09f5fa4 100644
--- a/docs/latest/admin/traffic_vault.html
+++ b/docs/latest/admin/traffic_vault.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Vault Administration — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Vault Administration — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Quick How To Guides" href="quick_howto/index.html"/>
<link rel="prev" title="Traffic Server Administration" href="traffic_server.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Administrator’s Guide</a> »</li>
+ <li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Vault Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_vault.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_vault.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -204,14 +218,12 @@
<div class="section" id="riak-configuration-file-configuration">
<h3>Riak configuration file configuration<a class="headerlink" href="#riak-configuration-file-configuration" title="Permalink to this headline">¶</a></h3>
<p>The following steps need to be performed on each Riak server in the cluster:</p>
-<ul>
-<li><p class="first">Log into riak server as root</p>
-</li>
-<li><p class="first">cd to /etc/riak/</p>
-</li>
+<ul class="simple">
+<li>Log into riak server as root</li>
+<li>cd to /etc/riak/</li>
<li><dl class="first docutils">
<dt>Update the following in riak.conf to reflect your IP:</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li>nodename = <a class="reference external" href="mailto:riak%40a-host.sys.kabletown.net">riak<span>@</span>a-host<span>.</span>sys<span>.</span>kabletown<span>.</span>net</a></li>
<li>listener.http.internal = a-host.sys.kabletown.net:8098 (can be 80 - This endpoint will not work with sec enabled)</li>
<li>listener.protobuf.internal = a-host.sys.kabletown.net:8087 (can be different port if you want)</li>
@@ -222,7 +234,7 @@
</li>
<li><dl class="first docutils">
<dt>Updated the following conf file to point to your cert files</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li>ssl.certfile = /etc/riak/certs/server.crt</li>
<li>ssl.keyfile = /etc/riak/certs/server.key</li>
<li>ssl.cacertfile = /etc/pki/tls/certs/ca-bundle.crt</li>
@@ -232,7 +244,7 @@
</li>
<li><dl class="first docutils">
<dt>Add a line at the bottom of the config for tlsv1</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li>tls_protocols.tlsv1 = on</li>
</ul>
</dd>
@@ -240,15 +252,15 @@
</li>
<li><dl class="first docutils">
<dt>Once the config file has been updated restart riak</dt>
-<dd><ul class="first last simple">
-<li><code class="docutils literal"><span class="pre">/etc/init.d/riak</span> <span class="pre">restart</span></code></li>
+<dd><ul class="first last">
+<li><code class="docutils literal notranslate"><span class="pre">/etc/init.d/riak</span> <span class="pre">restart</span></code></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Validate server is running by going to the following URL:</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li><a class="reference external" href="https:/">https:/</a>/<serverHostname>:8088/ping</li>
</ul>
</dd>
@@ -279,13 +291,13 @@
<div><ol class="arabic">
<li><p class="first">Enable security</p>
<blockquote>
-<div><p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">enable</span></code></p>
+<div><p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">enable</span></code></p>
</div></blockquote>
</li>
<li><p class="first">Add groups</p>
<blockquote>
-<div><p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-group</span> <span class="pre">admins</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-group</span> <span class="pre">keysusers</span></code></p>
+<div><p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-group</span> <span class="pre">admins</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-group</span> <span class="pre">keysusers</span></code></p>
</div></blockquote>
</li>
<li><p class="first">Add users</p>
@@ -297,27 +309,28 @@
<p class="last">username and password should be stored in /opt/traffic_ops/app/conf/<environment>/riak.conf</p>
</div>
<blockquote>
-<div><p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-user</span> <span class="pre">admin</span> <span class="pre">password=<AdminPassword></span> <span class="pre">groups=admins</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-user</span> <span class="pre">riakuser</span> <span class="pre">password=<RiakUserPassword></span> <span class="pre">groups=keysusers</span></code></p>
+<div><p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-user</span> <span class="pre">admin</span> <span class="pre">password=<AdminPassword></span> <span class="pre">groups=admins</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-user</span> <span class="pre">riakuser</span> <span class="pre">password=<RiakUserPassword></span> <span class="pre">groups=keysusers</span></code></p>
</div></blockquote>
</div></blockquote>
<ol class="arabic" start="4">
<li><p class="first">Grant access for admin and riakuser</p>
<blockquote>
-<div><p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-source</span> <span class="pre">riakuser</span> <span class="pre">0.0.0.0/0</span> <span class="pre">password</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-source</span> <span class="pre">admin</span> <span class="pre">0.0.0.0/0</span> <span class="pre">password</span></code></p>
+<div><p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-source</span> <span class="pre">riakuser</span> <span class="pre">0.0.0.0/0</span> <span class="pre">password</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">add-source</span> <span class="pre">admin</span> <span class="pre">0.0.0.0/0</span> <span class="pre">password</span></code></p>
</div></blockquote>
</li>
<li><p class="first">Grant privs to admins for everything</p>
<blockquote>
-<div><p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_kv.list_buckets,riak_kv.list_keys,riak_kv.get,riak_kv.put,riak_kv.delete</span> <span class="pre">on</span> <span class="pre">any</span> <span class="pre">to</span> <span class="pre">admins</span></code></p>
+<div><p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_kv.list_buckets,riak_kv.list_keys,riak_kv.get,riak_kv.put,riak_kv.delete</span> <span class="pre">on</span> <span class="pre">any</span> <span class="pre">to</span> <span class="pre">admins</span></code></p>
</div></blockquote>
</li>
<li><p class="first">Grant privs to keysuser for ssl, dnssec, and url_sig_keys buckets only</p>
<blockquote>
-<div><p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_kv.get,riak_kv.put,riak_kv.delete</span> <span class="pre">on</span> <span class="pre">default</span> <span class="pre">ssl</span> <span class="pre">to</span> <span class="pre">keysusers</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_kv.get,riak_kv.put,riak_kv.delete</span> <span class="pre">on</span> <span class="pre">default</span> <span class="pre">dnssec</span> <span class="pre">to</span> <span class="pre">keysusers</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_kv.get,riak_kv.put,riak_kv.delete</span> <span class="pre">on</span> <span class="pre">default</span> <span class="pre">url_sig_keys</span> <span class="pre">to</span> <span class="pre">keysusers</span></code></p>
+<div><p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_kv.get,riak_kv.put,riak_kv.delete</span> <span class="pre">on</span> <span class="pre">default</span> <span class="pre">ssl</span> <span class="pre">to</span> <span class="pre">keysusers</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_kv.get,riak_kv.put,riak_kv.delete</span> <span class="pre">on</span> <span class="pre">default</span> <span class="pre">dnssec</span> <span class="pre">to</span> <span class="pre">keysusers</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_kv.get,riak_kv.put,riak_kv.delete</span> <span class="pre">on</span> <span class="pre">default</span> <span class="pre">url_sig_keys</span> <span class="pre">to</span> <span class="pre">keysusers</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_kv.get,riak_kv.put,riak_kv.delete</span> <span class="pre">on</span> <span class="pre">default</span> <span class="pre">cdn_uri_sig_keys</span>  <span class="pre">to</span> <span class="pre">keysusers</span></code></p>
</div></blockquote>
</li>
</ol>
@@ -334,26 +347,18 @@
<div class="section" id="traffic-ops-configuration">
<h3>Traffic Ops Configuration<a class="headerlink" href="#traffic-ops-configuration" title="Permalink to this headline">¶</a></h3>
<p>There are a couple configurations that are necessary in Traffic Ops.</p>
-<ol class="arabic">
+<ol class="arabic simple">
<li><dl class="first docutils">
<dt>Database Updates</dt>
-<dd><ul class="first simple">
-<li>A new profile for Riak needs to be added to the profile table</li>
-<li>A new type of Riak needs to be added to the type table</li>
-<li>The servers in the Riak cluster need to be added to the server table</li>
+<dd><ul class="first last">
+<li>The servers in the Riak cluster need to be added to the server table (TCP Port = 8088, type = RIAK, profile = RIAK_ALL)</li>
</ul>
-<blockquote class="last">
-<div><div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">profile and type data should be pre-loaded by seeds sql script.</p>
-</div>
-</div></blockquote>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Configuration updates</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li>/opt/traffic_ops/app/conf/<environment>/riak.conf needs to be updated to reflect the correct username and password for accessing riak.</li>
</ul>
</dd>
@@ -368,29 +373,29 @@
<div class="section" id="riak-configuration">
<h3>Riak Configuration<a class="headerlink" href="#riak-configuration" title="Permalink to this headline">¶</a></h3>
<p>On Each Riak Server:</p>
-<ol class="arabic">
+<ol class="arabic simple">
<li><dl class="first docutils">
<dt>If java is not already installed on your Riak server, install Java</dt>
-<dd><ul class="first last simple">
-<li>To see if Java is already installed: <code class="docutils literal"><span class="pre">java</span> <span class="pre">-version</span></code></li>
-<li>To install Java: <code class="docutils literal"><span class="pre">yum</span> <span class="pre">install</span> <span class="pre">-y</span> <span class="pre">jdk</span></code></li>
+<dd><ul class="first last">
+<li>To see if Java is already installed: <code class="docutils literal notranslate"><span class="pre">java</span> <span class="pre">-version</span></code></li>
+<li>To install Java: <code class="docutils literal notranslate"><span class="pre">yum</span> <span class="pre">install</span> <span class="pre">-y</span> <span class="pre">jdk</span></code></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>enable search in riak.conf</dt>
-<dd><ul class="first last simple">
-<li><code class="docutils literal"><span class="pre">vim</span> <span class="pre">/etc/riak/riak.conf</span></code></li>
-<li>look for search and change <code class="docutils literal"><span class="pre">search</span> <span class="pre">=</span> <span class="pre">off</span></code> to <code class="docutils literal"><span class="pre">search</span> <span class="pre">=</span> <span class="pre">on</span></code></li>
+<dd><ul class="first last">
+<li><code class="docutils literal notranslate"><span class="pre">vim</span> <span class="pre">/etc/riak/riak.conf</span></code></li>
+<li>look for search and change <code class="docutils literal notranslate"><span class="pre">search</span> <span class="pre">=</span> <span class="pre">off</span></code> to <code class="docutils literal notranslate"><span class="pre">search</span> <span class="pre">=</span> <span class="pre">on</span></code></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Restart Riak so search is on</dt>
-<dd><ul class="first last simple">
-<li><code class="docutils literal"><span class="pre">service</span> <span class="pre">riak</span> <span class="pre">restart</span></code></li>
+<dd><ul class="first last">
+<li><code class="docutils literal notranslate"><span class="pre">service</span> <span class="pre">riak</span> <span class="pre">restart</span></code></li>
</ul>
</dd>
</dl>
@@ -400,49 +405,49 @@
<ol class="arabic simple">
<li><strong>On one of the Riak servers in the cluster run the following riak-admin commands</strong></li>
</ol>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.admin</span> <span class="pre">on</span> <span class="pre">schema</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.admin</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.query</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.query</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">sslkeys</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.query</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">to</span> <span class="pre">riakuser</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.query</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">sslkeys</span> <span class="pre">to</span> <span class="pre">riakuser</span></code></p>
-<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_core.set_bucket</span> <span class="pre">on</span> <span class="pre">any</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
-<ol class="arabic" start="2">
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.admin</span> <span class="pre">on</span> <span class="pre">schema</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.admin</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.query</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.query</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">sslkeys</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.query</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">to</span> <span class="pre">riakuser</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.query</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">sslkeys</span> <span class="pre">to</span> <span class="pre">riakuser</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_core.set_bucket</span> <span class="pre">on</span> <span class="pre">any</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
+<ol class="arabic simple" start="2">
<li><dl class="first docutils">
<dt>Add the search schema to Riak. This schema is a simple Apache Solr configuration file which will index all records on cdn, hostname, and deliveryservice.</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li>Get the schema file by either cloning the project and going to <cite>traffic_ops/app/config/misc/riak_search</cite> or from <a class="reference external" href="https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_ops/app/conf/misc/riak_search">github</a>.</li>
-<li>Use curl to add the schema to riak: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">-XPUT</span> <span class="pre">"https://admin:pass@riakserver:8088/search/schema/sslkeys"</span> <span class="pre">-H</span> <span class="pre">'Content-Type:application/xml'</span> <span class="pre">-d</span> <span class="pre">@sslkeys.xml</span></code></li>
+<li>Use curl to add the schema to riak: <code class="docutils literal notranslate"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">-XPUT</span> <span class="pre">"https://admin:pass@riakserver:8088/search/schema/sslkeys"</span> <span class="pre">-H</span> <span class="pre">'Content-Type:application/xml'</span>  <span class="pre">-d</span> <span class="pre">@sslkeys.xml</span></code></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add search index to Riak</dt>
-<dd><ul class="first last simple">
-<li>run the following curl command: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">-XPUT</span> <span class="pre">"https://admin:pass@riakserver:8088/search/index/sslkeys"</span> <span class="pre">-H</span> <span class="pre">'Content-Type:</span> <span class="pre">application/json'</span> <span class="pre">-d</span> <span class="pre">'{"schema":"sslkeys"}'</span></code></li>
+<dd><ul class="first last">
+<li>run the following curl command: <code class="docutils literal notranslate"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">-XPUT</span> <span class="pre">"https://admin:pass@riakserver:8088/search/index/sslkeys"</span> <span class="pre">-H</span> <span class="pre">'Content-Type:</span> <span class="pre">application/json'</span> <span class="pre">-d</span> <span class="pre">'{"schema":"sslkeys"}'</span></code></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Associate the sslkeys index to the ssl bucket in Riak</dt>
-<dd><ul class="first last simple">
-<li>run the following curl command: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">-XPUT</span> <span class="pre">"https://admin:pass@riakserver:8088/buckets/ssl/props"</span> <span class="pre">-H'content-type:application/json'</span> <span class="pre">-d'{"props":{"search_index":"sslkeys"}}'</span></code></li>
+<dd><ul class="first last">
+<li>run the following curl command: <code class="docutils literal notranslate"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">-XPUT</span> <span class="pre">"https://admin:pass@riakserver:8088/buckets/ssl/props"</span> <span class="pre">-H'content-type:application/json'</span> <span class="pre">-d'{"props":{"search_index":"sslkeys"}}'</span></code></li>
</ul>
</dd>
</dl>
</li>
</ol>
-<p>Riak Search (using Apache Solr) will now index all NEW records that are added to the “ssl” bucket. The cdn, deliveryservice, and hostname fields are indexed and when a search is performed riak will return the indexed fields along with the crt and key values for a ssl record. In order to add the indexed fields to current records and to get the current records added, a standalone script needs to be run. The following explains how to run the script.</p>
+<p>Riak Search (using Apache Solr) will now index all NEW records that are added to the “ssl” bucket. The cdn, deliveryservice, and hostname fields are indexed and when a search is performed riak will return the indexed fields along with the crt and key values for a ssl record. In order to add the indexed fields to current records and to get the current records added, a standalone script needs to be run. This does not need to be done on new installs. The following explains how to run the script.</p>
<ol class="arabic simple">
<li>Get script from github either by cloning the project and going to <cite>traffic_ops/app/script</cite> or from <a class="reference external" href="https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_ops/app/script/update_riak_for_search.pl">here</a></li>
-<li>Run the script by performing the following command <code class="docutils literal"><span class="pre">./update_riak_for_search.pl</span> <span class="pre">-to_url=https://traffic-ops.kabletown.net</span> <span class="pre">-to_un=user</span> <span class="pre">-to_pw=password</span></code></li>
+<li>Run the script by performing the following command <code class="docutils literal notranslate"><span class="pre">./update_riak_for_search.pl</span> <span class="pre">-to_url=https://traffic-ops.kabletown.net</span> <span class="pre">-to_un=user</span> <span class="pre">-to_pw=password</span></code></li>
</ol>
<p>Validate the search is working by querying against Riak directly:
-<code class="docutils literal"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">"https://admin:password@riakserver:8088/search/query/sslkeys?wt=json&q=cdn:mycdn"</span></code></p>
+<code class="docutils literal notranslate"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">"https://admin:password@riakserver:8088/search/query/sslkeys?wt=json&q=cdn:mycdn"</span></code></p>
<p>Validation can also be done by querying Traffic Ops:
-<code class="docutils literal"><span class="pre">curl</span> <span class="pre">-Lvs</span> <span class="pre">-H</span> <span class="pre">"Cookie:</span> <span class="pre">$COOKIE"</span> <span class="pre">https://traffic-ops.kabletown.net/api/1.2/cdns/name/mycdn/sslkeys.json</span></code></p>
+<code class="docutils literal notranslate"><span class="pre">curl</span> <span class="pre">-Lvs</span> <span class="pre">-H</span> <span class="pre">"Cookie:</span> <span class="pre">$COOKIE"</span> <span class="pre">https://traffic-ops.kabletown.net/api/1.2/cdns/name/mycdn/sslkeys.json</span></code></p>
</div>
</div>
</div>
@@ -480,16 +485,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/api/index.html b/docs/latest/api/index.html
new file mode 100644
index 0000000..7fc8d31
--- /dev/null
+++ b/docs/latest/api/index.html
@@ -0,0 +1,375 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>APIs — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
+ <link rel="next" title="API Overview" href="traffic_ops_api.html"/>
+ <link rel="prev" title="Traffic Stats" href="../development/traffic_stats.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="#">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li>APIs</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/api/index.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="traffic_ops_api.html" class="btn btn-neutral float-right" title="API Overview">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../development/traffic_stats.html" class="btn btn-neutral" title="Traffic Stats"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="apis">
+<h1>APIs<a class="headerlink" href="#apis" title="Permalink to this headline">¶</a></h1>
+<p>A guide to external RESTful APIs for Traffic Ops</p>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api.html">API Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#response-structure">Response Structure</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#using-api-endpoints">Using API Endpoints</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#api-errors">API Errors</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html#trafficops-native-client-libraries">TrafficOps Native Client Libraries</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="routes.html">API Routes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="v11/index.html">API 1.1 Reference</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="v11/asn.html">ASN</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/cachegroup.html">Cache Group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/cdn.html">CDN</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/changelog.html">Change Logs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/deliveryservice.html">Delivery Service</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/hwinfo.html">Hardware Info</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/parameter.html">Parameter</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/phys_location.html">Physical Location</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/profile.html">Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/region.html">Regions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/role.html">Roles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/server.html">Server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/static_dns.html">Static DNS Entries</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/status.html">Status</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/system.html">System</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/to_extension.html">TO Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/type.html">Types</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/user.html">Users</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="v12/index.html">API 1.2 Reference</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="v12/api_capability.html">API-Capabilities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/asn.html">ASN</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/cache.html">Cache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/cachegroup.html">Cache Group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/cachegroup_parameter.html">Cache Group parameters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/cachegroup_fallbacks.html">Cache Group Fallback</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/cache_stats.html">Cache Statistics</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/capability.html">Capabilities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/cdn.html">CDN</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/changelog.html">Change Logs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/configfiles_ats.html">Config Files and Config File Metadata</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/deliveryservice.html">Delivery Service</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/deliveryservice_regex.html">Delivery Service Regexes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/deliveryservice_stats.html">Delivery Service Statistics</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/division.html">Divisions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/federation.html">Federation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/federation_deliveryservice.html">Federation Delivery Service</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/federation_federationresolver.html">Federation Federation Resolver</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/federation_resolver.html">Federation Resolver</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/federation_user.html">Federation User</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/hwinfo.html">Hardware Info</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/iso.html">ISO</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/job.html">Jobs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/parameter.html">Parameter</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/phys_location.html">Physical Location</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/profile.html">Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/profile_parameter.html">Profile parameters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/influxdb.html">InfluxDB</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/region.html">Regions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/role.html">Roles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/server.html">Server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/static_dns.html">Static DNS Entries</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/status.html">Status</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/steering_target.html">Steering Targets</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/system.html">System</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/tenant.html">Tenants</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/to_extension.html">TO Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/type.html">Types</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/user.html">Users</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/topology.html">Snapshot CRConfig</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="v13/index.html">API 1.3 Reference</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="v13/coordinate.html">Coordinate</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v13/origin.html">Origin</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="traffic_ops_api.html" class="btn btn-neutral float-right" title="API Overview">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../development/traffic_stats.html" class="btn btn-neutral" title="Traffic Stats"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/routes.html b/docs/latest/api/routes.html
new file mode 100644
index 0000000..9534892
--- /dev/null
+++ b/docs/latest/api/routes.html
@@ -0,0 +1,467 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>API Routes — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
+ <link rel="up" title="APIs" href="index.html"/>
+ <link rel="next" title="API 1.1 Reference" href="v11/index.html"/>
+ <link rel="prev" title="API Overview" href="traffic_ops_api.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="index.html">APIs</a> »</li>
+
+ <li>API Routes</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/api/routes.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="v11/index.html" class="btn btn-neutral float-right" title="API 1.1 Reference">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="traffic_ops_api.html" class="btn btn-neutral" title="API Overview"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <style>
+table {
+ table-layout: fixed;
+ width: 100%;
+}
+
+td {
+ word-wrap:break-word;
+}
+table.docutils col:nth-child(1) {
+ width: 30%;
+}
+table.docutils col:nth-child(2) {
+ width: 30%;
+}
+table.docutils col:nth-child(3) {
+ width: 30%;
+}
+.wy-nav-content {
+ max-width: 1200px;
+ width: 90%;
+}
+</style><div class="section" id="api-routes">
+<span id="to-api-routes"></span><h1>API Routes<a class="headerlink" href="#api-routes" title="Permalink to this headline">¶</a></h1>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="37%" />
+<col width="37%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">1.0</th>
+<th class="head">1.1</th>
+<th class="head">1.2</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>/asns</td>
+<td><a class="reference internal" href="v11/asn.html#to-api-v11-asns-route"><span class="std std-ref">/api/1.1/asns</span></a></td>
+<td><a class="reference internal" href="v12/asn.html#to-api-v12-asns-route"><span class="std std-ref">/api/1.2/asns</span></a></td>
+</tr>
+<tr class="row-odd"><td>/availableds</td>
+<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td>
+<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td>
+</tr>
+<tr class="row-even"><td><em>Not Implemented</em></td>
+<td><em>Not Implemented</em></td>
+<td><a class="reference internal" href="v12/cache_stats.html#to-api-v12-cache-stats-route"><span class="std std-ref">/api/1.2/cache_stats</span></a></td>
+</tr>
+<tr class="row-odd"><td>/datacrans</td>
+<td>/api/1.1/crans.json</td>
+<td>/api/1.2/crans.json</td>
+</tr>
+<tr class="row-even"><td>/datacrans/orderby/:field</td>
+<td>/api/1.1/crans.json</td>
+<td>/api/1.2/crans.json</td>
+</tr>
+<tr class="row-odd"><td>/datadeliveryservice</td>
+<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td>
+<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td>
+</tr>
+<tr class="row-even"><td>/datadeliveryserviceserver</td>
+<td>/api/1.1/deliveryserviceserver.json</td>
+<td>/api/1.2/deliveryserviceserver.json</td>
+</tr>
+<tr class="row-odd"><td>/datadomains</td>
+<td>/api/1.1/cdns/domains.json</td>
+<td>/api/1.2/cdns/domains.json</td>
+</tr>
+<tr class="row-even"><td><em>Not Implemented</em></td>
+<td><em>Not Implemented</em></td>
+<td><a class="reference internal" href="v12/deliveryservice_stats.html#to-api-v12-ds-stats-route"><span class="std std-ref">/api/1.2/deliveryservice_stats</span></a></td>
+</tr>
+<tr class="row-odd"><td>/datahwinfo</td>
+<td><a class="reference internal" href="v11/hwinfo.html#to-api-v11-hwinfo-route"><span class="std std-ref">/api/1.1/hwinfo</span></a></td>
+<td><a class="reference internal" href="v12/hwinfo.html#to-api-v12-hwinfo-route"><span class="std std-ref">/api/1.2/hwinfo</span></a></td>
+</tr>
+<tr class="row-even"><td>/datalinks</td>
+<td>/api/1.1/deliveryserviceserver.json</td>
+<td>/api/1.2/deliveryserviceserver.json</td>
+</tr>
+<tr class="row-odd"><td>/datalinks/orderby/:field</td>
+<td>/api/1.1/deliveryserviceserver.json</td>
+<td>/api/1.2/deliveryserviceserver.json</td>
+</tr>
+<tr class="row-even"><td>/datalogs</td>
+<td><a class="reference internal" href="v11/changelog.html#to-api-v11-change-logs-route"><span class="std std-ref">/api/1.1/logs</span></a></td>
+<td><a class="reference internal" href="v12/changelog.html#to-api-v12-change-logs-route"><span class="std std-ref">/api/1.2/logs</span></a></td>
+</tr>
+<tr class="row-odd"><td>/datalocation/orderby/id</td>
+<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td>
+<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td>
+</tr>
+<tr class="row-even"><td>/datalocationparameters</td>
+<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td>
+<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td>
+</tr>
+<tr class="row-odd"><td>/dataparameter</td>
+<td><a class="reference internal" href="v11/parameter.html#to-api-v11-parameters-route"><span class="std std-ref">/api/1.1/parameters</span></a></td>
+<td><a class="reference internal" href="v12/parameter.html#to-api-v12-parameters-route"><span class="std std-ref">/api/1.2/parameters</span></a></td>
+</tr>
+<tr class="row-even"><td>/dataparameter/:parameter</td>
+<td>/api/1.1/parameters/profile/:parameter.json</td>
+<td>/api/1.2/parameters/profile/:parameter.json</td>
+</tr>
+<tr class="row-odd"><td>/dataphys_location</td>
+<td><a class="reference internal" href="v11/phys_location.html#to-api-v11-phys-loc-route"><span class="std std-ref">/api/1.1/phys_locations</span></a></td>
+<td><a class="reference internal" href="v12/phys_location.html#to-api-v12-phys-loc-route"><span class="std std-ref">/api/1.2/phys_locations</span></a></td>
+</tr>
+<tr class="row-even"><td><p class="first">/dataprofile</p>
+<p class="last">/dataprofile/orderby/name</p>
+</td>
+<td><a class="reference internal" href="v11/profile.html#to-api-v11-profiles-route"><span class="std std-ref">/api/1.1/profiles</span></a></td>
+<td><a class="reference internal" href="v12/profile.html#to-api-v12-profiles-route"><span class="std std-ref">/api/1.2/profiles</span></a></td>
+</tr>
+<tr class="row-odd"><td>/dataregion</td>
+<td><a class="reference internal" href="v11/region.html#to-api-v11-regions-route"><span class="std std-ref">/api/1.1/regions</span></a></td>
+<td><a class="reference internal" href="v12/region.html#to-api-v12-regions-route"><span class="std std-ref">/api/1.2/regions</span></a></td>
+</tr>
+<tr class="row-even"><td>/datarole</td>
+<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td>
+<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td>
+</tr>
+<tr class="row-odd"><td>/datarole/orderby/:field</td>
+<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td>
+<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td>
+</tr>
+<tr class="row-even"><td>/dataserver</td>
+<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td>
+<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td>
+</tr>
+<tr class="row-odd"><td>/dataserver/orderby/:field</td>
+<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td>
+<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td>
+</tr>
+<tr class="row-even"><td>/dataserverdetail/select/:hostname</td>
+<td>/api/1.1/servers/hostname/:hostname/details.json</td>
+<td>/api/1.2/servers/hostname/:hostname/details.json</td>
+</tr>
+<tr class="row-odd"><td>/datastaticdnsentry</td>
+<td><a class="reference internal" href="v11/static_dns.html#to-api-v11-static-dns-route"><span class="std std-ref">/api/1.1/staticdnsentries</span></a></td>
+<td><a class="reference internal" href="v12/static_dns.html#to-api-v12-static-dns-route"><span class="std std-ref">/api/1.2/staticdnsentries</span></a></td>
+</tr>
+<tr class="row-even"><td>/datastatus</td>
+<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td>
+<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td>
+</tr>
+<tr class="row-odd"><td>/datastatus/orderby/name</td>
+<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td>
+<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td>
+</tr>
+<tr class="row-even"><td>/datatype</td>
+<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td>
+<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td>
+</tr>
+<tr class="row-odd"><td>/datatype/orderby/:field</td>
+<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td>
+<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td>
+</tr>
+<tr class="row-even"><td>/datauser</td>
+<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td>
+<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td>
+</tr>
+<tr class="row-odd"><td>/datauser/orderby/:field</td>
+<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td>
+<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td>
+</tr>
+<tr class="row-even"><td><em>Not Implemented</em></td>
+<td><em>Not Implemented</em></td>
+<td><a class="reference internal" href="v12/configfiles_ats.html#to-api-v12-configfiles-ats-route"><span class="std std-ref">/api/1.2/servers/:hostname/configfiles/ats</span></a></td>
+</tr>
+</tbody>
+</table>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="v11/index.html" class="btn btn-neutral float-right" title="API 1.1 Reference">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="traffic_ops_api.html" class="btn btn-neutral" title="API Overview"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/traffic_ops_api.html b/docs/latest/api/traffic_ops_api.html
new file mode 100644
index 0000000..fceb256
--- /dev/null
+++ b/docs/latest/api/traffic_ops_api.html
@@ -0,0 +1,495 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>API Overview — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
+ <link rel="up" title="APIs" href="index.html"/>
+ <link rel="next" title="API Routes" href="routes.html"/>
+ <link rel="prev" title="APIs" href="index.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">APIs</a><ul class="current">
+<li class="toctree-l2 current"><a class="current reference internal" href="#">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="index.html">APIs</a> »</li>
+
+ <li>API Overview</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/api/traffic_ops_api.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="routes.html" class="btn btn-neutral float-right" title="API Routes">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="index.html" class="btn btn-neutral" title="APIs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="api-overview">
+<h1>API Overview<a class="headerlink" href="#api-overview" title="Permalink to this headline">¶</a></h1>
+<p>The Traffic Ops API provides programmatic access to read and write CDN data providing authorized API consumers with the ability to monitor CDN performance and configure CDN settings and parameters.</p>
+<div class="section" id="response-structure">
+<h2>Response Structure<a class="headerlink" href="#response-structure" title="Permalink to this headline">¶</a></h2>
+<p>All successful responses have the following structure:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="o"><</span><span class="n">JSON</span> <span class="nb">object</span> <span class="k">with</span> <span class="n">main</span> <span class="n">response</span><span class="o">></span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>To make the documentation easier to read, only the <code class="docutils literal notranslate"><span class="pre"><JSON</span> <span class="pre">object</span> <span class="pre">with</span> <span class="pre">main</span> <span class="pre">response></span></code> is documented, even though the response and version fields are always present.</p>
+</div>
+<div class="section" id="using-api-endpoints">
+<h2>Using API Endpoints<a class="headerlink" href="#using-api-endpoints" title="Permalink to this headline">¶</a></h2>
+<ol class="arabic simple">
+<li>Authenticate with your Traffic Portal or Traffic Ops user account credentials.</li>
+<li>Upon successful user authentication, note the mojolicious cookie value in the response headers.</li>
+<li>Pass the mojolicious cookie value, along with any subsequent calls to an authenticated API endpoint.</li>
+</ol>
+<p>Example:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+{"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
+[jvd@laika ~]$
+[jvd@laika ~]$ curl -v -H "Accept: application/json" -v -X POST --data '{ "u":"admin", "p":"secret_passwd" }' http://localhost:3000/api/1.1/user/login
+* Hostname was NOT found in DNS cache
+* Trying ::1...
+* connect to ::1 port 3000 failed: Connection refused
+* Trying 127.0.0.1...
+* Connected to localhost (127.0.0.1) port 3000 (#0)
+> POST /api/1.1/user/login HTTP/1.1
+> User-Agent: curl/7.37.1
+> Host: localhost:3000
+> Accept: application/json
+> Content-Length: 32
+> Content-Type: application/x-www-form-urlencoded
+>
+* upload completely sent off: 32 out of 32 bytes
+< HTTP/1.1 200 OK
+< Connection: keep-alive
+< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+< Access-Control-Allow-Origin: http://localhost:8080
+< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+< Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862; expires=Sun, 19 Apr 2015 00:10:01 GMT; path=/; HttpOnly
+< Content-Type: application/json
+< Date: Sat, 18 Apr 2015 20:10:01 GMT
+< Access-Control-Allow-Credentials: true
+< Content-Length: 81
+< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+* Server Mojolicious (Perl) is not blacklisted
+< Server: Mojolicious (Perl)
+<
+* Connection #0 to host localhost left intact
+{"alerts":[{"level":"success","text":"Successfully logged in."}]}
+[jvd@laika ~]$
+
+[jvd@laika ~]$ curl -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asns.json
+{"response":{"asns":[{"lastUpdated":"2012-09-17 15:41:22", .. asn data deleted .. ,}
+[jvd@laika ~]$
+</pre></div>
+</div>
+</div>
+<div class="section" id="api-errors">
+<h2>API Errors<a class="headerlink" href="#api-errors" title="Permalink to this headline">¶</a></h2>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p>The 3 most common errors returned by Traffic Ops are:</p>
+<dl class="docutils">
+<dt>401 Unauthorized</dt>
+<dd><p class="first">When you don’t supply the right cookie, this is the response.</p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+* Hostname was NOT found in DNS cache
+* Trying ::1...
+* connect to ::1 port 3000 failed: Connection refused
+* Trying 127.0.0.1...
+* Connected to localhost (127.0.0.1) port 3000 (#0)
+> GET /api/1.1/usage/asns.json HTTP/1.1
+> User-Agent: curl/7.37.1
+> Host: localhost:3000
+> Accept: application/json
+>
+< HTTP/1.1 401 Unauthorized
+< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+< Content-Length: 84
+* Server Mojolicious (Perl) is not blacklisted
+< Server: Mojolicious (Perl)
+< Connection: keep-alive
+< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+< Access-Control-Allow-Origin: http://localhost:8080
+< Date: Sat, 18 Apr 2015 20:36:12 GMT
+< Content-Type: application/json
+< Access-Control-Allow-Credentials: true
+<
+* Connection #0 to host localhost left intact
+{"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
+[jvd@laika ~]$
+</pre></div>
+</div>
+</dd>
+<dt>404 Not Found</dt>
+<dd><p class="first">When the resource (path) is non existent Traffic Ops returns a 404:</p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
+* Hostname was NOT found in DNS cache
+* Trying ::1...
+* connect to ::1 port 3000 failed: Connection refused
+* Trying 127.0.0.1...
+* Connected to localhost (127.0.0.1) port 3000 (#0)
+> GET /api/1.1/asnsjj.json HTTP/1.1
+> User-Agent: curl/7.37.1
+> Host: localhost:3000
+> Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;
+> Accept: application/json
+>
+< HTTP/1.1 404 Not Found
+* Server Mojolicious (Perl) is not blacklisted
+< Server: Mojolicious (Perl)
+< Content-Length: 75
+< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+< Content-Type: application/json
+< Date: Sat, 18 Apr 2015 20:37:43 GMT
+< Access-Control-Allow-Credentials: true
+< Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAzODYzLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--8a5a61b91473bc785d4073fe711de8d2c63f02dd; expires=Sun, 19 Apr 2015 00:37:43 GMT; path=/; HttpOnly
+< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+< Connection: keep-alive
+< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+< Access-Control-Allow-Origin: http://localhost:8080
+<
+* Connection #0 to host localhost left intact
+{"alerts":[{"text":"Resource not found.","level":"error"}]}
+[jvd@laika ~]$
+</pre></div>
+</div>
+</dd>
+<dt>500 Internal Server Error</dt>
+<dd><p class="first">When you are asking for a correct path, but the database doesn’t match, it returns a 500:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
+* Hostname was NOT found in DNS cache
+* Trying ::1...
+* connect to ::1 port 3000 failed: Connection refused
+* Trying 127.0.0.1...
+* Connected to localhost (127.0.0.1) port 3000 (#0)
+> GET /api/1.1/servers/hostname/jj/details.json HTTP/1.1
+> User-Agent: curl/7.37.1
+> Host: localhost:3000
+> Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;
+> Accept: application/json
+>
+< HTTP/1.1 500 Internal Server Error
+* Server Mojolicious (Perl) is not blacklisted
+< Server: Mojolicious (Perl)
+< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+< Content-Length: 93
+< Set-Cookie: mojolicious=eyJhdXRoX2RhdGEiOiJhZG1pbiIsImV4cGlyZXMiOjE0Mjk0MDQzMDZ9--1b08977e91f8f68b0ff5d5e5f6481c76ddfd0853; expires=Sun, 19 Apr 2015 00:45:06 GMT; path=/; HttpOnly
+< Content-Type: application/json
+< Date: Sat, 18 Apr 2015 20:45:06 GMT
+< Access-Control-Allow-Credentials: true
+< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+< Connection: keep-alive
+< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+< Access-Control-Allow-Origin: http://localhost:8080
+<
+* Connection #0 to host localhost left intact
+{"alerts":[{"level":"error","text":"An error occurred. Please contact your administrator."}]}
+[jvd@laika ~]$
+</pre></div>
+</div>
+<p class="last">The rest of the API documentation will only document the <code class="docutils literal notranslate"><span class="pre">200</span> <span class="pre">OK</span></code> case, where no errors have occured.</p>
+</dd>
+</dl>
+</div>
+<div class="section" id="trafficops-native-client-libraries">
+<h2>TrafficOps Native Client Libraries<a class="headerlink" href="#trafficops-native-client-libraries" title="Permalink to this headline">¶</a></h2>
+<p>TrafficOps client libraries are available in both Golang and Python. You can read more about them at <a class="reference external" href="https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_control/clients">https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_control/clients</a></p>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="routes.html" class="btn btn-neutral float-right" title="API Routes">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="index.html" class="btn btn-neutral" title="APIs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/asn.html b/docs/latest/api/v11/asn.html
new file mode 100644
index 0000000..de861dc
--- /dev/null
+++ b/docs/latest/api/v11/asn.html
@@ -0,0 +1,363 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>ASN — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Cache Group" href="cachegroup.html"/>
+ <link rel="prev" title="API 1.1 Reference" href="index.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>ASN</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/asn.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cachegroup.html" class="btn btn-neutral float-right" title="Cache Group">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="index.html" class="btn btn-neutral" title="API 1.1 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="asn">
+<span id="to-api-v11-asn"></span><h1>ASN<a class="headerlink" href="#asn" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-asns">
+<span id="to-api-v11-asns-route"></span><h2>/api/1.1/asns<a class="headerlink" href="#api-1-1-asns" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/asns</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">asns</span></code></td>
+<td>array</td>
+<td>A collection of asns</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the ASN</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>asn</span></code></td>
+<td>string</td>
+<td>Autonomous System Numbers per APNIC for identifying a service provider.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>cachegroup</span></code></td>
+<td>string</td>
+<td>Related cachegroup name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"asns"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cachegroup.html" class="btn btn-neutral float-right" title="Cache Group">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="index.html" class="btn btn-neutral" title="API 1.1 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/cachegroup.html b/docs/latest/api/v11/cachegroup.html
new file mode 100644
index 0000000..4ac1dc3
--- /dev/null
+++ b/docs/latest/api/v11/cachegroup.html
@@ -0,0 +1,740 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Cache Group — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="CDN" href="cdn.html"/>
+ <link rel="prev" title="ASN" href="asn.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Cache Group</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/cachegroup.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cdn.html" class="btn btn-neutral float-right" title="CDN">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="asn.html" class="btn btn-neutral" title="ASN"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="cache-group">
+<span id="to-api-v11-cachegroup"></span><h1>Cache Group<a class="headerlink" href="#cache-group" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-cachegroups">
+<span id="to-api-v11-cachegroups-route"></span><h2>/api/1.1/cachegroups<a class="headerlink" href="#api-1-1-cachegroups" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/cachegroups</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>string</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>string</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroupId</span></code></td>
+<td>string</td>
+<td>Parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroupName</span></code></td>
+<td>string</td>
+<td>Parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroupId</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago-1"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cachegroups/trimmed</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cachegroups/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>string</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>string</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroupId</span></code></td>
+<td>string</td>
+<td>Parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroupName</span></code></td>
+<td>string</td>
+<td>Parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroupId</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cachegroup/:parameter_id/parameter</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="44%" />
+<col width="24%" />
+<col width="32%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameter_id</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="45%" />
+<col width="21%" />
+<col width="34%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroups</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/cachegroupparameters</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="11%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroupParameters</span></code></td>
+<td>array</td>
+<td>A collection of cache group parameters.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>parameter</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>last_updated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cachegroup</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"380"</span><span class="p">,</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cachegroups/:parameter_id/parameter/available</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="44%" />
+<col width="24%" />
+<col width="32%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameter_id</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td> </td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td> </td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cdn.html" class="btn btn-neutral float-right" title="CDN">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="asn.html" class="btn btn-neutral" title="ASN"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/cdn.html b/docs/latest/api/v11/cdn.html
new file mode 100644
index 0000000..66ea018
--- /dev/null
+++ b/docs/latest/api/v11/cdn.html
@@ -0,0 +1,2049 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>CDN — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Change Logs" href="changelog.html"/>
+ <link rel="prev" title="Cache Group" href="cachegroup.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>CDN</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/cdn.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="changelog.html" class="btn btn-neutral float-right" title="Change Logs">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cachegroup.html" class="btn btn-neutral" title="Cache Group"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="cdn">
+<span id="to-api-v11-cdn-health"></span><h1>CDN<a class="headerlink" href="#cdn" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-cdns">
+<span id="to-api-v11-cdn-health-route"></span><h2>/api/1.1/cdns<a class="headerlink" href="#api-1-1-cdns" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/cdns</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cdns/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cdns/name/:name</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="health">
+<h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/cdns/health</strong></p>
+<blockquote>
+<div><p>Retrieves the health of all locations (cache groups) for all CDNs.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="11%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">totalOnline</span></code></td>
+<td>int</td>
+<td>Total number of online caches across all CDNs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">totalOffline</span></code></td>
+<td>int</td>
+<td>Total number of offline caches across all CDNs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>online</span></code></td>
+<td>int</td>
+<td>The number of online caches for the cache group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>offline</span></code></td>
+<td>int</td>
+<td>The number of offline caches for the cache
+group.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>Cache group name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cdns/:name/health</strong></p>
+<blockquote>
+<div><p>Retrieves the health of all locations (cache groups) for a given CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="11%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">totalOnline</span></code></td>
+<td>int</td>
+<td>Total number of online caches across the
+specified CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">totalOffline</span></code></td>
+<td>int</td>
+<td>Total number of offline caches across the
+specified CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>online</span></code></td>
+<td>int</td>
+<td>The number of online caches for the cache group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>offline</span></code></td>
+<td>int</td>
+<td>The number of offline caches for the cache
+group.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>Cache group name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cdns/usage/overview</strong></p>
+<blockquote>
+<div><p>Retrieves the high-level CDN usage metrics.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">currentGbps</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tps</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">maxGbps</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
+ <span class="s2">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
+ <span class="s2">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/cdns/capacity</strong></p>
+<blockquote>
+<div><p>Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">availablePercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">unavailablePercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">utilizedPercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maintenancePercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="routing">
+<span id="to-api-v11-cdn-routing"></span><h2>Routing<a class="headerlink" href="#routing" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/cdns/routing</strong></p>
+<blockquote>
+<div><p>Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="12%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">staticRoute</span></code></td>
+<td>number</td>
+<td>Used pre-configured DNS entries.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">miss</span></code></td>
+<td>number</td>
+<td>No location available for client IP.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geo</span></code></td>
+<td>number</td>
+<td>Used 3rd party geo-IP mapping.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">err</span></code></td>
+<td>number</td>
+<td>Error localizing client IP.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cz</span></code></td>
+<td>number</td>
+<td>Used Coverage Zone geo-IP mapping.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dsr</span></code></td>
+<td>number</td>
+<td>Overflow traffic sent to secondary CDN.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="metrics">
+<span id="to-api-v11-cdn-metrics"></span><h2>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end</strong></p>
+<p><em>Note: this route is not currently implemented in Traffic Ops. See https://github.com/apache/incubator-trafficcontrol/issues/2309</em></p>
+<blockquote>
+<div><p>Retrieves edge metrics of one or all locations (cache groups).</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="19%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">metric_type</span></code></td>
+<td>yes</td>
+<td>ooff, origin_tps</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">start</span></code></td>
+<td>yes</td>
+<td>UNIX time, yesterday, now</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">end</span></code></td>
+<td>yes</td>
+<td>UNIX time, yesterday, now</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="19%" />
+<col width="31%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>count</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>98thPercentile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>min</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>max</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>5thPercentile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>95thPercentile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>mean</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>sum</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">data</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>time</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>value</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">label</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
+ <span class="p">},</span>
+ <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">[</span>
+ <span class="mi">1425135900000</span><span class="p">,</span>
+ <span class="mf">1668.03</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="mi">1425136200000</span><span class="p">,</span>
+ <span class="n">null</span>
+ <span class="p">]</span>
+ <span class="p">],</span>
+ <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"Origin TPS"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="domains">
+<span id="to-api-v11-cdn-domains"></span><h2>Domains<a class="headerlink" href="#domains" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/cdns/domains</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parameterId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"404"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_FOO"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for foo.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"foo.domain.net"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"405"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_BAR"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for bar.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"bar.domain.net"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="topology">
+<span id="to-api-v11-cdn-topology"></span><h2>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/cdns/:cdn_name/configs</strong></p>
+<blockquote>
+<div><p>Retrieves CDN config information based upon the provided cdn name.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="21%" />
+<col width="49%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn_name</span></code></td>
+<td>yes</td>
+<td>Your cdn name or, all</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="10%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">TBD</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cdns/:name/configs/monitoring</strong></p>
+<blockquote>
+<div><p>Retrieves CDN monitoring information.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>CDN name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="64%" />
+<col width="10%" />
+<col width="26%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trafficServers</span></code></td>
+<td>array</td>
+<td>A collection of
+Traffic Servers.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroup</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>interfaceName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hashId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cacheGroups</span></code></td>
+<td>array</td>
+<td>A collection of
+cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>coordinates</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>longitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>latitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">config</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hack.ttl</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tm.healthParams.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.dataServer.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>health.timepad</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>health.threadPool</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>health.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>health.event-count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.crConfig.polling.url</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>CDN_name</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trafficMonitors</span></code></td>
+<td>array</td>
+<td>A collection of
+Traffic Monitors.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServices</span></code></td>
+<td>array</td>
+<td>A collection of
+delivery services.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>totalTpsThreshold</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>totalKbpsThreshold</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profiles</span></code></td>
+<td>array</td>
+<td>A collection of
+profiles.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>parameters</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>health.connection.timeout</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>health.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>health.threshold.queryTime</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>history.count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>health.threshold.availableBandwidthInKbps</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>health.threshold.loadavg</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">TBD</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cdns/:name/configs/routing</strong></p>
+<blockquote>
+<div><p>Retrieves CDN routing information.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="46%" />
+<col width="11%" />
+<col width="43%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trafficServers</span></code></td>
+<td>array</td>
+<td>A collection of Traffic Servers.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroup</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>deliveryServices</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>remaps</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>interfaceName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hashId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>trafficOpsPath</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cdnName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>trafficOpsVersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>trafficOpsUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>date</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>trafficOpsHost</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cacheGroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>coordinates</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>longitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>latitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">config</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tld.soa.admin</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tcoveragezone.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>geolocation.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tld.soa.expire</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>coveragezone.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tld.soa.minimum</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>geolocation.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>domain_name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tld.ttls.AAAA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tld.soa.refresh</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tld.ttls.NS</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tld.ttls.SOA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>geolocation6.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tld.ttls.A</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tld.soa.retry</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>geolocation6.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trafficMonitors</span></code></td>
+<td>array</td>
+<td>A collection of Traffic Monitors.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServices</span></code></td>
+<td>array</td>
+<td>A collection of delivery
+services.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ttl</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>geoEnabled</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>coverageZoneOnly</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>matchSets</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>protocol</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>matchList</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>>regex</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>>matchType</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>bypassDestination</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>maxDnsIpsForLocation</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>ttl</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ttls</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>A</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>SOA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>NS</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>AAAA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>missCoordinates</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>longitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>latitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>soa</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>admin</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>retry</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>minimum</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>refresh</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>expire</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trafficRouters</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>profile</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>apiPort</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<dl class="docutils">
+<dt>::</dt>
+<dd>TBD</dd>
+</dl>
+</div>
+<div class="section" id="dnssec-keys">
+<span id="to-api-v11-cdn-dnsseckeys"></span><h2>DNSSEC Keys<a class="headerlink" href="#dnssec-keys" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/cdns/name/:name/dnsseckeys</strong></p>
+<blockquote>
+<div><p>Gets a list of dnsseckeys for CDN and all associated Delivery Services.
+Before returning response to user, check to make sure keys aren’t expired. If they are expired, generate new ones.
+Before returning response to user, make sure dnssec keys for all delivery services exist. If they don’t exist, create them.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="9%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span> <span class="pre">name/ds</span> <span class="pre">xml_id</span></code></td>
+<td>string</td>
+<td>identifier for ds or cdn</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>zsk/ksk</span></code></td>
+<td>array</td>
+<td>collection of zsk/ksk data</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>ttl</span></code></td>
+<td>string</td>
+<td>time-to-live for dnssec requests</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>inceptionDate</span></code></td>
+<td>string</td>
+<td>epoch timestamp for when the keys were created</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>expirationDate</span></code></td>
+<td>string</td>
+<td>epoch timestamp representing the expiration of the keys</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>private</span></code></td>
+<td>string</td>
+<td>encoded private key</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>public</span></code></td>
+<td>string</td>
+<td>encoded public key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>name</span></code></td>
+<td>string</td>
+<td>domain name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cdn1"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s2">"ds-01"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="o">...</span> <span class="n">repeated</span> <span class="k">for</span> <span class="n">each</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">cdn</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/cdns/name/:name/dnsseckeys/delete</strong></p>
+<blockquote>
+<div><p>Delete dnssec keys for a cdn and all associated delivery services.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="13%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>name of the CDN for which you want to delete dnssec keys</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>success response</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted dnssec keys for <cdn>"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/deliveryservices/dnsseckeys/generate</strong></p>
+<blockquote>
+<div><p>Generates zsk and ksk keypairs for a cdn and all associated delivery services.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="11%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>name of the cdn</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>domain name of the cdn</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>string</td>
+<td>time to live</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">kskExpirationDays</span></code></td>
+<td>string</td>
+<td>Expiration (in days) for the key signing keys</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">zskExpirationDays</span></code></td>
+<td>string</td>
+<td>Expiration (in days) for the zone signing keys</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
+ <span class="s2">"name"</span> <span class="s2">"ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"kskExpirationDays"</span><span class="p">:</span> <span class="s2">"365"</span><span class="p">,</span>
+ <span class="s2">"zskExpirationDays"</span><span class="p">:</span> <span class="s2">"90"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="36%" />
+<col width="21%" />
+<col width="44%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>response string</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully created dnssec keys for cdn1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="changelog.html" class="btn btn-neutral float-right" title="Change Logs">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cachegroup.html" class="btn btn-neutral" title="Cache Group"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/changelog.html b/docs/latest/api/v11/changelog.html
new file mode 100644
index 0000000..20d5221
--- /dev/null
+++ b/docs/latest/api/v11/changelog.html
@@ -0,0 +1,496 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Change Logs — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Delivery Service" href="deliveryservice.html"/>
+ <link rel="prev" title="CDN" href="cdn.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Change Logs</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/changelog.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="deliveryservice.html" class="btn btn-neutral float-right" title="Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cdn.html" class="btn btn-neutral" title="CDN"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="change-logs">
+<span id="to-api-v11-change-logs"></span><h1>Change Logs<a class="headerlink" href="#change-logs" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-logs">
+<span id="to-api-v11-change-logs-route"></span><h2>/api/1.1/logs<a class="headerlink" href="#api-1-1-logs" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/logs.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ticketNum</span></code></td>
+<td>string</td>
+<td>Optional field to cross reference with any bug tracking systems</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">level</span></code></td>
+<td>string</td>
+<td>Log categories for each entry, examples: ‘UICHANGE’, ‘OPER’, ‘APICHANGE’.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the Log</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">user</span></code></td>
+<td>string</td>
+<td>Current user who made the change that was logged</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the Log entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">message</span></code></td>
+<td>string</td>
+<td>Log detail about what occurred</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
+ <span class="p">},</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/logs/:days/days.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="27%" />
+<col width="46%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">days</span></code></td>
+<td>yes</td>
+<td>Number of days.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ticketNum</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">level</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">user</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">message</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/logs/newcount.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">newLogcount</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"newLogcount"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="deliveryservice.html" class="btn btn-neutral float-right" title="Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cdn.html" class="btn btn-neutral" title="CDN"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/deliveryservice.html b/docs/latest/api/v11/deliveryservice.html
new file mode 100644
index 0000000..02ec7b9
--- /dev/null
+++ b/docs/latest/api/v11/deliveryservice.html
@@ -0,0 +1,2370 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Delivery Service — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Hardware Info" href="hwinfo.html"/>
+ <link rel="prev" title="Change Logs" href="changelog.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Delivery Service</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/deliveryservice.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="hwinfo.html" class="btn btn-neutral float-right" title="Hardware Info">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="changelog.html" class="btn btn-neutral" title="Change Logs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="delivery-service">
+<span id="to-api-v11-ds"></span><h1>Delivery Service<a class="headerlink" href="#delivery-service" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-deliveryservices">
+<span id="to-api-v11-ds-route"></span><h2>/api/1.1/deliveryservices<a class="headerlink" href="#api-1-1-deliveryservices" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/deliveryservices</strong></p>
+<blockquote>
+<div><p>Retrieves all delivery services. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="5%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cacheurl</span></code></td>
+<td>string</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ccrDnsTtl</span></code></td>
+<td>string</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">checkPath</span></code></td>
+<td>string</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp</span></code></td>
+<td>string</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp6</span></code></td>
+<td>string</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassTtl</span></code></td>
+<td>string</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td>
+<td>string</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">edgeHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td>
+<td>string</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from USA</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td>
+<td>string</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td>
+<td>string</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">httpBypassFqdn</span></code></td>
+<td>string</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The deliveryservice id (database row number).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">infoUrl</span></code></td>
+<td>string</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<td>bool</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td>
+<td>string</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc2</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>setNumber</span></code></td>
+<td>string</td>
+<td>The set Number of the matchList.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>pattern</span></code></td>
+<td>string</td>
+<td>The regexp for the matchList.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maxDnsAnswers</span></code></td>
+<td>string</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td>
+<td>string</td>
+<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td>
+<td>string</td>
+<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">orgServerFqdn</span></code></td>
+<td>string</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regexRemap</span></code></td>
+<td>string</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">remapText</span></code></td>
+<td>string</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">signed</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">signingAlgorithm</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>“url_sig”: URL Sign token based auth is enabled for this deliveryservice.</li>
+<li>“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/deliveryservices/:id</strong></p>
+<blockquote>
+<div><p>Retrieves a specific delivery service. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="5%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cacheurl</span></code></td>
+<td>string</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ccrDnsTtl</span></code></td>
+<td>string</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">checkPath</span></code></td>
+<td>string</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp</span></code></td>
+<td>string</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp6</span></code></td>
+<td>string</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassTtl</span></code></td>
+<td>string</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td>
+<td>string</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">edgeHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td>
+<td>string</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from USA</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td>
+<td>string</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td>
+<td>string</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpBypassFqdn</span></code></td>
+<td>string</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The deliveryservice id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">infoUrl</span></code></td>
+<td>string</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<td>bool</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td>
+<td>string</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc2</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">matchList</span></code></td>
+<td>array</td>
+<td>Array of matchList hashes.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>setNumber</span></code></td>
+<td>string</td>
+<td>The set Number of the matchList.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>pattern</span></code></td>
+<td>string</td>
+<td>The regexp for the matchList.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maxDnsAnswers</span></code></td>
+<td>string</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td>
+<td>string</td>
+<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td>
+<td>string</td>
+<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">orgServerFqdn</span></code></td>
+<td>string</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regexRemap</span></code></td>
+<td>string</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">remapText</span></code></td>
+<td>string</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">signed</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">signingAlgorithm</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>“url_sig”: URL Sign token based auth is enabled for this deliveryservice.</li>
+<li>“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="health">
+<span id="to-api-v11-ds-health"></span><h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/deliveryservices/:id/state.json</strong></p>
+<blockquote>
+<div><p>Retrieves the failover state for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="12%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">failover</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>locations</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>destination</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>configured</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>enabled</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">enabled</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"failover"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
+ <span class="s2">"destination"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/deliveryservices/:id/health.json</strong></p>
+<blockquote>
+<div><p>Retrieves the health of all locations (cache groups) for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="11%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">totalOnline</span></code></td>
+<td>int</td>
+<td>Total number of online caches across all CDNs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">totalOffline</span></code></td>
+<td>int</td>
+<td>Total number of offline caches across all CDNs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>online</span></code></td>
+<td>int</td>
+<td>The number of online caches for the cache group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>offline</span></code></td>
+<td>int</td>
+<td>The number of offline caches for the cache
+group.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>Cache group name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/deliveryservices/:id/capacity.json</strong></p>
+<blockquote>
+<div><p>Retrieves the capacity percentages of a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>delivery service id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="10%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">availablePercent</span></code></td>
+<td>number</td>
+<td>The percentage of server capacity assigned to
+the delivery service that is available.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">unavailablePercent</span></code></td>
+<td>number</td>
+<td>The percentage of server capacity assigned to the
+delivery service that is unavailable.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">utilizedPercent</span></code></td>
+<td>number</td>
+<td>The percentage of server capacity assigned to the
+delivery service being used.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maintenancePercent</span></code></td>
+<td>number</td>
+<td>The percentage of server capacity assigned to the
+delivery service that is down for maintenance.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/deliveryservices/:id/routing.json</strong></p>
+<blockquote>
+<div><p>Retrieves the routing method percentages of a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>delivery service id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="5%" />
+<col width="83%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">staticRoute</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">miss</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geo</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">err</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice resulting in an error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cz</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF hit.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dsr</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the
+client to the overflow CDN.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="metrics">
+<span id="to-api-v11-ds-metrics"></span><h2>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/deliveryservices/:id/server_types/:type/metric_types/start_date/:start/end_date/:end.json</strong></p>
+<blockquote>
+<div><p>Retrieves detailed and summary metrics for MIDs or EDGEs for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="10%" />
+<col width="73%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>The delivery service id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">server_types</span></code></td>
+<td>yes</td>
+<td>EDGE or MID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">metric_types</span></code></td>
+<td>yes</td>
+<td>One of the following: “kbps”, “tps”, “tps_2xx”, “tps_3xx”, “tps_4xx”,
+“tps_5xx”.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">start_date</span></code></td>
+<td>yes</td>
+<td>UNIX time</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">end_date</span></code></td>
+<td>yes</td>
+<td>UNIX time</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="10%" />
+<col width="73%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
+<td>no</td>
+<td>Flag used to return only summary metrics</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="51%" />
+<col width="19%" />
+<col width="30%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>98thPercentile</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>min</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>max</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>5thPercentile</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>95thPercentile</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>median</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>mean</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>stddev</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>sum</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">data</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>item</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>time</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>value</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">label</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">988</span><span class="p">,</span>
+ <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">16589105.55958</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">3185442.975</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">17124754.257</span><span class="p">,</span>
+ <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">3901253.95445</span><span class="p">,</span>
+ <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">16013210.034</span><span class="p">,</span>
+ <span class="s2">"median"</span><span class="p">:</span> <span class="mf">8816895.576</span><span class="p">,</span>
+ <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">8995846.31741194</span><span class="p">,</span>
+ <span class="s2">"stddev"</span><span class="p">:</span> <span class="mf">3941169.83683573</span><span class="p">,</span>
+ <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">333296106.060112</span>
+ <span class="p">},</span>
+ <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">[</span>
+ <span class="mi">1414303200000</span><span class="p">,</span>
+ <span class="mf">12923518.466</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="mi">1414303500000</span><span class="p">,</span>
+ <span class="mf">12625139.65</span>
+ <span class="p">]</span>
+ <span class="p">],</span>
+ <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"MID Kbps"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="server">
+<span id="to-api-v11-ds-server"></span><h2>Server<a class="headerlink" href="#server" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/deliveryserviceserver.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: Yes</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">page</span></code></td>
+<td>no</td>
+<td>The page number for use in pagination.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">limit</span></code></td>
+<td>no</td>
+<td>For use in limiting the result set.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">server</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"orderby"</span><span class="p">:</span> <span class="s2">"deliveryservice"</span><span class="p">,</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:43"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"20"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:44"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="p">},</span>
+ <span class="p">],</span>
+ <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">2</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="ssl-keys">
+<span id="to-api-v11-ds-sslkeys"></span><h2>SSL Keys<a class="headerlink" href="#ssl-keys" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/deliveryservices/xmlId/:xmlid/sslkeys.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="18%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>no</td>
+<td>The version number to retrieve</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="5%" />
+<col width="84%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">crt</span></code></td>
+<td>string</td>
+<td>base64 encoded crt file for delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">csr</span></code></td>
+<td>string</td>
+<td>base64 encoded csr file for delivery service</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>base64 encoded private key file for delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">businessUnit</span></code></td>
+<td>string</td>
+<td>The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td>The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">organization</span></code></td>
+<td>string</td>
+<td>The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td>
+<td>string</td>
+<td>The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td>The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td>The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>The version of the certificate record in Riak</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
+ <span class="p">},</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/deliveryservices/hostname/:hostname/sslkeys.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="13%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td>
+<td>yes</td>
+<td>pristine hostname of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="18%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>no</td>
+<td>The version number to retrieve</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="5%" />
+<col width="84%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">crt</span></code></td>
+<td>string</td>
+<td>base64 encoded crt file for delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">csr</span></code></td>
+<td>string</td>
+<td>base64 encoded csr file for delivery service</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>base64 encoded private key file for delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">businessUnit</span></code></td>
+<td>string</td>
+<td>The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td>The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">organization</span></code></td>
+<td>string</td>
+<td>The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td>
+<td>string</td>
+<td>The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td>The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td>The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>The version of the certificate record in Riak</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
+ <span class="p">},</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/deliveryservices/xmlId/:xmlid/sslkeys/delete.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role Required: Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="18%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>no</td>
+<td>The version number to retrieve</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>success response</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted ssl keys for <xml_id>"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/deliveryservices/sslkeys/generate</strong></p>
+<blockquote>
+<div><p>Generates SSL crt, csr, and private key for a delivery service</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operations</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="13%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>xml_id of the delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>version of the keys being generated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td>
+<td>string</td>
+<td>the <em>pristine hostname</em> of the delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">org</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">unit</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN Engineering"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
+ <span class="p">},</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"Kabletown"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="36%" />
+<col width="21%" />
+<col width="44%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>response string</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully created ssl keys for ds-01"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/deliveryservices/sslkeys/add</strong></p>
+<blockquote>
+<div><p>Allows user to add SSL crt, csr, and private key for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operations</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="14%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>xml_id of the delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>version of the keys being generated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">csr</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">crt</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="36%" />
+<col width="21%" />
+<col width="44%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>response string</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully added ssl keys for ds-01"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/deliveryservices/request</strong></p>
+<blockquote>
+<div><p>Allows a user to send delivery service request details to a specified email address.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="5%" />
+<col width="7%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">emailTo</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>The email to which the delivery service request will be sent.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">details</span></code></td>
+<td>hash</td>
+<td>yes</td>
+<td>Parameters for the delivery service request.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>customer</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Name of the customer to associated with the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>deliveryProtocol</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Eg. http or http/https</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>routingType</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Eg. DNS or HTTP Redirect</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>serviceDesc</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>A description of the delivery service.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>peakBPSEstimate</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Used to manage cache efficiency and plan for capacity.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>peakTPSEstimate</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Used to manage cache efficiency and plan for capacity.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>maxLibrarySizeEstimate</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Used to manage cache efficiency and plan for capacity.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>originURL</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>The URL path to the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hasOriginDynamicRemap</span></code></td>
+<td>bool</td>
+<td>yes</td>
+<td>This is a feature which allows services to use multiple origin URLs for the same service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>originTestFile</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>A URL path to a test file available on the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hasOriginACLWhitelist</span></code></td>
+<td>bool</td>
+<td>yes</td>
+<td>Is access to your origin restricted using an access control list (ACL or whitelist) of Ips?</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>originHeaders</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Header values that must be passed to requests to your origin.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>otherOriginSecurity</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Other origin security measures that need to be considered for access.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>queryStringHandling</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>How to handle query strings that come with the request.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>rangeRequestHandling</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>How to handle range requests.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hasSignedURLs</span></code></td>
+<td>bool</td>
+<td>yes</td>
+<td>Are Urls signed?</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hasNegativeCachingCustomization</span></code></td>
+<td>bool</td>
+<td>yes</td>
+<td>Any customization required for negative caching?</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>negativeCachingCustomizationNote</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Negative caching customization instructions.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>serviceAliases</span></code></td>
+<td>array</td>
+<td>no</td>
+<td>Service aliases which will be used for this service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>rateLimitingGBPS</span></code></td>
+<td>int</td>
+<td>no</td>
+<td>Rate Limiting - Bandwidth (Gigabits per second)</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>rateLimitingTPS</span></code></td>
+<td>int</td>
+<td>no</td>
+<td>Rate Limiting - Transactions/Second</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>overflowService</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>An overflow point (URL or IP address) used if rate limits are met.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>headerRewriteEdge</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Headers can be added or altered at each layer of the CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>headerRewriteMid</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Headers can be added or altered at each layer of the CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>headerRewriteRedirectRouter</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Headers can be added or altered at each layer of the CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>notes</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Additional instructions to provide the delivery service provisioning team.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"emailTo"</span><span class="p">:</span> <span class="s2">"foo@bar.com"</span><span class="p">,</span>
+ <span class="s2">"details"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"customer"</span><span class="p">:</span> <span class="s2">"XYZ Corporation"</span><span class="p">,</span>
+ <span class="s2">"contentType"</span><span class="p">:</span> <span class="s2">"video-on-demand"</span><span class="p">,</span>
+ <span class="s2">"deliveryProtocol"</span><span class="p">:</span> <span class="s2">"http"</span><span class="p">,</span>
+ <span class="s2">"routingType"</span><span class="p">:</span> <span class="s2">"dns"</span><span class="p">,</span>
+ <span class="s2">"serviceDesc"</span><span class="p">:</span> <span class="s2">"service description goes here"</span><span class="p">,</span>
+ <span class="s2">"peakBPSEstimate"</span><span class="p">:</span> <span class="s2">"less-than-5-Gbps"</span><span class="p">,</span>
+ <span class="s2">"peakTPSEstimate"</span><span class="p">:</span> <span class="s2">"less-than-1000-TPS"</span><span class="p">,</span>
+ <span class="s2">"maxLibrarySizeEstimate"</span><span class="p">:</span> <span class="s2">"less-than-200-GB"</span><span class="p">,</span>
+ <span class="s2">"originURL"</span><span class="p">:</span> <span class="s2">"http://myorigin.com"</span><span class="p">,</span>
+ <span class="s2">"hasOriginDynamicRemap"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"originTestFile"</span><span class="p">:</span> <span class="s2">"http://myorigin.com/crossdomain.xml"</span><span class="p">,</span>
+ <span class="s2">"hasOriginACLWhitelist"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"originHeaders"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"otherOriginSecurity"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"queryStringHandling"</span><span class="p">:</span> <span class="s2">"ignore-in-cache-key-and-pass-up"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"range-requests-not-used"</span><span class="p">,</span>
+ <span class="s2">"hasSignedURLs"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"hasNegativeCachingCustomization"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"negativeCachingCustomizationNote"</span><span class="p">:</span> <span class="s2">"negative caching instructions"</span><span class="p">,</span>
+ <span class="s2">"serviceAliases"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://alias1.com"</span><span class="p">,</span>
+ <span class="s2">"http://alias2.com"</span>
+ <span class="p">],</span>
+ <span class="s2">"rateLimitingGBPS"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span>
+ <span class="s2">"rateLimitingTPS"</span><span class="p">:</span> <span class="mi">5000</span><span class="p">,</span>
+ <span class="s2">"overflowService"</span><span class="p">:</span> <span class="s2">"http://overflowcdn.com"</span><span class="p">,</span>
+ <span class="s2">"headerRewriteEdge"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"headerRewriteMid"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"headerRewriteRedirectRouter"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"notes"</span><span class="p">:</span> <span class="s2">""</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery Service request sent to foo@bar.com."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="hwinfo.html" class="btn btn-neutral float-right" title="Hardware Info">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="changelog.html" class="btn btn-neutral" title="Change Logs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/hwinfo.html b/docs/latest/api/v11/hwinfo.html
new file mode 100644
index 0000000..f63520c
--- /dev/null
+++ b/docs/latest/api/v11/hwinfo.html
@@ -0,0 +1,361 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Hardware Info — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Parameter" href="parameter.html"/>
+ <link rel="prev" title="Delivery Service" href="deliveryservice.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Hardware Info</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/hwinfo.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="parameter.html" class="btn btn-neutral float-right" title="Parameter">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="hardware-info">
+<span id="to-api-v11-hwinfo"></span><h1>Hardware Info<a class="headerlink" href="#hardware-info" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-hwinfo">
+<span id="to-api-v11-hwinfo-route"></span><h2>/api/1.1/hwinfo<a class="headerlink" href="#api-1-1-hwinfo" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/hwinfo.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="8%" />
+<col width="71%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">serverId</span></code></td>
+<td>string</td>
+<td>Local unique identifier for this specific server’s hardware info</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">serverHostName</span></code></td>
+<td>string</td>
+<td>Hostname for this specific server’s hardware info</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">val</span></code></td>
+<td>string</td>
+<td>Freeform value used to track anything about a server’s hardware info</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>Freeform description for this specific server’s hardware info</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span>
+ <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:0"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span>
+ <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:1"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="parameter.html" class="btn btn-neutral float-right" title="Parameter">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/index.html b/docs/latest/api/v11/index.html
new file mode 100644
index 0000000..a0aa22a
--- /dev/null
+++ b/docs/latest/api/v11/index.html
@@ -0,0 +1,319 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>API 1.1 Reference — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="APIs" href="../index.html"/>
+ <link rel="next" title="ASN" href="asn.html"/>
+ <link rel="prev" title="API Routes" href="../routes.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li>API 1.1 Reference</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/index.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="asn.html" class="btn btn-neutral float-right" title="ASN">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../routes.html" class="btn btn-neutral" title="API Routes"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="api-1-1-reference">
+<h1>API 1.1 Reference<a class="headerlink" href="#api-1-1-reference" title="Permalink to this headline">¶</a></h1>
+<p>Traffic Ops v1.1 API Documentation</p>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="asn.html">ASN</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cachegroup.html">Cache Group</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cdn.html">CDN</a></li>
+<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Logs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="deliveryservice.html">Delivery Service</a></li>
+<li class="toctree-l1"><a class="reference internal" href="hwinfo.html">Hardware Info</a></li>
+<li class="toctree-l1"><a class="reference internal" href="parameter.html">Parameter</a></li>
+<li class="toctree-l1"><a class="reference internal" href="phys_location.html">Physical Location</a></li>
+<li class="toctree-l1"><a class="reference internal" href="profile.html">Profiles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="region.html">Regions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="role.html">Roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="server.html">Server</a></li>
+<li class="toctree-l1"><a class="reference internal" href="static_dns.html">Static DNS Entries</a></li>
+<li class="toctree-l1"><a class="reference internal" href="status.html">Status</a></li>
+<li class="toctree-l1"><a class="reference internal" href="system.html">System</a></li>
+<li class="toctree-l1"><a class="reference internal" href="to_extension.html">TO Extensions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="type.html">Types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user.html">Users</a></li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="asn.html" class="btn btn-neutral float-right" title="ASN">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../routes.html" class="btn btn-neutral" title="API Routes"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/parameter.html b/docs/latest/api/v11/parameter.html
new file mode 100644
index 0000000..90be4b4
--- /dev/null
+++ b/docs/latest/api/v11/parameter.html
@@ -0,0 +1,462 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Parameter — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Physical Location" href="phys_location.html"/>
+ <link rel="prev" title="Hardware Info" href="hwinfo.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Parameter</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/parameter.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="phys_location.html" class="btn btn-neutral float-right" title="Physical Location">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="parameter">
+<span id="to-api-v11-parameter"></span><h1>Parameter<a class="headerlink" href="#parameter" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-parameters">
+<span id="to-api-v11-parameters-route"></span><h2>/api/1.1/parameters<a class="headerlink" href="#api-1-1-parameters" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/parameters.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">last_updated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/parameters/profile/:name.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="44%" />
+<col width="24%" />
+<col width="32%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile_name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">last_updated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="phys_location.html" class="btn btn-neutral float-right" title="Physical Location">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/phys_location.html b/docs/latest/api/v11/phys_location.html
new file mode 100644
index 0000000..1c6adf9
--- /dev/null
+++ b/docs/latest/api/v11/phys_location.html
@@ -0,0 +1,988 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Physical Location — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Profiles" href="profile.html"/>
+ <link rel="prev" title="Parameter" href="parameter.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Physical Location</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/phys_location.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="profile.html" class="btn btn-neutral float-right" title="Profiles">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="parameter.html" class="btn btn-neutral" title="Parameter"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="physical-location">
+<span id="to-api-v11-phys-loc"></span><h1>Physical Location<a class="headerlink" href="#physical-location" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-phys-locations">
+<span id="to-api-v11-phys-loc-route"></span><h2>/api/1.1/phys_locations<a class="headerlink" href="#api-1-1-phys-locations" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/phys_locations</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/phys_locations/trimmed.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="11%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/phys_locations/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Physical location ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>PUT /api/1.1/phys_locations/:id</strong></dt>
+<dd><p class="first">Update a physical location</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Physical location id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>yes</td>
+<td>Physical location address.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td>Physical location city.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td>Physical location comments.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>no</td>
+<td>Physical location email.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>Physical location name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td>Physical location phone.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Physical location point of contact.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td>
+<td>no</td>
+<td>Physical location region ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>Physical location short name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td>Physical location state.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td>Physical location zip.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Physical location update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.1/regions/:region_name/phys_locations</strong></dt>
+<dd><p class="first">Create physical location.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p>region_name: the name of the region to create physical location into.</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="16%" />
+<col width="56%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">region_name</span></code></td>
+<td>yes</td>
+<td>The name of the physical location</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the location</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>The short name of the location</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Point of contact</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span> <span class="p">:</span> <span class="s2">"my physical location1"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span>
+ <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="11%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The id of the physical location created.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the location</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>The short name of the location</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionName</span></code></td>
+<td>string</td>
+<td>The region name the physical location belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td>Point of contact</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span>
+ <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span>
+ <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span>
+ <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span>
+ <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span>
+ <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span>
+ <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span>
+ <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="profile.html" class="btn btn-neutral float-right" title="Profiles">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="parameter.html" class="btn btn-neutral" title="Parameter"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/profile.html b/docs/latest/api/v11/profile.html
new file mode 100644
index 0000000..dbeb3f8
--- /dev/null
+++ b/docs/latest/api/v11/profile.html
@@ -0,0 +1,471 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Profiles — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Regions" href="region.html"/>
+ <link rel="prev" title="Physical Location" href="phys_location.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Profiles</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/profile.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="profiles">
+<span id="to-api-v11-profile"></span><h1>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-profiles">
+<span id="to-api-v11-profiles-route"></span><h2>/api/1.1/profiles<a class="headerlink" href="#api-1-1-profiles" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/profiles</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>array</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/profiles/trimmed</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/profiles/:id</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="16%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>The ID of the profile.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>array</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/region.html b/docs/latest/api/v11/region.html
new file mode 100644
index 0000000..6d9dd5b
--- /dev/null
+++ b/docs/latest/api/v11/region.html
@@ -0,0 +1,649 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Regions — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Roles" href="role.html"/>
+ <link rel="prev" title="Profiles" href="profile.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Regions</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/region.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="role.html" class="btn btn-neutral float-right" title="Roles">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="profile.html" class="btn btn-neutral" title="Profiles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="regions">
+<span id="to-api-v11-region"></span><h1>Regions<a class="headerlink" href="#regions" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-regions">
+<span id="to-api-v11-regions-route"></span><h2>/api/1.1/regions<a class="headerlink" href="#api-1-1-regions" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/regions</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Region ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"7"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/regions/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Region id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Region ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<dl class="docutils">
+<dt><strong>PUT /api/1.1/regions/:id</strong></dt>
+<dd><p class="first">Update a region</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Region id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="19%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the region</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">division</span></code></td>
+<td>yes</td>
+<td>The division Id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">division</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Region update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<dl class="docutils">
+<dt><strong>POST /api/1.1/divisions/:division_name/regions</strong></dt>
+<dd><p class="first">Create Region</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p>division_name - The name of division to create new region into.</p>
+<p>** Request Route Parameters**</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">division_name</span></code></td>
+<td>yes</td>
+<td>The name of division will create new region in</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="14%" />
+<col width="59%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the region</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="11%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>name of region created</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>id of region created</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>the division name the region belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">divisionId</span></code></td>
+<td>string</td>
+<td>the id of division the region belongs to.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'divisionName'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
+ <span class="s1">'divsionId'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'19'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="role.html" class="btn btn-neutral float-right" title="Roles">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="profile.html" class="btn btn-neutral" title="Profiles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/role.html b/docs/latest/api/v11/role.html
new file mode 100644
index 0000000..2da2165
--- /dev/null
+++ b/docs/latest/api/v11/role.html
@@ -0,0 +1,351 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Roles — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Server" href="server.html"/>
+ <link rel="prev" title="Regions" href="region.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Roles</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/role.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="server.html" class="btn btn-neutral float-right" title="Server">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="region.html" class="btn btn-neutral" title="Regions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="roles">
+<span id="to-api-v11-roles"></span><h1>Roles<a class="headerlink" href="#roles" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-roles">
+<span id="to-api-v11-roles-route"></span><h2>/api/1.1/roles<a class="headerlink" href="#api-1-1-roles" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/roles.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">privLevel</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"read-only"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"privLevel"</span><span class="p">:</span> <span class="s2">"10"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"read-only user"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="server.html" class="btn btn-neutral float-right" title="Server">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="region.html" class="btn btn-neutral" title="Regions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/server.html b/docs/latest/api/v11/server.html
new file mode 100644
index 0000000..b0e6c4a
--- /dev/null
+++ b/docs/latest/api/v11/server.html
@@ -0,0 +1,1247 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Server — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Static DNS Entries" href="static_dns.html"/>
+ <link rel="prev" title="Roles" href="role.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Server</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/server.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="static_dns.html" class="btn btn-neutral float-right" title="Static DNS Entries">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="role.html" class="btn btn-neutral" title="Roles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="server">
+<span id="to-api-v11-server"></span><h1>Server<a class="headerlink" href="#server" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-servers">
+<span id="to-api-v11-servers-route"></span><h2>/api/1.1/servers<a class="headerlink" href="#api-1-1-servers" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/servers</strong></p>
+<blockquote>
+<div><p>Retrieves properties of CDN servers.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="13%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>no</td>
+<td>Used to filter servers by delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>no</td>
+<td>Used to filter servers by status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>no</td>
+<td>Used to filter servers by type.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/servers/:id</strong></p>
+<blockquote>
+<div><p>Retrieves properties of a CDN server by server ID.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Server id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/servers/summary</strong></p>
+<blockquote>
+<div><p>Retrieves a count of CDN servers by type.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="12%" />
+<col width="9%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">count</span></code></td>
+<td>int</td>
+<td>The number of servers of this type in this instance of Traffic Ops.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CCR"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">55</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"MID"</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">18</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"INFLUXDB"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"RASCAL"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/servers/hostname/:name/details</strong></p>
+<blockquote>
+<div><p>Retrieves the details of a server.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="19%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The host name part of the cache.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="6%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryservices</span></code></td>
+<td>array</td>
+<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v11-ds"><span class="std std-ref">Delivery Service</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">hardwareInfo</span></code></td>
+<td>hash</td>
+<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v11-hwinfo"><span class="std std-ref">Hardware Info</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time/Date of the last update for this server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The default HTTPS port on which the main application listens (443 for a cache in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">xmppId</span></code></td>
+<td>string</td>
+<td>Deprecated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmppPasswd</span></code></td>
+<td>string</td>
+<td>Deprecated.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"4"</span>
+ <span class="p">],</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s2">"YS08"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Model"</span><span class="p">:</span> <span class="s2">"PowerEdge R720xd"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s2">"4217A5"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Manufacturer"</span><span class="p">:</span> <span class="s2">"Dell Inc."</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"SysMemTotalSize"</span><span class="p">:</span> <span class="s2">"196608"</span><span class="p">,</span>
+ <span class="s2">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s2">"24"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s2">"13.5.7"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s2">"1.00"</span><span class="p">,</span>
+ <span class="s2">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s2">"7.0.0.29"</span><span class="p">,</span>
+ <span class="s2">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s2">"1.57.57"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"ServiceTag"</span><span class="p">:</span> <span class="s2">"D6XPDV1"</span><span class="p">,</span>
+ <span class="s2">"PowerState"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s2">"D903"</span><span class="p">,</span>
+ <span class="s2">"BIOS"</span><span class="p">:</span> <span class="s2">"1.3.6"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"System CPLD"</span><span class="p">:</span> <span class="s2">"1.0.3"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"PERC H710P Mini"</span><span class="p">:</span> <span class="s2">"21.0.2-0001"</span><span class="p">,</span>
+ <span class="s2">"PowerCap"</span><span class="p">:</span> <span class="s2">"689"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s2">"1.07"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s2">"7.2.20"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s2">"D1S2"</span>
+ <span class="p">},</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"xmppId"</span><span class="p">:</span> <span class="s2">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
+ <span class="s2">"xmppPasswd"</span><span class="p">:</span> <span class="s2">"X"</span>
+
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/servercheck</strong></p>
+<blockquote>
+<div><p>Post a server check result to the serverchecks table.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="55%" />
+<col width="20%" />
+<col width="25%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">host_name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">servercheck_short_name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"host_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">""</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Response</span> <span class="n">Example</span><span class="p">:</span>
+
+<span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server Check was successfully updated."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="static_dns.html" class="btn btn-neutral float-right" title="Static DNS Entries">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="role.html" class="btn btn-neutral" title="Roles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/static_dns.html b/docs/latest/api/v11/static_dns.html
new file mode 100644
index 0000000..3fca230
--- /dev/null
+++ b/docs/latest/api/v11/static_dns.html
@@ -0,0 +1,361 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Static DNS Entries — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Status" href="status.html"/>
+ <link rel="prev" title="Server" href="server.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Static DNS Entries</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/static_dns.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="status.html" class="btn btn-neutral float-right" title="Status">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="server.html" class="btn btn-neutral" title="Server"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="static-dns-entries">
+<span id="to-api-v11-dns"></span><h1>Static DNS Entries<a class="headerlink" href="#static-dns-entries" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-staticdnsentries">
+<span id="to-api-v11-static-dns-route"></span><h2>/api/1.1/staticdnsentries<a class="headerlink" href="#api-1-1-staticdnsentries" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/staticdnsentries.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="12%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">host</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"foo-ds"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CNAME_RECORD"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"bar.foo.baz.tv."</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span><span class="p">,</span>
+ <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"mm"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="status.html" class="btn btn-neutral float-right" title="Status">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="server.html" class="btn btn-neutral" title="Server"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/status.html b/docs/latest/api/v11/status.html
new file mode 100644
index 0000000..da96865
--- /dev/null
+++ b/docs/latest/api/v11/status.html
@@ -0,0 +1,447 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Status — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="System" href="system.html"/>
+ <link rel="prev" title="Static DNS Entries" href="static_dns.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Status</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/status.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="system.html" class="btn btn-neutral float-right" title="System">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="static_dns.html" class="btn btn-neutral" title="Static DNS Entries"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="status">
+<span id="to-api-v11-status"></span><h1>Status<a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-statuses">
+<span id="to-api-v11-statuses-route"></span><h2>/api/1.1/statuses<a class="headerlink" href="#api-1-1-statuses" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/statuses</strong></p>
+<blockquote>
+<div><p>Retrieves a list of the server status codes available.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="8%" />
+<col width="76%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The id with which Traffic Ops stores this status, and references it internally</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The string equivalent of the status</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>A short description of the status</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_IGNORE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"OFFLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"REPORTED"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/statuses/:id</strong></p>
+<blockquote>
+<div><p>Retrieves a server status by ID.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Status id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="8%" />
+<col width="76%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The id with which Traffic Ops stores this status, and references it internally</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The string equivalent of the status</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>A short description of the status</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="system.html" class="btn btn-neutral float-right" title="System">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="static_dns.html" class="btn btn-neutral" title="Static DNS Entries"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/system.html b/docs/latest/api/v11/system.html
new file mode 100644
index 0000000..460811a
--- /dev/null
+++ b/docs/latest/api/v11/system.html
@@ -0,0 +1,379 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>System — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="TO Extensions" href="to_extension.html"/>
+ <link rel="prev" title="Status" href="status.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>System</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/system.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="to_extension.html" class="btn btn-neutral float-right" title="TO Extensions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="status.html" class="btn btn-neutral" title="Status"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="system">
+<span id="to-api-v11-sys"></span><h1>System<a class="headerlink" href="#system" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-system">
+<span id="to-api-v11-sys-route"></span><h2>/api/1.1/system<a class="headerlink" href="#api-1-1-system" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/system/info.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="5%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Key</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameters</span></code></td>
+<td>hash</td>
+<td>This is a hash with the parameter names that describe the Traffic Ops installation as keys.
+These are all the parameters in the <code class="docutils literal notranslate"><span class="pre">GLOBAL</span></code> profile.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tm.toolname</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Ops tool. Usually “Traffic Ops”. Used in the About screen and in the comments headers of the files generated
+(<code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">DO</span> <span class="pre">NOT</span> <span class="pre">EDIT</span> <span class="pre">-</span> <span class="pre">Generated</span> <span class="pre">for</span> <span class="pre">atsec-lax-04</span> <span class="pre">by</span> <span class="pre">Traffic</span> <span class="pre">Ops</span> <span class="pre">(https://traffops.kabletown.net/)</span> <span class="pre">on</span> <span class="pre">Fri</span> <span class="pre">Mar</span>  <span class="pre">6</span> <span class="pre">05:15:15</span> <span class="pre">UTC</span> <span class="pre">2015</span></code>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.instance_name</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>traffic_rtr_fwd_proxy</span></code></td>
+<td>string</td>
+<td>When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through.
+This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting
+this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to
+set this parameter on a production system.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.url</span></code></td>
+<td>string</td>
+<td>The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated
+(<code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">DO</span> <span class="pre">NOT</span> <span class="pre">EDIT</span> <span class="pre">-</span> <span class="pre">Generated</span> <span class="pre">for</span> <span class="pre">atsec-lax-04</span> <span class="pre">by</span> <span class="pre">Traffic</span> <span class="pre">Ops</span> <span class="pre">(https://traffops.kabletown.net/)</span> <span class="pre">on</span> <span class="pre">Fri</span> <span class="pre">Mar</span>  <span class="pre">6</span> <span class="pre">05:15:15</span> <span class="pre">UTC</span> <span class="pre">2015</span></code>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>traffic_mon_fwd_proxy</span></code></td>
+<td>string</td>
+<td>When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through.
+This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting
+this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to
+set this parameter on a production system.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.logourl</span></code></td>
+<td>string</td>
+<td>This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tm.infourl</span></code></td>
+<td>string</td>
+<td>This is the “for more information go here” URL, which is visible in the About page.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"tm.toolname"</span><span class="p">:</span> <span class="s2">"Traffic Ops"</span><span class="p">,</span>
+ <span class="s2">"tm.infourl"</span><span class="p">:</span> <span class="s2">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
+ <span class="s2">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"tm.logourl"</span><span class="p">:</span> <span class="s2">"\/images\/tc_logo.png"</span><span class="p">,</span>
+ <span class="s2">"tm.url"</span><span class="p">:</span> <span class="s2">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
+ <span class="s2">"tm.instance_name"</span><span class="p">:</span> <span class="s2">"Kabletown CDN"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="to_extension.html" class="btn btn-neutral float-right" title="TO Extensions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="status.html" class="btn btn-neutral" title="Status"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/to_extension.html b/docs/latest/api/v11/to_extension.html
new file mode 100644
index 0000000..329ac88
--- /dev/null
+++ b/docs/latest/api/v11/to_extension.html
@@ -0,0 +1,582 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>TO Extensions — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Types" href="type.html"/>
+ <link rel="prev" title="System" href="system.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>TO Extensions</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/to_extension.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="type.html" class="btn btn-neutral float-right" title="Types">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="system.html" class="btn btn-neutral" title="System"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="to-extensions">
+<span id="to-api-v11-ext"></span><h1>TO Extensions<a class="headerlink" href="#to-extensions" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-to-extensions">
+<span id="to-api-v11-ext-route"></span><h2>/api/1.1/to_extensions<a class="headerlink" href="#api-1-1-to-extensions" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/to_extensions.json</strong></p>
+<p>Retrieves the list of extensions.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="10%" />
+<col width="56%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">script_file</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">info_url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">additional_config_json</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">isactive</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">servercheck_short_name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ilo_ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">9</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }"</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"10G_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }"</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"10G"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/to_extensions</strong></p>
+<blockquote>
+<div><p>Creates a Traffic Ops extension.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="10%" />
+<col width="56%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">info_url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">script_file</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">isactive</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">additional_config_json</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">servercheck_short_name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="s2">"info_url"</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="s2">"script_file"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="s2">"isactive"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"additional_config_json"</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="15%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Check Extension loaded."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/to_extensions/:id/delete</strong></p>
+<blockquote>
+<div><p>Deletes a Traffic Ops extension.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="29%" />
+<col width="49%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>TO extension id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="15%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Extension deleted."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="type.html" class="btn btn-neutral float-right" title="Types">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="system.html" class="btn btn-neutral" title="System"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/type.html b/docs/latest/api/v11/type.html
new file mode 100644
index 0000000..4e3d692
--- /dev/null
+++ b/docs/latest/api/v11/type.html
@@ -0,0 +1,501 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Types — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Users" href="user.html"/>
+ <link rel="prev" title="TO Extensions" href="to_extension.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Types</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/type.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="user.html" class="btn btn-neutral float-right" title="Users">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="to_extension.html" class="btn btn-neutral" title="TO Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="types">
+<span id="to-api-v11-type"></span><h1>Types<a class="headerlink" href="#types" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-types">
+<span id="to-api-v11-types-route"></span><h2>/api/1.1/types<a class="headerlink" href="#api-1-1-types" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/types</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">useInTable</span></code></td>
+<td>no</td>
+<td>Filter types by the table in which they apply</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">useInTable</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/types/trimmed</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ACTIVE_DIRECTORY"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"A_RECORD"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/types/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Type ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">useInTable</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="user.html" class="btn btn-neutral float-right" title="Users">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="to_extension.html" class="btn btn-neutral" title="TO Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v11/user.html b/docs/latest/api/v11/user.html
new file mode 100644
index 0000000..fd81516
--- /dev/null
+++ b/docs/latest/api/v11/user.html
@@ -0,0 +1,1499 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Users — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="API 1.2 Reference" href="../v12/index.html"/>
+ <link rel="prev" title="Types" href="type.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Users</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/user.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../v12/index.html" class="btn btn-neutral float-right" title="API 1.2 Reference">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="type.html" class="btn btn-neutral" title="Types"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="users">
+<span id="to-api-v11-users"></span><h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-users">
+<span id="to-api-v11-users-route"></span><h2>/api/1.1/users<a class="headerlink" href="#api-1-1-users" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/users</strong></p>
+<blockquote>
+<div><p>Retrieves all users.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">registrationSent</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">users</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/users/:id</strong></p>
+<blockquote>
+<div><p>Retrieves user by ID.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>User id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">registrationSent</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/user/current</strong></p>
+<blockquote>
+<div><p>Retrieves the profile for the authenticated user.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">localUser</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"50"</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Callahan"</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/user/current/update</strong></p>
+<blockquote>
+<div><p>Updates the date for the authenticated user.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">localUser</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"UserProfile was successfully updated."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/user/current/jobs.json</strong></p>
+<blockquote>
+<div><p>Retrieves the user’s list of jobs.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="16%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keyword</span></code></td>
+<td>no</td>
+<td>PURGE</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keyword</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">objectName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">assetUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">assetType</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsXmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameters</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">enteredTime</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">objectType</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">agent</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">startTime</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
+ <span class="s2">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"assetType"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"PENDING"</span><span class="p">,</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"dsXmlId"</span><span class="p">:</span> <span class="s2">"ds-xml-id"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"peewee"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:56h"</span><span class="p">,</span>
+ <span class="s2">"enteredTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 18:00:16"</span><span class="p">,</span>
+ <span class="s2">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"agent"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 10:45:38"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST/api/1.1/user/current/jobs</strong></p>
+<p>Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the <em>regex_revalidate</em> ATS plugin. This forces a <em>revalidation</em> of the content, rather than a new get.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">This method forces a HTTP <em>revalidation</em> of the content, and not a new <em>GET</em> - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a <code class="docutils literal notranslate"><span class="pre">200</span> <span class="pre">OK</span></code> or <code class="docutils literal notranslate"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> as applicable.</p>
+</div>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Yes</p>
+<blockquote>
+<div><p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>string</td>
+<td>Unique Delivery Service ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regex</span></code></td>
+<td>string</td>
+<td>Path Regex this should be a
+<a class="reference external" href="http://www.pcre.org/">PCRE</a> compatible
+regular expression for the path to match for
+forcing the revalidation. Be careful to only
+match on the content you need to remove -
+revalidation is an expensive operation for
+many origins, and a simple <code class="docutils literal notranslate"><span class="pre">/.*</span></code> can cause
+an overload condition of the origin.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">startTime</span></code></td>
+<td>string</td>
+<td>Start Time is the time when the revalidation
+rule will be made active. Populate
+with the current time to schedule ASAP.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>int</td>
+<td>Time To Live is how long the revalidation rule
+will be active for in hours. It usually makes
+sense to make this the same as the
+<code class="docutils literal notranslate"><span class="pre">Cache-Control</span></code> header from the origin which
+sets the object time to live in cache
+(by <code class="docutils literal notranslate"><span class="pre">max-age</span></code> or <code class="docutils literal notranslate"><span class="pre">Expires</span></code>). Entering a
+longer TTL here will make the caches do
+unnecessary work.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"regex"</span><span class="p">:</span> <span class="s2">"/path/to/content.jpg"</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-27 11:08:37"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully created purge job for: ."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/user/login</strong></p>
+<blockquote>
+<div><p>Authentication of a user using username and password. Traffic Ops will send back a session cookie.</p>
+<p>Authentication Required: No</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">u</span></code></td>
+<td>string</td>
+<td>username</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">p</span></code></td>
+<td>string</td>
+<td>password</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"u"</span><span class="p">:</span> <span class="s2">"username"</span><span class="p">,</span>
+ <span class="s2">"p"</span><span class="p">:</span> <span class="s2">"password"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully logged in."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/user/:id/deliveryservices/available.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"90"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img-secure"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"280"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/user/login/token</strong></p>
+<blockquote>
+<div><p>Authentication of a user using a token.</p>
+<p>Authentication Required: No</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">t</span></code></td>
+<td>string</td>
+<td>token-value</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="38%" />
+<col width="24%" />
+<col width="38%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Unauthorized, please log in."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/user/logout</strong></p>
+<blockquote>
+<div><p>User logout. Invalidates the session cookie.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><ul class="first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">level</span></code></li>
+</ul>
+</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><ul class="first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">text</span></code></li>
+</ul>
+</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"You are logged out."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/user/reset_password</strong></p>
+<blockquote>
+<div><p>Reset user password.</p>
+<p>Authentication Required: No</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td>The email address of the user to initiate
+password reset.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><ul class="first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">level</span></code></li>
+</ul>
+</td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><ul class="first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">text</span></code></li>
+</ul>
+</td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully sent password reset to email 'email@email.com'"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../v12/index.html" class="btn btn-neutral float-right" title="API 1.2 Reference">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="type.html" class="btn btn-neutral" title="Types"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/api_capability.html b/docs/latest/api/v12/api_capability.html
new file mode 100644
index 0000000..8b1169d
--- /dev/null
+++ b/docs/latest/api/v12/api_capability.html
@@ -0,0 +1,798 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>API-Capabilities — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="ASN" href="asn.html"/>
+ <link rel="prev" title="API 1.2 Reference" href="index.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>API-Capabilities</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/api_capability.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="asn.html" class="btn btn-neutral float-right" title="ASN">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="index.html" class="btn btn-neutral" title="API 1.2 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="api-capabilities">
+<span id="to-api-v12-api-capability"></span><h1>API-Capabilities<a class="headerlink" href="#api-capabilities" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-api-capabilities">
+<span id="to-api-v12-api-capability-route"></span><h2>/api/1.2/api_capabilities<a class="headerlink" href="#api-1-2-api-capabilities" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/api_capabilities</strong></p>
+<blockquote>
+<div><p>Get all API-capability mappings.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="14%" />
+<col width="11%" />
+<col width="51%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">capability</span></code></td>
+<td>no</td>
+<td>string</td>
+<td>Capability name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="10%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Mapping id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpMethod</span></code></td>
+<td>enum</td>
+<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">httpRoute</span></code></td>
+<td>string</td>
+<td>API route.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">capability</span></code></td>
+<td>string</td>
+<td>Capability name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span>
+ <span class="s2">"httpRoute"</span><span class="p">:</span> <span class="s2">"/api/*/asns"</span><span class="p">,</span>
+ <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"asn-read"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"7"</span><span class="p">,</span>
+ <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span>
+ <span class="s2">"httpRoute"</span><span class="p">:</span> <span class="s2">"/api/*/asns/*"</span><span class="p">,</span>
+ <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"asn-read"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/api_capabilities/:id</strong></p>
+<blockquote>
+<div><p>Get an API-capability mapping by id.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="15%" />
+<col width="10%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>int</td>
+<td>Mapping id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="10%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Mapping id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpMethod</span></code></td>
+<td>enum</td>
+<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">httpRoute</span></code></td>
+<td>string</td>
+<td>API route.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">capability</span></code></td>
+<td>string</td>
+<td>Capability name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span>
+ <span class="s2">"httpRoute"</span><span class="p">:</span> <span class="s2">"/api/*/asns"</span><span class="p">,</span>
+ <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"asn-read"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/api_capabilities</strong></p>
+<blockquote>
+<div><p>Create an API-capability mapping.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="12%" />
+<col width="10%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">httpMethod</span></code></td>
+<td>yes</td>
+<td>enum</td>
+<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpRoute</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>API route.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">capability</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>Capability name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"POST"</span><span class="p">,</span>
+ <span class="s2">"httpRoute"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span>
+ <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-write"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>hash</td>
+<td>The details of the creation, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td>
+<td>int</td>
+<td>Mapping id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>httpMethod</span></code></td>
+<td>enum</td>
+<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>httpRoute</span></code></td>
+<td>string</td>
+<td>API route.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>capability</span></code></td>
+<td>string</td>
+<td>Capability name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"POST"</span><span class="p">,</span>
+ <span class="s2">"httpRoute"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span>
+ <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-write"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"API-capability mapping was created."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/api_capabilities/{:id}</strong></p>
+<blockquote>
+<div><p>Edit an API-capability mapping.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="11%" />
+<col width="51%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>Mapping id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="10%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">httpMethod</span></code></td>
+<td>enum</td>
+<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpRoute</span></code></td>
+<td>string</td>
+<td>API route.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">capability</span></code></td>
+<td>string</td>
+<td>Capability name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span>
+ <span class="s2">"httpRoute"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span>
+ <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-read"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>hash</td>
+<td>The details of the creation, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td>
+<td>int</td>
+<td>Mapping id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>httpMethod</span></code></td>
+<td>enum</td>
+<td>One of: ‘GET’, ‘POST’, ‘PUT’, ‘PATCH’, ‘DELETE’.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>httpRoute</span></code></td>
+<td>string</td>
+<td>API route.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>capability</span></code></td>
+<td>string</td>
+<td>Capability name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"httpMethod"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span>
+ <span class="s2">"httpRoute"</span><span class="p">:</span> <span class="s2">"/api/*/cdns"</span><span class="p">,</span>
+ <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"cdn-read"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"API-capability mapping was updated."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/api_capabilities/{:id}</strong></p>
+<blockquote>
+<div><p>Delete a capability.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="11%" />
+<col width="51%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>Mapping id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"API-capability mapping deleted."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="asn.html" class="btn btn-neutral float-right" title="ASN">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="index.html" class="btn btn-neutral" title="API 1.2 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/asn.html b/docs/latest/api/v12/asn.html
new file mode 100644
index 0000000..1718065
--- /dev/null
+++ b/docs/latest/api/v12/asn.html
@@ -0,0 +1,586 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>ASN — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Cache" href="cache.html"/>
+ <link rel="prev" title="API-Capabilities" href="api_capability.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>ASN</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/asn.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cache.html" class="btn btn-neutral float-right" title="Cache">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="api_capability.html" class="btn btn-neutral" title="API-Capabilities"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="asn">
+<span id="to-api-v12-asn"></span><h1>ASN<a class="headerlink" href="#asn" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-asns">
+<span id="to-api-v12-asns-route"></span><h2>/api/1.2/asns<a class="headerlink" href="#api-1-2-asns" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/asns</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="13%" />
+<col width="59%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>no</td>
+<td>Filter ASNs by cache group ID</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the ASN</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">asn</span></code></td>
+<td>string</td>
+<td>Autonomous System Numbers per APNIC for identifying a service provider.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Related cachegroup name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>Related cachegroup id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/asns/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>ASN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the ASN</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">asn</span></code></td>
+<td>string</td>
+<td>Autonomous System Numbers per APNIC for identifying a service provider.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Related cachegroup name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>Related cachegroup id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/asns/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to edit an ASN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>ASN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">asn</span></code></td>
+<td>string</td>
+<td>ASN</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cachegroup the ASN belongs to</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>hash</td>
+<td>The details of the update, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td>
+<td>int</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>dnssecEnabled</span></code></td>
+<td>string</td>
+<td>Whether dnssec is enabled.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
+ <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"cdn was updated."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cache.html" class="btn btn-neutral float-right" title="Cache">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="api_capability.html" class="btn btn-neutral" title="API-Capabilities"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/cache.html b/docs/latest/api/v12/cache.html
new file mode 100644
index 0000000..fad4dbc
--- /dev/null
+++ b/docs/latest/api/v12/cache.html
@@ -0,0 +1,385 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Cache — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Cache Group" href="cachegroup.html"/>
+ <link rel="prev" title="ASN" href="asn.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Cache</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/cache.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cachegroup.html" class="btn btn-neutral float-right" title="Cache Group">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="asn.html" class="btn btn-neutral" title="ASN"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="cache">
+<span id="to-api-v12-cache"></span><h1>Cache<a class="headerlink" href="#cache" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-caches-stats">
+<span id="to-api-v12-cache-route"></span><h2>/api/1.2/caches/stats<a class="headerlink" href="#api-1-2-caches-stats" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/caches/stats</strong></p>
+<blockquote>
+<div><p>Retrieves cache stats from Traffic Monitor. Also includes rows for aggregates.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="11%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The profile of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group of the cache.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td>
+<td>string</td>
+<td>The hostname of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip</span></code></td>
+<td>string</td>
+<td>The IP address of the cache.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The status of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">healthy</span></code></td>
+<td>string</td>
+<td>Has Traffic Monitor marked the cache as healthy or unhealthy?</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">connections</span></code></td>
+<td>string</td>
+<td>Cache connections</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">kbps</span></code></td>
+<td>string</td>
+<td>Cache kbps out</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"ip"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"healthy"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"connections"</span><span class="p">:</span> <span class="mi">934424</span><span class="p">,</span>
+ <span class="s2">"kbps"</span><span class="p">:</span> <span class="mi">618631875</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_FOO_721-ATS621-45"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-nm-albuquerque"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foo-bar-alb-01"</span><span class="p">,</span>
+ <span class="s2">"ip"</span><span class="p">:</span> <span class="s2">"2.2.2.2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"REPORTED"</span><span class="p">,</span>
+ <span class="s2">"healthy"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"connections"</span><span class="p">:</span> <span class="mi">373</span><span class="p">,</span>
+ <span class="s2">"kbps"</span><span class="p">:</span> <span class="mi">390136</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cachegroup.html" class="btn btn-neutral float-right" title="Cache Group">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="asn.html" class="btn btn-neutral" title="ASN"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/cache_stats.html b/docs/latest/api/v12/cache_stats.html
new file mode 100644
index 0000000..b476a72
--- /dev/null
+++ b/docs/latest/api/v12/cache_stats.html
@@ -0,0 +1,467 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Cache Statistics — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Capabilities" href="capability.html"/>
+ <link rel="prev" title="Cache Group Fallback" href="cachegroup_fallbacks.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Cache Statistics</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/cache_stats.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="capability.html" class="btn btn-neutral float-right" title="Capabilities">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cachegroup_fallbacks.html" class="btn btn-neutral" title="Cache Group Fallback"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="cache-statistics">
+<span id="to-api-v12-cache-stats"></span><h1>Cache Statistics<a class="headerlink" href="#cache-statistics" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-cache-stats">
+<span id="to-api-v12-cache-stats-route"></span><h2>/api/1.2/cache_stats<a class="headerlink" href="#api-1-2-cache-stats" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cache_stats.json</strong></p>
+<blockquote>
+<div><p>Retrieves statistics about the CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>yes</td>
+<td>The CDN name to return cache stats for</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">metricType</span></code></td>
+<td>yes</td>
+<td>The metric type (valid metric types: ‘ats.proxy.process.http.current_client_connections’, ‘bandwidth’, ‘maxKbps’)</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">startDate</span></code></td>
+<td>yes</td>
+<td>The begin date (Formatted as ISO8601, for example: ‘2015-08-11T12:30:00-06:00’)</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">endDate</span></code></td>
+<td>yes</td>
+<td>The end date (Formatted as ISO8601, for example: ‘2015-08-12T12:30:00-06:00’)</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="11%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">summary</span></code></td>
+<td>hash</td>
+<td>Summary data</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>min</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>max</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fifthPercentile</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ninetyEighthPercentile</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>ninetyFifthPercentile</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>average</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">series</span></code></td>
+<td>hash</td>
+<td>Series data</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>columns</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>values</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>time</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>value</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"series"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"columns"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"time"</span><span class="p">,</span>
+ <span class="s2">""</span>
+ <span class="p">],</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">29</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bandwidth"</span><span class="p">,</span>
+ <span class="s2">"tags"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"over-the-top"</span>
+ <span class="p">},</span>
+ <span class="s2">"values"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-10T22:40:00Z"</span><span class="p">,</span>
+ <span class="mi">229340299720</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-10T22:41:00Z"</span><span class="p">,</span>
+ <span class="mf">224309221713.334</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-10T22:42:00Z"</span><span class="p">,</span>
+ <span class="mf">229551834168.334</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-10T22:43:00Z"</span><span class="p">,</span>
+ <span class="mf">225179658876.667</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-10T22:44:00Z"</span><span class="p">,</span>
+ <span class="mi">230443968275</span>
+ <span class="p">]</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+ <span class="s2">"summary"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"average"</span><span class="p">:</span> <span class="mf">970410.295</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1376041798</span><span class="p">,</span>
+ <span class="s2">"fifthPercentile"</span><span class="p">:</span> <span class="mf">202.03</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">3875441.02</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">2957940.93</span><span class="p">,</span>
+ <span class="s2">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">2366728.63</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="capability.html" class="btn btn-neutral float-right" title="Capabilities">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cachegroup_fallbacks.html" class="btn btn-neutral" title="Cache Group Fallback"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/cachegroup.html b/docs/latest/api/v12/cachegroup.html
new file mode 100644
index 0000000..0612f3f
--- /dev/null
+++ b/docs/latest/api/v12/cachegroup.html
@@ -0,0 +1,1581 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Cache Group — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Cache Group parameters" href="cachegroup_parameter.html"/>
+ <link rel="prev" title="Cache" href="cache.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Cache Group</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/cachegroup.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cachegroup_parameter.html" class="btn btn-neutral float-right" title="Cache Group parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cache.html" class="btn btn-neutral" title="Cache"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="cache-group">
+<span id="to-api-v12-cachegroup"></span><h1>Cache Group<a class="headerlink" href="#cache-group" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-cachegroups">
+<span id="to-api-v12-cachegroups-route"></span><h2>/api/1.2/cachegroups<a class="headerlink" href="#api-1-2-cachegroups" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cachegroups</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>no</td>
+<td>Filter cache groups by Type ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>string</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>string</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroupId</span></code></td>
+<td>string</td>
+<td>Parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroupName</span></code></td>
+<td>string</td>
+<td>Parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroupId</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fallbackToClosest</span></code></td>
+<td>bool</td>
+<td>Behaviour during non-availability/ failure of configured fallbacks</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"fallbackToClosest"</span><span class="p">:</span><span class="n">true</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago-1"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"fallbackToClosest"</span><span class="p">:</span><span class="n">false</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cachegroups/trimmed</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cachegroups/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>string</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>string</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroupId</span></code></td>
+<td>string</td>
+<td>Parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroupName</span></code></td>
+<td>string</td>
+<td>Parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroupId</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroupName</span></code></td>
+<td>string</td>
+<td>Secondary parent cachegroup name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>Unique identifier for the ‘Type’ of Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The name of the type of Cache Group entry</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fallbackToClosest</span></code></td>
+<td>bool</td>
+<td>Behaviour during non-availability/ failure of configured fallbacks</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"fallbackToClosest"</span><span class="p">:</span><span class="n">true</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cachegroups/:id/parameters</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Local unique identifier for the parameter</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Name of the parameter</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>Value of the parameter</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">configFile</span></code></td>
+<td>string</td>
+<td>Config file associated with the parameter</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>bool</td>
+<td>Is the parameter value only visible to admin users</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1100"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cgw.originUrl"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"http://to-short.g.foo.net/data/"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span> <span class="s2">"foo.config"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-08-27 15:11:49"</span>
+ <span class="p">},</span>
+ <span class="p">{</span> <span class="o">...</span> <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cachegroups/:id/unassigned_parameters</strong></p>
+<blockquote>
+<div><p>Retrieves all parameters NOT assigned to the cache group.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Cache group id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">last_updated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cachegroup/:parameter_id/parameter</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="44%" />
+<col width="24%" />
+<col width="32%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameter_id</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="45%" />
+<col width="21%" />
+<col width="34%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroups</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cachegroupparameters</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="11%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroupParameters</span></code></td>
+<td>array</td>
+<td>A collection of cache group parameters.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>parameter</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cachegroup</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"380"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cachegroups/:parameter_id/parameter/available</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="44%" />
+<col width="24%" />
+<col width="32%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameter_id</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td> </td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td> </td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/cachegroups</strong></p>
+<blockquote>
+<div><p>Create cache group.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>no</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>no</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroup</span></code></td>
+<td>no</td>
+<td>Name of Parent Cache Group entry.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroup</span></code></td>
+<td>no</td>
+<td>Name of Secondary Parent Cache Group entry.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>yes</td>
+<td>The type of Cache Group entry, “EDGE_LOC”, “MID_LOC” or “ORG_LOC”</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fallbackToClosest</span></code></td>
+<td>no</td>
+<td>Behaviour on configured fallbacks failure, true / false</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"cg_edge"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"parentCachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_mid"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span>
+ <span class="s2">"fallbackToClosest"</span><span class="p">:</span><span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The id of cache group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>string</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>string</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroup</span></code></td>
+<td>string</td>
+<td>Name of Parent Cache Group entry.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroupId</span></code></td>
+<td>string</td>
+<td>id of Parent Cache Group entry.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroup</span></code></td>
+<td>string</td>
+<td>Name of Secondary Parent Cache Group entry.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroupId</span></code></td>
+<td>string</td>
+<td>id of Secondary Parent Cache Group entry.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The type of Cache Group entry, “EDGE_LOC”, “MID_LOC” or “ORG_LOC”</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fallbackToClosest</span></code></td>
+<td>bool</td>
+<td>Behaviour during non-availability/failure of configured fallbacks</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Cachegroup successfully created: cache_group_edge"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'longitude'</span> <span class="p">:</span> <span class="s1">'45'</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s1">'shortName'</span> <span class="p">:</span> <span class="s1">'cg_edge'</span><span class="p">,</span>
+ <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_mid'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'latitude'</span> <span class="p">:</span> <span class="s1">'12'</span><span class="p">,</span>
+ <span class="s1">'typeName'</span> <span class="p">:</span> <span class="s1">'EDGE_LOC'</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'104'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroupId'</span> <span class="p">:</span> <span class="s1">'103'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'fallbackToClosest'</span><span class="p">:</span><span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/cachegroups/{:id}</strong></p>
+<blockquote>
+<div><p>Update cache group.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="12%" />
+<col width="19%" />
+<col width="69%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>The id of the cache group to edit.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>no</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>no</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroup</span></code></td>
+<td>no</td>
+<td>Name of Parent Cache Group entry.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroup</span></code></td>
+<td>no</td>
+<td>Name of Secondary Parent Cache Group entry.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>yes</td>
+<td>The type of Cache Group entry, “EDGE_LOC”, “MID_LOC” or “ORG_LOC”</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fallbackToClosest</span></code></td>
+<td>no</td>
+<td>Behaviour on configured fallbacks failure, true / false</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"cg_edge"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"parentCachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_mid"</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"EDGE_LOC"</span><span class="p">,</span>
+ <span class="s2">"fallbackToClosest"</span><span class="p">:</span><span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The id of cache group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Cache Group entry</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>Abbreviation of the Cache Group Name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>string</td>
+<td>Latitude for the Cache Group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>string</td>
+<td>Longitude for the Cache Group</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroup</span></code></td>
+<td>string</td>
+<td>Name of Parent Cache Group entry.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentCachegroupId</span></code></td>
+<td>string</td>
+<td>id of Parent Cache Group entry.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroup</span></code></td>
+<td>string</td>
+<td>Name of Secondary Parent Cache Group entry.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">secondaryParentCachegroupId</span></code></td>
+<td>string</td>
+<td>id of Secondary Parent Cache Group entry.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>The type of Cache Group entry, “EDGE_LOC”, “MID_LOC” or “ORG_LOC”</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fallbackToClosest</span></code></td>
+<td>bool</td>
+<td>Behaviour during non-availability/failure of configured fallbacks</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Cachegroup was updated: cache_group_edge"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'longitude'</span> <span class="p">:</span> <span class="s1">'45'</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s1">'shortName'</span> <span class="p">:</span> <span class="s1">'cg_edge'</span><span class="p">,</span>
+ <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_mid'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'latitude'</span> <span class="p">:</span> <span class="s1">'12'</span><span class="p">,</span>
+ <span class="s1">'typeName'</span> <span class="p">:</span> <span class="s1">'EDGE_LOC'</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'104'</span><span class="p">,</span>
+ <span class="s1">'parentCachegroupId'</span> <span class="p">:</span> <span class="s1">'103'</span><span class="p">,</span>
+ <span class="s1">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'fallbackToClosest'</span><span class="p">:</span><span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/cachegroups/{:id}</strong></p>
+<blockquote>
+<div><p>Delete cache group. The request to delete a cache group, which has servers or child cache group, will be rejected.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="19%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>The id of the cache group to delete.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Cachegroup was deleted: cache_group_edge"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/cachegroups/{:id}/queue_update</strong></p>
+<blockquote>
+<div><p>Queue or dequeue updates for all servers assigned to a cache group limited to a specific CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>the cachegroup id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="13%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>action</td>
+<td>string</td>
+<td>queue or dequeue</td>
+</tr>
+<tr class="row-odd"><td>cdn</td>
+<td>string</td>
+<td>cdn name or cdn ID is required</td>
+</tr>
+<tr class="row-even"><td>cdnId</td>
+<td>string</td>
+<td>cdn ID or cdn name is required</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="12%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>action</td>
+<td>string</td>
+<td>The action processed, queue or dequeue.</td>
+</tr>
+<tr class="row-odd"><td>cachegroupId</td>
+<td>integer</td>
+<td>cachegroup id</td>
+</tr>
+<tr class="row-even"><td>cachegroupName</td>
+<td>string</td>
+<td>cachegroup name</td>
+</tr>
+<tr class="row-odd"><td>cdn</td>
+<td>string</td>
+<td>cdn name</td>
+</tr>
+<tr class="row-even"><td>serverNames</td>
+<td>array</td>
+<td>servers name array in the cachegroup in cdn</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroupName"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"queue"</span><span class="p">,</span>
+ <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-01"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-02"</span><span class="p">,</span>
+ <span class="s2">"atsec-chi-03"</span><span class="p">,</span>
+ <span class="p">],</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"93"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/cachegroups/{:id}/deliveryservices</strong></p>
+<blockquote>
+<div><p>Assign deliveryservices for servers in cachegroup</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="9%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>The cachegroup id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="9%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>deliveryServices</td>
+<td>array</td>
+<td>The Ids of the delivery services to assign to each server in the cachegroup.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="12%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>response</td>
+<td>hash</td>
+<td>The details of the assignment, if success.</td>
+</tr>
+<tr class="row-odd"><td>>id</td>
+<td>int</td>
+<td>The cachegroup id.</td>
+</tr>
+<tr class="row-even"><td>>serverNames</td>
+<td>array</td>
+<td>The server name array in the cachegroup.</td>
+</tr>
+<tr class="row-odd"><td>>deliveryServices</td>
+<td>array</td>
+<td>The deliveryservice id array.</td>
+</tr>
+<tr class="row-even"><td>alerts</td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td>>level</td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td>>text</td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"atlanta-edge-01"</span><span class="p">,</span> <span class="s2">"atlanta-edge-07"</span> <span class="p">],</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery services successfully assigned to all the servers of cache group 3."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cachegroup_parameter.html" class="btn btn-neutral float-right" title="Cache Group parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cache.html" class="btn btn-neutral" title="Cache"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/cachegroup_fallbacks.html b/docs/latest/api/v12/cachegroup_fallbacks.html
new file mode 100644
index 0000000..6e14fb6
--- /dev/null
+++ b/docs/latest/api/v12/cachegroup_fallbacks.html
@@ -0,0 +1,710 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Cache Group Fallback — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Cache Statistics" href="cache_stats.html"/>
+ <link rel="prev" title="Cache Group parameters" href="cachegroup_parameter.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Cache Group Fallback</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/cachegroup_fallbacks.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cache_stats.html" class="btn btn-neutral float-right" title="Cache Statistics">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cachegroup_parameter.html" class="btn btn-neutral" title="Cache Group parameters"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="cache-group-fallback">
+<span id="to-api-v12-cachegroupfallbacks"></span><h1>Cache Group Fallback<a class="headerlink" href="#cache-group-fallback" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-cachegroup-fallbacks">
+<span id="to-api-v12-cachegroupfallbacks-route"></span><h2>/api/1.2/cachegroup_fallbacks<a class="headerlink" href="#api-1-2-cachegroup-fallbacks" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cachegroup_fallbacks?cacheGroupId={id}</strong>
+<strong>GET /api/1.2/cachegroup_fallbacks?fallbackId={id}</strong>
+<strong>GET /api/1.2/cachegroup_fallbacks?cacheGroupId={id}&fallbackId={id}</strong></p>
+<blockquote>
+<div><p>Retrieve fallback related configurations for a cache group.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<p>Query parameter is mandatory. Either one of the parameters must be used. Both can also be used simultaneously.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="82%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>cacheGroupId</td>
+<td>The id of the cache group whose backup configurations has to be retrieved</td>
+</tr>
+<tr class="row-odd"><td>fallbackId</td>
+<td>The id of the fallback cache group associated with a cache group</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroupId</span></code></td>
+<td>int</td>
+<td>Cache group id</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fallbackId</span></code></td>
+<td>int</td>
+<td>fallback cache group id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroupName</span></code></td>
+<td>string</td>
+<td>Cache group name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fallbackName</span></code></td>
+<td>string</td>
+<td>Fallback cache group name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>fallbackOrder</span></code></td>
+<td>int</td>
+<td>Ordering list in the list of backups</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cacheGroupId"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"cacheGroupName"</span><span class="p">:</span><span class="s2">"GROUP1"</span><span class="p">,</span>
+ <span class="s2">"fallbackId"</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"fallbackOrder"</span><span class="p">:</span><span class="mi">10</span><span class="p">,</span>
+ <span class="s2">"fallbackName"</span><span class="p">:</span><span class="s2">"GROUP2"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/cachegroup_fallbacks</strong></p>
+<blockquote>
+<div><p>Creates fallback configuration for the cache group. New fallbacks can be added only via POST.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Parameters</strong>
+The request parameters should be in array format.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroupId</span></code></td>
+<td>int</td>
+<td>Cache group id</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fallbackId</span></code></td>
+<td>int</td>
+<td>Fallback cache group id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>fallbackOrder</span></code></td>
+<td>int</td>
+<td>Ordering list in the list of backups</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cacheGroupId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"fallbackId"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"fallbackOrder"</span><span class="p">:</span> <span class="mi">10</span>
+ <span class="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroupId</span></code></td>
+<td>int</td>
+<td>Cache group id</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fallbackId</span></code></td>
+<td>int</td>
+<td>fallback cache group id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroupName</span></code></td>
+<td>string</td>
+<td>Cache group name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fallbackName</span></code></td>
+<td>string</td>
+<td>Fallback cache group name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>fallbackOrder</span></code></td>
+<td>int</td>
+<td>Ordering list in the list of backups</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span><span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span><span class="s2">"Backup configuration CREATE for cache group 1 successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cacheGroupId"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"cacheGroupName"</span><span class="p">:</span><span class="s2">"GROUP1"</span><span class="p">,</span>
+ <span class="s2">"fallbackId"</span><span class="p">:</span><span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"fallbackName"</span><span class="p">:</span><span class="s2">"GROUP2"</span><span class="p">,</span>
+ <span class="s2">"fallbackorder"</span><span class="p">:</span><span class="mi">10</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/cachegroup_fallbacks</strong></p>
+<blockquote>
+<div><p>Updates an existing fallback configuration for the cache group.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Parameters</strong>
+The request parameters should be in array format.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroupId</span></code></td>
+<td>int</td>
+<td>Cache group id</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fallbackId</span></code></td>
+<td>int</td>
+<td>Fallback cache group id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>fallbackOrder</span></code></td>
+<td>int</td>
+<td>Ordering list in the list of backups</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cacheGroupId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"fallbackId"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"fallbackOrder"</span><span class="p">:</span> <span class="mi">10</span>
+ <span class="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroupId</span></code></td>
+<td>int</td>
+<td>Cache group id</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fallbackId</span></code></td>
+<td>int</td>
+<td>fallback cache group id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroupName</span></code></td>
+<td>string</td>
+<td>Cache group name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fallbackName</span></code></td>
+<td>string</td>
+<td>Fallback cache group name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>fallbackOrder</span></code></td>
+<td>int</td>
+<td>Ordering list in the list of backups</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span><span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span><span class="s2">"Backup configuration UPDATE for cache group 1 successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cacheGroupId"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"cacheGroupName"</span><span class="p">:</span><span class="s2">"GROUP1"</span><span class="p">,</span>
+ <span class="s2">"fallbackId"</span><span class="p">:</span><span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"fallbackName"</span><span class="p">:</span><span class="s2">"GROUP2"</span><span class="p">,</span>
+ <span class="s2">"fallbackorder"</span><span class="p">:</span><span class="mi">10</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/cachegroup_fallbacks?cacheGroupId={id}</strong>
+<strong>DELETE /api/1.2/cachegroup_fallbacks?fallbackId={id}</strong>
+<strong>DELETE /api/1.2/cachegroup_fallbacks?fallbackId={id}&cacheGroupId={id}</strong></p>
+<blockquote>
+<div><p>Delete fallback list assigned to the cache group.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Query Parameters</strong></p>
+<p>Query parameter is mandatory. Either one of the parameters must be used. Both can also be used simultaneously.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="9%" />
+<col width="76%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>cacheGroupId</td>
+<td>Yes</td>
+<td>The id of the cache group whose backup configurations has to be deleted</td>
+</tr>
+<tr class="row-odd"><td>fallbackId</td>
+<td>Yes</td>
+<td>The id of the fallback cachegroup which has to be deleted from the list of fallbacks</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Backup configuration DELETED"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cache_stats.html" class="btn btn-neutral float-right" title="Cache Statistics">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cachegroup_parameter.html" class="btn btn-neutral" title="Cache Group parameters"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/cachegroup_parameter.html b/docs/latest/api/v12/cachegroup_parameter.html
new file mode 100644
index 0000000..22f7979
--- /dev/null
+++ b/docs/latest/api/v12/cachegroup_parameter.html
@@ -0,0 +1,517 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Cache Group parameters — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Cache Group Fallback" href="cachegroup_fallbacks.html"/>
+ <link rel="prev" title="Cache Group" href="cachegroup.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Cache Group parameters</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/cachegroup_parameter.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cachegroup_fallbacks.html" class="btn btn-neutral float-right" title="Cache Group Fallback">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cachegroup.html" class="btn btn-neutral" title="Cache Group"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="cache-group-parameters">
+<span id="to-api-v12-cachegroupparameters"></span><h1>Cache Group parameters<a class="headerlink" href="#cache-group-parameters" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-cachegroupparameters">
+<span id="to-api-v12-cachegroupparameters-route"></span><h2>/api/1.2/cachegroupparameters<a class="headerlink" href="#api-1-2-cachegroupparameters" title="Permalink to this headline">¶</a></h2>
+<p><strong>POST /api/1.2/cachegroupparameters</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Assign parameter(s) to cache group(s).</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Properties</strong></p>
+<p>Two formats are acceptable.</p>
+<p>Single cachegroup-parameter format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cacheGroupId</span></code></td>
+<td>yes</td>
+<td>cache group id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parameterId</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+<p>Profile-parameter array format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="12%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>yes</td>
+<td>cachegroup-parameter array.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroupId</span></code></td>
+<td>yes</td>
+<td>cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>parameterId</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>Single cachegroup-parameter format:
+
+{
+ "cacheGroupId": 2,
+ "parameterId": 6
+}
+
+Cachegroup-parameter array format:
+
+[
+ {
+ "cacheGroupId": 2,
+ "parameterId": 6
+ },
+ {
+ "cacheGroupId": 2,
+ "parameterId": 7
+ },
+ {
+ "cacheGroupId": 3,
+ "parameterId": 6
+ }
+]
+
+ **Response Properties**
+
+ +-------------------+---------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+=========+=====================================================+
+ | ``response`` | array | Cache group-parameter associations. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>cacheGroupId`` | string | Cache Group id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>parameterId`` | string | Parameter id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+---------+-----------------------------------------------------+
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"cacheGroupId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"cacheGroupId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"7"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"cacheGroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Cache group parameter associations were created."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/cachegroupparameters/{:cachegroup_id}/{:parameter_id}</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Delete a cache group parameter association.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup_id</span></code></td>
+<td>yes</td>
+<td>cache group id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parameter_id</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="10%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Cache group parameter association was deleted."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cachegroup_fallbacks.html" class="btn btn-neutral float-right" title="Cache Group Fallback">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cachegroup.html" class="btn btn-neutral" title="Cache Group"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/capability.html b/docs/latest/api/v12/capability.html
new file mode 100644
index 0000000..3ca5909
--- /dev/null
+++ b/docs/latest/api/v12/capability.html
@@ -0,0 +1,701 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Capabilities — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="CDN" href="cdn.html"/>
+ <link rel="prev" title="Cache Statistics" href="cache_stats.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Capabilities</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/capability.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cdn.html" class="btn btn-neutral float-right" title="CDN">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cache_stats.html" class="btn btn-neutral" title="Cache Statistics"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="capabilities">
+<span id="to-api-v12-capability"></span><h1>Capabilities<a class="headerlink" href="#capabilities" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-capabilities">
+<span id="to-api-v12-capability-route"></span><h2>/api/1.2/capabilities<a class="headerlink" href="#api-1-2-capabilities" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/capabilities</strong></p>
+<blockquote>
+<div><p>Get all capabilities.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Capability name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>Describing the APIs covered by the capability.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn-read"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"View CDN configuration"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn-write"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Create, edit or delete CDN configuration"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/capabilities/:name</strong></p>
+<blockquote>
+<div><p>Get a capability by name.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="15%" />
+<col width="12%" />
+<col width="54%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>Capability name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Capability name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>Describing the APIs covered by the capability.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn-read"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"View CDN configuration"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2017-04-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/capabilities</strong></p>
+<blockquote>
+<div><p>Create a capability.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="12%" />
+<col width="10%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>Capability name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>Describing the APIs covered by the capability.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn-write"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Create, edit or delete CDN configuration"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>hash</td>
+<td>The details of the creation, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>Capability name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>description</span></code></td>
+<td>string</td>
+<td>Describing the APIs covered by the capability.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn-write"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Create, edit or delete CDN configuration"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Capability was created."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/capabilities/{:name}</strong></p>
+<blockquote>
+<div><p>Edit a capability.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>int</td>
+<td>Capability name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>Describing the APIs covered by the capability.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"View CDN configuration"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>hash</td>
+<td>The details of the update, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>Capability name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>description</span></code></td>
+<td>int</td>
+<td>Describing the APIs covered by the capability.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn-read"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"View CDN configuration"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Capability was updated."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/capabilities/{:name}</strong></p>
+<blockquote>
+<div><p>Delete a capability.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>Capability name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Capability deleted."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="cdn.html" class="btn btn-neutral float-right" title="CDN">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cache_stats.html" class="btn btn-neutral" title="Cache Statistics"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/cdn.html b/docs/latest/api/v12/cdn.html
new file mode 100644
index 0000000..d2dac99
--- /dev/null
+++ b/docs/latest/api/v12/cdn.html
@@ -0,0 +1,2566 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>CDN — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Change Logs" href="changelog.html"/>
+ <link rel="prev" title="Capabilities" href="capability.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>CDN</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/cdn.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="changelog.html" class="btn btn-neutral float-right" title="Change Logs">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="capability.html" class="btn btn-neutral" title="Capabilities"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="cdn">
+<span id="to-api-v12-cdn"></span><h1>CDN<a class="headerlink" href="#cdn" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-cdns">
+<span id="to-api-v12-cdn-route"></span><h2>/api/1.2/cdns<a class="headerlink" href="#api-1-2-cdns" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cdns</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>TLD of the CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"cdn1.foo.com"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"cdn2.foo.com"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>TLD of the CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"cdn2.foo.com"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/name/:name</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>TLD of the CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>DNSSEC enabled.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"cdn2.foo.com"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/cdns</strong></p>
+<blockquote>
+<div><p>Allows user to create a CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>TLD of the CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>Whether dnssec is enabled.
+- false: disabled
+- true: enabled</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"cdn3.foo.com"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>hash</td>
+<td>The details of the creation, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td>
+<td>int</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>dnssecEnabled</span></code></td>
+<td>string</td>
+<td>Whether dnssec is enabled.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>domainName</span></code></td>
+<td>string</td>
+<td>TLD of the CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">3</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"cdn3.foo.com"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"cdn was created."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/cdns/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to edit a CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="11%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>TLD of the CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>Whether dnssec is enabled.
+- false: disabled
+- true: enabled</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test2"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"cdn3.foo.com"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>hash</td>
+<td>The details of the update, if success.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td>
+<td>int</td>
+<td>CDN id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>domainName</span></code></td>
+<td>string</td>
+<td>TLD of the CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>dnssecEnabled</span></code></td>
+<td>bool</td>
+<td>Whether dnssec is enabled.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test2"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"cdn3.foo.com"</span><span class="p">,</span>
+ <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"cdn was updated."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/cdns/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to delete a CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>CDN id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"cdn was deleted."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/cdns/{:id}/queue_update</strong></p>
+<blockquote>
+<div><p>Queue or dequeue updates for all servers assigned to a specific CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>the cdn id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="13%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>action</td>
+<td>string</td>
+<td>queue or dequeue</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"queue"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="12%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>action</td>
+<td>string</td>
+<td>The action processed, queue or dequeue.</td>
+</tr>
+<tr class="row-odd"><td>cdnId</td>
+<td>integer</td>
+<td>cdn id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"queue"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="health">
+<h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">¶</a></h2>
+<p id="to-api-v12-cdn-health-route"><strong>GET /api/1.2/cdns/health</strong></p>
+<blockquote>
+<div><p>Retrieves the health of all locations (cache groups) for all CDNs.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="11%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">totalOnline</span></code></td>
+<td>int</td>
+<td>Total number of online caches across all CDNs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">totalOffline</span></code></td>
+<td>int</td>
+<td>Total number of offline caches across all CDNs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>online</span></code></td>
+<td>int</td>
+<td>The number of online caches for the cache group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>offline</span></code></td>
+<td>int</td>
+<td>The number of offline caches for the cache
+group.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>Cache group name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:name/health</strong></p>
+<blockquote>
+<div><p>Retrieves the health of all locations (cache groups) for a given CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="11%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">totalOnline</span></code></td>
+<td>int</td>
+<td>Total number of online caches across the
+specified CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">totalOffline</span></code></td>
+<td>int</td>
+<td>Total number of offline caches across the
+specified CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>online</span></code></td>
+<td>int</td>
+<td>The number of online caches for the cache group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>offline</span></code></td>
+<td>int</td>
+<td>The number of offline caches for the cache
+group.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>Cache group name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/usage/overview</strong></p>
+<blockquote>
+<div><p>Retrieves the high-level CDN usage metrics.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">currentGbps</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tps</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">maxGbps</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
+ <span class="s2">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
+ <span class="s2">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/capacity</strong></p>
+<blockquote>
+<div><p>Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">availablePercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">unavailablePercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">utilizedPercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maintenancePercent</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="routing">
+<span id="to-api-v12-cdn-routing"></span><h2>Routing<a class="headerlink" href="#routing" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cdns/routing</strong></p>
+<blockquote>
+<div><p>Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="12%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">staticRoute</span></code></td>
+<td>number</td>
+<td>Used pre-configured DNS entries.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">miss</span></code></td>
+<td>number</td>
+<td>No location available for client IP.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geo</span></code></td>
+<td>number</td>
+<td>Used 3rd party geo-IP mapping.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">err</span></code></td>
+<td>number</td>
+<td>Error localizing client IP.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cz</span></code></td>
+<td>number</td>
+<td>Used Coverage Zone geo-IP mapping.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dsr</span></code></td>
+<td>number</td>
+<td>Overflow traffic sent to secondary CDN.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="metrics">
+<span id="to-api-v12-cdn-metrics"></span><h2>Metrics<a class="headerlink" href="#metrics" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end</strong></p>
+<p><em>Note: this route is not currently implemented in Traffic Ops. See https://github.com/apache/incubator-trafficcontrol/issues/2309</em></p>
+<blockquote>
+<div><p>Retrieves edge metrics of one or all locations (cache groups).</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="19%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">metric_type</span></code></td>
+<td>yes</td>
+<td>ooff, origin_tps</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">start</span></code></td>
+<td>yes</td>
+<td>UNIX time, yesterday, now</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">end</span></code></td>
+<td>yes</td>
+<td>UNIX time, yesterday, now</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="19%" />
+<col width="31%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>count</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>98thPercentile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>min</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>max</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>5thPercentile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>95thPercentile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>mean</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>sum</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">data</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>time</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>value</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">label</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
+ <span class="p">},</span>
+ <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">[</span>
+ <span class="mi">1425135900000</span><span class="p">,</span>
+ <span class="mf">1668.03</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="mi">1425136200000</span><span class="p">,</span>
+ <span class="n">null</span>
+ <span class="p">]</span>
+ <span class="p">],</span>
+ <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"Origin TPS"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="domains">
+<span id="to-api-v12-cdn-domains"></span><h2>Domains<a class="headerlink" href="#domains" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cdns/domains</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parameterId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"404"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_FOO"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for foo.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"foo.domain.net"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"405"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_BAR"</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for bar.domain.net"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"bar.domain.net"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="topology">
+<span id="to-api-v12-cdn-topology"></span><h2>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cdns/:cdn_name/configs</strong></p>
+<blockquote>
+<div><p>Retrieves CDN config information.</p>
+<p>Authentication Required: Yes</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="21%" />
+<col width="49%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn_name</span></code></td>
+<td>yes</td>
+<td>Your cdn name or, all</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="10%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">TBD</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:name/configs/monitoring</strong></p>
+<blockquote>
+<div><p>Retrieves CDN monitoring information.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>CDN name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="64%" />
+<col width="10%" />
+<col width="26%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trafficServers</span></code></td>
+<td>array</td>
+<td>A collection of
+Traffic Servers.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroup</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>interfaceName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hashId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cacheGroups</span></code></td>
+<td>array</td>
+<td>A collection of
+cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>coordinates</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>longitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>latitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">config</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hack.ttl</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tm.healthParams.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.dataServer.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>health.timepad</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>health.threadPool</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>health.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>health.event-count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.crConfig.polling.url</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>CDN_name</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trafficMonitors</span></code></td>
+<td>array</td>
+<td>A collection of
+Traffic Monitors.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServices</span></code></td>
+<td>array</td>
+<td>A collection of
+delivery services.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>totalTpsThreshold</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>totalKbpsThreshold</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profiles</span></code></td>
+<td>array</td>
+<td>A collection of
+profiles.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>parameters</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>health.connection.timeout</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>health.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>health.threshold.queryTime</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>history.count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>health.threshold.availableBandwidthInKbps</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>health.threshold.loadavg</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">TBD</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:name/configs/routing</strong></p>
+<blockquote>
+<div><p>Retrieves CDN routing information.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="46%" />
+<col width="11%" />
+<col width="43%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trafficServers</span></code></td>
+<td>array</td>
+<td>A collection of Traffic Servers.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>cacheGroup</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>deliveryServices</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>remaps</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>interfaceName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hashId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>trafficOpsPath</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>cdnName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>trafficOpsVersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>trafficOpsUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>date</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>trafficOpsHost</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cacheGroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>coordinates</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>longitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>latitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">config</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tld.soa.admin</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tcoveragezone.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>geolocation.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tld.soa.expire</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>coveragezone.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tld.soa.minimum</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>geolocation.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>domain_name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tld.ttls.AAAA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tld.soa.refresh</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tld.ttls.NS</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tld.ttls.SOA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>geolocation6.polling.interval</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tld.ttls.A</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tld.soa.retry</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>geolocation6.polling.url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trafficMonitors</span></code></td>
+<td>array</td>
+<td>A collection of Traffic Monitors.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>profile</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServices</span></code></td>
+<td>array</td>
+<td>A collection of delivery
+services.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ttl</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>geoEnabled</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>coverageZoneOnly</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>matchSets</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>protocol</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>matchList</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>>regex</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>>matchType</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>bypassDestination</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>maxDnsIpsForLocation</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>ttl</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ttls</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>A</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>SOA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>NS</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>AAAA</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>missCoordinates</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>longitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>latitude</span></code></td>
+<td>number</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>soa</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>admin</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>retry</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>minimum</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>refresh</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>expire</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trafficRouters</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>profile</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>ip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>ip6</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>port</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hostName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>fqdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>apiPort</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">TBD</span>
+</pre></div>
+</div>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="dnssec-keys">
+<span id="to-api-v12-cdn-dnsseckeys"></span><h2>DNSSEC Keys<a class="headerlink" href="#dnssec-keys" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cdns/name/:name/dnsseckeys</strong></p>
+<blockquote>
+<div><p>Gets a list of dnsseckeys for a CDN and all associated Delivery Services.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="8%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span> <span class="pre">name/ds</span> <span class="pre">xml_id</span></code></td>
+<td>string</td>
+<td>identifier for ds or cdn</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>zsk/ksk</span></code></td>
+<td>array</td>
+<td>collection of zsk/ksk data</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>ttl</span></code></td>
+<td>string</td>
+<td>time-to-live for dnssec requests</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>inceptionDate</span></code></td>
+<td>string</td>
+<td>epoch timestamp for when the keys were created</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>expirationDate</span></code></td>
+<td>string</td>
+<td>epoch timestamp representing the expiration of the keys</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>private</span></code></td>
+<td>string</td>
+<td>encoded private key</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>public</span></code></td>
+<td>string</td>
+<td>encoded public key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>name</span></code></td>
+<td>string</td>
+<td>domain name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ksk>>dsRecord>>algorithm</span></code></td>
+<td>string</td>
+<td>The algorithm of the referenced DNSKEY-recor.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ksk>>dsRecord>>digestType</span></code></td>
+<td>string</td>
+<td>Cryptographic hash algorithm used to create the Digest value.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ksk>>dsRecord>>digest</span></code></td>
+<td>string</td>
+<td>A cryptographic hash value of the referenced DNSKEY-record.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cdn1"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="n">dsRecord</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"algorithm"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"digestType"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"digest"</span><span class="p">:</span> <span class="s2">"abc123def456"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="s2">"ds-01"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span>
+ <span class="p">},</span>
+ <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span><span class="p">,</span>
+ <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
+ <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
+ <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
+ <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="o">...</span> <span class="n">repeated</span> <span class="k">for</span> <span class="n">each</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">cdn</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/name/:name/dnsseckeys/delete</strong></p>
+<blockquote>
+<div><p>Delete dnssec keys for a cdn and all associated delivery services.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="13%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>name of the CDN for which you want to delete dnssec keys</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>success response</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted dnssec keys for <cdn>"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/deliveryservices/dnsseckeys/generate</strong></p>
+<blockquote>
+<div><p>Generates ZSK and KSK keypairs for a CDN and all associated Delivery Services.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="11%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>name of the cdn</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>domain name of the cdn</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>string</td>
+<td>time to live</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">kskExpirationDays</span></code></td>
+<td>string</td>
+<td>Expiration (in days) for the key signing keys</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">zskExpirationDays</span></code></td>
+<td>string</td>
+<td>Expiration (in days) for the zone signing keys</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
+ <span class="s2">"name"</span> <span class="s2">"ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
+ <span class="s2">"kskExpirationDays"</span><span class="p">:</span> <span class="s2">"365"</span><span class="p">,</span>
+ <span class="s2">"zskExpirationDays"</span><span class="p">:</span> <span class="s2">"90"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="36%" />
+<col width="21%" />
+<col width="44%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>response string</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully created dnssec keys for cdn1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="ssl-keys">
+<span id="to-api-v12-cdn-sslkeys"></span><h2>SSL Keys<a class="headerlink" href="#ssl-keys" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cdns/name/:name/sslkeys</strong></p>
+<blockquote>
+<div><p>Returns ssl certificates for all Delivery Services that are a part of the CDN.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="30%" />
+<col width="39%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="8%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td>
+<td>string</td>
+<td>identifier for deliveryservice xml_id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">certificate</span></code></td>
+<td>array</td>
+<td>collection of certificate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>key</span></code></td>
+<td>string</td>
+<td>base64 encoded private key for ssl certificate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>crt</span></code></td>
+<td>string</td>
+<td>base64 encoded ssl certificate</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"ds1"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"base64encodedcrt1"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"base64encodedkey1"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"ds2"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"base64encodedcrt2"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"base64encodedkey2"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="changelog.html" class="btn btn-neutral float-right" title="Change Logs">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="capability.html" class="btn btn-neutral" title="Capabilities"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/changelog.html b/docs/latest/api/v12/changelog.html
new file mode 100644
index 0000000..a83497f
--- /dev/null
+++ b/docs/latest/api/v12/changelog.html
@@ -0,0 +1,520 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Change Logs — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Config Files and Config File Metadata" href="configfiles_ats.html"/>
+ <link rel="prev" title="CDN" href="cdn.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Change Logs</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/changelog.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="configfiles_ats.html" class="btn btn-neutral float-right" title="Config Files and Config File Metadata">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cdn.html" class="btn btn-neutral" title="CDN"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="change-logs">
+<span id="to-api-v12-change-logs"></span><h1>Change Logs<a class="headerlink" href="#change-logs" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-logs">
+<span id="to-api-v12-change-logs-route"></span><h2>/api/1.2/logs<a class="headerlink" href="#api-1-2-logs" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/logs</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">days</span></code></td>
+<td>no</td>
+<td>The number of days of change logs to return.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">limit</span></code></td>
+<td>no</td>
+<td>The number of rows to limit the response to.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ticketNum</span></code></td>
+<td>string</td>
+<td>Optional field to cross reference with any bug tracking systems</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">level</span></code></td>
+<td>string</td>
+<td>Log categories for each entry, examples: ‘UICHANGE’, ‘OPER’, ‘APICHANGE’.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the Log</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">user</span></code></td>
+<td>string</td>
+<td>Current user who made the change that was logged</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Local unique identifier for the Log entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">message</span></code></td>
+<td>string</td>
+<td>Log detail about what occurred</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
+ <span class="p">},</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/logs/:days/days</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="27%" />
+<col width="46%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">days</span></code></td>
+<td>yes</td>
+<td>Number of days.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ticketNum</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">level</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">user</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">message</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
+ <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/logs/newcount</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">newLogcount</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"newLogcount"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="configfiles_ats.html" class="btn btn-neutral float-right" title="Config Files and Config File Metadata">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="cdn.html" class="btn btn-neutral" title="CDN"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/configfiles_ats.html b/docs/latest/api/v12/configfiles_ats.html
new file mode 100644
index 0000000..80439d2
--- /dev/null
+++ b/docs/latest/api/v12/configfiles_ats.html
@@ -0,0 +1,488 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Config Files and Config File Metadata — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Delivery Service" href="deliveryservice.html"/>
+ <link rel="prev" title="Change Logs" href="changelog.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Config Files and Config File Metadata</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/configfiles_ats.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="deliveryservice.html" class="btn btn-neutral float-right" title="Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="changelog.html" class="btn btn-neutral" title="Change Logs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="config-files-and-config-file-metadata">
+<span id="to-api-v12-configfiles-ats"></span><h1>Config Files and Config File Metadata<a class="headerlink" href="#config-files-and-config-file-metadata" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-servers-hostname-configfiles-ats">
+<span id="to-api-v12-configfiles-ats-route"></span><h2>/api/1.2/servers/:hostname/configfiles/ats<a class="headerlink" href="#api-1-2-servers-hostname-configfiles-ats" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/servers/:hostname/configfiles/ats</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operator</p>
+<p><strong>Request Query Parameters</strong></p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="8%" />
+<col width="73%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head"> </th>
+<th class="head"> </th>
+<th class="head">Info Section</th>
+</tr>
+<tr class="row-even"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The ID of the profile assigned to the cache.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the profile assigned to the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">toRevProxyUrl</span></code></td>
+<td>string</td>
+<td>The configured reverse proxy cache for configfile requests.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">toURL</span></code></td>
+<td>string</td>
+<td>The configured URL for Traffic Ops.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">serverIpv4</span></code></td>
+<td>string</td>
+<td>The configured IP address of the cache.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">serverName</span></code></td>
+<td>string</td>
+<td>The cache’s short form hostname.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">serverId</span></code></td>
+<td>int</td>
+<td>The cache’s Traffic Ops ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>int</td>
+<td>The ID of the cache’s assigned CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>The name of the cache’s assigned CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">serverTcpPort</span></code></td>
+<td>int</td>
+<td>The configured port of the server’s used by ATS.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fnameOnDisk</span></code></td>
+<td>string</td>
+<td>The filename of the configuration file as stored on the cache.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">location</span></code></td>
+<td>string</td>
+<td>The directory location of the configuration file as stored on the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">apiUri</span></code></td>
+<td>string</td>
+<td>The path to generate the configuration file from Traffic Ops.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">scope</span></code></td>
+<td>string</td>
+<td>The scope of the configuration file.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"info"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="mi">278</span><span class="p">,</span>
+ <span class="s2">"toRevProxyUrl"</span><span class="p">:</span> <span class="s2">"https://to.example.com:81"</span><span class="p">,</span>
+ <span class="s2">"toUrl"</span><span class="p">:</span> <span class="s2">"https://to.example.com/"</span><span class="p">,</span>
+ <span class="s2">"serverIpv4"</span><span class="p">:</span> <span class="s2">"192.168.1.5"</span><span class="p">,</span>
+ <span class="s2">"serverTcpPort"</span><span class="p">:</span> <span class="mi">80</span><span class="p">,</span>
+ <span class="s2">"serverName"</span><span class="p">:</span> <span class="s2">"cache-ats-01"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN_1"</span><span class="p">,</span>
+ <span class="s2">"serverId"</span><span class="p">:</span> <span class="mi">21</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"EDGE_CDN_1_EXAMPLE"</span>
+ <span class="p">},</span>
+ <span class="s2">"configFiles"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"fnameOnDisk"</span><span class="p">:</span> <span class="s2">"remap.config"</span><span class="p">,</span>
+ <span class="s2">"location"</span><span class="p">:</span> <span class="s2">"/opt/trafficserver/etc/trafficserver"</span><span class="p">,</span>
+ <span class="s2">"apiUri"</span><span class="p">:</span> <span class="s2">"/api/1.2/profiles/EDGE_CDN_1_EXAMPLE/configfiles/ats/remap.config"</span><span class="p">,</span>
+ <span class="s2">"scope"</span><span class="p">:</span> <span class="s2">"profiles"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"fnameOnDisk"</span><span class="p">:</span> <span class="s2">"ssl_multicert.config"</span><span class="p">,</span>
+ <span class="s2">"location"</span><span class="p">:</span> <span class="s2">"/opt/trafficserver/etc/trafficserver"</span><span class="p">,</span>
+ <span class="s2">"apiUri"</span><span class="p">:</span> <span class="s2">"/api/1.2/cdns/CDN_1/configfiles/ats/ssl_multicert.config"</span><span class="p">,</span>
+ <span class="s2">"scope"</span><span class="p">:</span> <span class="s2">"cdns"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"fnameOnDisk"</span><span class="p">:</span> <span class="s2">"parent.config"</span><span class="p">,</span>
+ <span class="s2">"location"</span><span class="p">:</span> <span class="s2">"/opt/trafficserver/etc/trafficserver"</span><span class="p">,</span>
+ <span class="s2">"apiUri"</span><span class="p">:</span> <span class="s2">"/api/1.2/servers/cache-ats-01/configfiles/ats/parent.config"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="api-1-2-servers-hostname-configfiles-ats-configfile">
+<h2>/api/1.2/servers/:hostname/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-servers-hostname-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/servers/:hostname/configfiles/ats/:configfile</strong>
+<strong>GET /api/1.2/servers/:host_id/configfiles/ats/:configfile</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operator</p>
+<p><strong>Request Query Parameters</strong></p>
+<p><strong>Response Properties</strong></p>
+<p>Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.</p>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Error - incorrect file scope for route used. Please use the profiles route."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="api-1-2-profiles-profile-name-configfiles-ats-configfile">
+<h2>/api/1.2/profiles/:profile_name/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-profiles-profile-name-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/profiles/:profile_name/configfiles/ats/:configfile</strong>
+<strong>GET /api/1.2/profiles/:profile_id/configfiles/ats/:configfile</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operator</p>
+<p><strong>Request Query Parameters</strong></p>
+<p><strong>Response Properties</strong></p>
+<p>Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.</p>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Error - incorrect file scope for route used. Please use the cdns route."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="api-1-2-cdns-cdn-name-configfiles-ats-configfile">
+<h2>/api/1.2/cdns/:cdn_name/configfiles/ats/:configfile<a class="headerlink" href="#api-1-2-cdns-cdn-name-configfiles-ats-configfile" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cdns/:cdn_name/configfiles/ats/:configfile</strong>
+<strong>GET /api/1.2/cdns/:cdn_id/configfiles/ats/:configfile</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operator</p>
+<p><strong>Request Query Parameters</strong></p>
+<p><strong>Response Properties</strong></p>
+<p>Returns the requested configuration file for download. If scope used is incorrect for the config file requested, returns a 404 with the correct scope.</p>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Error - incorrect file scope for route used. Please use the servers route."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="deliveryservice.html" class="btn btn-neutral float-right" title="Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="changelog.html" class="btn btn-neutral" title="Change Logs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/deliveryservice.html b/docs/latest/api/v12/deliveryservice.html
new file mode 100644
index 0000000..e310799
--- /dev/null
+++ b/docs/latest/api/v12/deliveryservice.html
@@ -0,0 +1,5990 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Delivery Service — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Delivery Service Regexes" href="deliveryservice_regex.html"/>
+ <link rel="prev" title="Config Files and Config File Metadata" href="configfiles_ats.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Delivery Service</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/deliveryservice.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="deliveryservice_regex.html" class="btn btn-neutral float-right" title="Delivery Service Regexes">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="configfiles_ats.html" class="btn btn-neutral" title="Config Files and Config File Metadata"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="delivery-service">
+<span id="to-api-v12-ds"></span><h1>Delivery Service<a class="headerlink" href="#delivery-service" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-deliveryservices">
+<span id="to-api-v12-ds-route"></span><h2>/api/1.2/deliveryservices<a class="headerlink" href="#api-1-2-deliveryservices" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/deliveryservices</strong></p>
+<blockquote>
+<div><p>Retrieves all delivery services (if admin or ops) or all delivery services assigned to user. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>no</td>
+<td>Filter delivery services by CDN ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>no</td>
+<td>Filter delivery services by Profile ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>no</td>
+<td>Filter delivery services by Tenant ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>no</td>
+<td>Filter delivery services by Type ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td>
+<td>no</td>
+<td>Filter by logs enabled (true|false).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="5%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">anonymousBlockingEnabled</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>true: enable blocking clients with anonymous ips</li>
+<li>false: disabled</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cacheurl</span></code></td>
+<td>string</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ccrDnsTtl</span></code></td>
+<td>int</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>int</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">checkPath</span></code></td>
+<td>string</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deepCachingType</span></code></td>
+<td>string</td>
+<td><p class="first">When to do Deep Caching for this Delivery Service:</p>
+<ul class="last simple">
+<li>NEVER (default)</li>
+<li>ALWAYS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp</span></code></td>
+<td>string</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp6</span></code></td>
+<td>string</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassTtl</span></code></td>
+<td>int</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td>
+<td>int</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">edgeHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td>
+<td>int</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from USA</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td>
+<td>int</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td>
+<td>int</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fqPacingRate</span></code></td>
+<td>int</td>
+<td>The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded,
+will be rate limited by the Linux kernel. A default value of 0 disables this feature</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpBypassFqdn</span></code></td>
+<td>string</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>The deliveryservice id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">infoUrl</span></code></td>
+<td>string</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<td>bool</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td>
+<td>string</td>
+<td>Description field.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td>
+<td>string</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc2</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maxDnsAnswers</span></code></td>
+<td>int</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td>
+<td>float</td>
+<td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+- e.g. 39.7391500 or null</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td>
+<td>float</td>
+<td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+- e.g. -104.9847000 or null</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">orgServerFqdn</span></code></td>
+<td>string</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>int</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td>
+<td>int</td>
+<td><ul class="first last simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td>
+<td>int</td>
+<td>How to treat range requests:
+- 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)
+- 1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.
+- 2 Use the cache_range_requests plugin.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regexRemap</span></code></td>
+<td>string</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">remapText</span></code></td>
+<td>string</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routingName</span></code></td>
+<td>string</td>
+<td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">signed</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">signingAlgorithm</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>“url_sig”: URL Sign token based auth is enabled for this deliveryservice.</li>
+<li>“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>Owning tenant name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td>List of header keys separated by __RETURN__. Listed headers will be included in TR access log entries under the “rh=” token.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td>List of header name:value pairs separated by __RETURN__. Listed pairs will be included in all TR HTTP responses.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>int</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"deepCachingType"</span><span class="p">:</span> <span class="s2">"NEVER"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://foo.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"fqPacingRate"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"routingName"</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/:id</strong></p>
+<blockquote>
+<div><p>Retrieves a specific delivery service. If not admin / ops, delivery service must be assigned to user. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Delivery service ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="5%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">anonymousBlockingEnabled</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>true: enable blocking clients with anonymous ips</li>
+<li>false: disabled</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cacheurl</span></code></td>
+<td>string</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ccrDnsTtl</span></code></td>
+<td>int</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>int</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">checkPath</span></code></td>
+<td>string</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deepCachingType</span></code></td>
+<td>string</td>
+<td><p class="first">When to do Deep Caching for this Delivery Service:</p>
+<ul class="last simple">
+<li>NEVER (default)</li>
+<li>ALWAYS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp</span></code></td>
+<td>string</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp6</span></code></td>
+<td>string</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassTtl</span></code></td>
+<td>int</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td>
+<td>int</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">edgeHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fqPacingRate</span></code></td>
+<td>int</td>
+<td>The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded,
+will be rate limited by the Linux kernel. A default value of 0 disables this feature</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td>
+<td>int</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from USA</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td>
+<td>int</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td>
+<td>int</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpBypassFqdn</span></code></td>
+<td>string</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>The deliveryservice id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">infoUrl</span></code></td>
+<td>string</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<td>bool</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td>
+<td>string</td>
+<td>Description field.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td>
+<td>string</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc2</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">matchList</span></code></td>
+<td>array</td>
+<td>Array of matchList hashes.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>setNumber</span></code></td>
+<td>string</td>
+<td>The set Number of the matchList.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>pattern</span></code></td>
+<td>string</td>
+<td>The regexp for the matchList.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maxDnsAnswers</span></code></td>
+<td>int</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td>
+<td>float</td>
+<td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+- e.g. 39.7391500 or null</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td>
+<td>float</td>
+<td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+- e.g. -104.9847000 or null</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">orgServerFqdn</span></code></td>
+<td>string</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>int</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td>
+<td>int</td>
+<td><ul class="first last simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td>
+<td>int</td>
+<td>How to treat range requests:
+- 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)
+- 1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.
+- 2 Use the cache_range_requests plugin.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regexRemap</span></code></td>
+<td>string</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">remapText</span></code></td>
+<td>string</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routingName</span></code></td>
+<td>string</td>
+<td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">signed</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">signingAlgorithm</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>“url_sig”: URL Sign token based auth is enabled for this deliveryservice.</li>
+<li>“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>Owning tenant name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>int</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"deepCachingType"</span><span class="p">:</span> <span class="s2">"NEVER"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://foo.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"fqPacingRate"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"routingName"</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/:id/servers</strong></p>
+<blockquote>
+<div><p>Retrieves properties of CDN EDGE or ORG servers assigned to a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations or delivery service must be assigned to user.</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Delivery service ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/:id/servers/unassigned</strong></p>
+<blockquote>
+<div><p>Retrieves properties of CDN EDGE or ORG servers not assigned to a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations or delivery service must be assigned to user</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Delivery service ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/:id/servers/eligible</strong></p>
+<blockquote>
+<div><p>Retrieves properties of CDN EDGE or ORG servers not eligible for assignment to a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations or delivery service must be assigned to user</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Delivery service ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="health">
+<span id="to-api-v12-ds-health"></span><h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/deliveryservices/:id/state</strong></p>
+<blockquote>
+<div><p>Retrieves the failover state for a delivery service. Delivery service must be assigned to user if user is not admin or operations.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="12%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">failover</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>locations</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>destination</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>location</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>configured</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>enabled</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">enabled</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"failover"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
+ <span class="s2">"destination"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"location"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"DNS"</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="s2">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/:id/health</strong></p>
+<blockquote>
+<div><p>Retrieves the health of all locations (cache groups) for a delivery service. Delivery service must be assigned to user if user is not admin or operations.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="11%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">totalOnline</span></code></td>
+<td>int</td>
+<td>Total number of online caches across all CDNs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">totalOffline</span></code></td>
+<td>int</td>
+<td>Total number of offline caches across all CDNs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroups</span></code></td>
+<td>array</td>
+<td>A collection of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>online</span></code></td>
+<td>int</td>
+<td>The number of online caches for the cache group</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>offline</span></code></td>
+<td>int</td>
+<td>The number of offline caches for the cache
+group.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>Cache group name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/:id/capacity</strong></p>
+<blockquote>
+<div><p>Retrieves the capacity percentages of a delivery service. Delivery service must be assigned to user if user is not admin or operations.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>delivery service id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="10%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">availablePercent</span></code></td>
+<td>number</td>
+<td>The percentage of server capacity assigned to
+the delivery service that is available.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">unavailablePercent</span></code></td>
+<td>number</td>
+<td>The percentage of server capacity assigned to the
+delivery service that is unavailable.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">utilizedPercent</span></code></td>
+<td>number</td>
+<td>The percentage of server capacity assigned to the
+delivery service being used.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maintenancePercent</span></code></td>
+<td>number</td>
+<td>The percentage of server capacity assigned to the
+delivery service that is down for maintenance.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/:id/routing</strong></p>
+<blockquote>
+<div><p>Retrieves the routing method percentages of a delivery service. Delivery service must be assigned to user if user is not admin or operations.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>delivery service id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="5%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">staticRoute</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">miss</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geo</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">err</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice resulting in an error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cz</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF (coverage zone file) hit.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dsr</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the
+client to the overflow CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fed</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to a federated CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionalAlternate</span></code></td>
+<td>number</td>
+<td>The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to the alternate
+regional geoblocking URL.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionalDenied</span></code></td>
+<td>number</td>
+<td>The percent of Traffic Router requests for this deliveryservice denied due to geolocation policy.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"fed"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"regionalAlternate"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"regionalDenied"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="delivery-service-server">
+<span id="to-api-v12-ds-server"></span><h2>Delivery Service Server<a class="headerlink" href="#delivery-service-server" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/deliveryserviceserver</strong></p>
+<blockquote>
+<div><p>Retrieves delivery service / server assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">page</span></code></td>
+<td>no</td>
+<td>The page number for use in pagination.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">limit</span></code></td>
+<td>no</td>
+<td>For use in limiting the result set.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">server</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"orderby"</span><span class="p">:</span> <span class="s2">"deliveryservice"</span><span class="p">,</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:43"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"20"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:44"</span><span class="p">,</span>
+ <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="p">},</span>
+ <span class="p">],</span>
+ <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">2</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>POST /api/1.2/deliveryserviceserver</strong></p>
+<blockquote>
+<div><p>Create one or more delivery service / server assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations or the delivery service is assigned to the user.</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>The ID of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">servers</span></code></td>
+<td>yes</td>
+<td>An array of server IDs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>no</td>
+<td>Replace existing ds/server assignments? (true|false)</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="mi">246</span><span class="p">,</span>
+ <span class="s2">"servers"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>int</td>
+<td>The ID of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">servers</span></code></td>
+<td>array</td>
+<td>An array of server IDs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>array</td>
+<td>Existing ds/server assignments replaced? (true|false).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server assignments complete."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"dsId"</span> <span class="p">:</span> <span class="mi">246</span><span class="p">,</span>
+ <span class="s2">"servers"</span> <span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span> <span class="p">:</span> <span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/deliveryservice_server/:dsId/:serverId</strong></p>
+<blockquote>
+<div><p>Removes a server (cache) from a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Oper (if delivery service is not assigned to user)</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>Delivery service ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">serverId</span></code></td>
+<td>yes</td>
+<td>Server (cache) ID.</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<div><p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server unlinked from delivery service."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="delivery-service-user">
+<span id="to-api-v12-ds-user"></span><h2>Delivery Service User<a class="headerlink" href="#delivery-service-user" title="Permalink to this headline">¶</a></h2>
+<p><strong>POST /api/1.2/deliveryservice_user</strong></p>
+<blockquote>
+<div><p>Create one or more user / delivery service assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">userId</span></code></td>
+<td>yes</td>
+<td>The ID of the user.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServices</span></code></td>
+<td>yes</td>
+<td>An array of delivery service IDs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>no</td>
+<td>Replace existing user/ds assignments? (true|false).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"userId"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">23</span><span class="p">,</span> <span class="mi">34</span><span class="p">,</span> <span class="mi">45</span><span class="p">,</span> <span class="mi">56</span><span class="p">,</span> <span class="mi">67</span> <span class="p">],</span>
+ <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">userId</span></code></td>
+<td>int</td>
+<td>The ID of the user.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServices</span></code></td>
+<td>array</td>
+<td>An array of delivery service IDs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>array</td>
+<td>Existing user/ds assignments replaced? (true|false).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service assignments complete."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"userId"</span> <span class="p">:</span> <span class="mi">50</span><span class="p">,</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">23</span><span class="p">,</span> <span class="mi">34</span><span class="p">,</span> <span class="mi">45</span><span class="p">,</span> <span class="mi">56</span><span class="p">,</span> <span class="mi">67</span> <span class="p">],</span>
+ <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/deliveryservice_user/:dsId/:userId</strong></p>
+<blockquote>
+<div><p>Removes a delivery service from a user.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>Delivery service ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">userId</span></code></td>
+<td>yes</td>
+<td>User ID.</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<div><p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"User and delivery service were unlinked."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="ssl-keys">
+<span id="to-api-v12-ds-sslkeys"></span><h2>SSL Keys<a class="headerlink" href="#ssl-keys" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys</strong></p>
+<blockquote>
+<div><p>Retrieves ssl keys for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="15%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>no</td>
+<td>The version number to retrieve</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">decode</span></code></td>
+<td>no</td>
+<td>a boolean value to decode the certs or not</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="5%" />
+<col width="83%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">crt</span></code></td>
+<td>string</td>
+<td>base64 encoded (or not if decode=true) crt file for delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">csr</span></code></td>
+<td>string</td>
+<td>base64 encoded (or not if decode=true) csr file for delivery service</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>base64 encoded (or not if decode=true) private key file for delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>The CDN of the delivery service for which the certs were generated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td>
+<td>string</td>
+<td>The XML ID of the delivery service for which the cert was generated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">businessUnit</span></code></td>
+<td>string</td>
+<td>The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td>The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">organization</span></code></td>
+<td>string</td>
+<td>The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td>
+<td>string</td>
+<td>The hostname generated by Traffic Ops that is used as the common name when generating the certificate.
+This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td>The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td>The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>The version of the certificate record in Riak</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
+ <span class="p">},</span>
+ <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"my-ds"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"qa"</span><span class="p">,</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/hostname/:hostname/sslkeys</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="13%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td>
+<td>yes</td>
+<td>pristine hostname of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="15%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>no</td>
+<td>The version number to retrieve</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">decode</span></code></td>
+<td>no</td>
+<td>a boolean value to decode the certs or not</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="5%" />
+<col width="83%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">crt</span></code></td>
+<td>string</td>
+<td>base64 encoded (or not if decode=true) crt file for delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">csr</span></code></td>
+<td>string</td>
+<td>base64 encoded (or not if decode=true) csr file for delivery service</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>base64 encoded (or not if decode=true) private key file for delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>The CDN of the delivery service for which the certs were generated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td>
+<td>string</td>
+<td>The XML ID of the delivery service for which the cert was generated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">businessUnit</span></code></td>
+<td>string</td>
+<td>The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td>The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">organization</span></code></td>
+<td>string</td>
+<td>The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td>
+<td>string</td>
+<td>The hostname generated by Traffic Ops that is used as the common name when generating the certificate.
+This will be a FQDN for DNS delivery services and a wildcard URL for HTTP delivery services.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td>The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td>The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>The version of the certificate record in Riak</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
+ <span class="p">},</span>
+ <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"my-ds"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"qa"</span><span class="p">,</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys/delete</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role Required: Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="18%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>no</td>
+<td>The version number to retrieve</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>success response</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted ssl keys for <xml_id>"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/deliveryservices/sslkeys/generate</strong></p>
+<blockquote>
+<div><p>Generates SSL crt, csr, and private key for a delivery service</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operations</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="9%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>xml_id of the delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>version of the keys being generated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td>
+<td>string</td>
+<td>the <em>pristine hostname</em> of the delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td>Country</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td>State</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td>City</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">org</span></code></td>
+<td>string</td>
+<td>Organization</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">unit</span></code></td>
+<td>boolean</td>
+<td>Business Unit</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td>
+<td>string</td>
+<td>The deliveryservice xml-id for which you want to generate certs</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>The name of the CDN for which the deliveryservice belongs</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN Engineering"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
+ <span class="p">},</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
+ <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"Kabletown"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
+ <span class="s2">"deliveryservice"</span> <span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"cdn1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="36%" />
+<col width="21%" />
+<col width="44%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>response string</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully created ssl keys for ds-01"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/deliveryservices/sslkeys/add</strong></p>
+<blockquote>
+<div><p>Allows user to add SSL crt, csr, and private key for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operations</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="9%" />
+<col width="69%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td>xml_id of the delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>version of the keys being generated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">csr</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">crt</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td>
+<td>string</td>
+<td>The deliveryservice xml-id for which you want to generate certs</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>The name of the CDN for which the deliveryservice belongs</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">hostname</span></code></td>
+<td>string</td>
+<td>the <em>pristine hostname</em> of the delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
+ <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
+ <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="36%" />
+<col width="21%" />
+<col width="44%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>response string</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully added ssl keys for ds-01"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+<div class="section" id="url-sig-keys">
+<h2>URL Sig Keys<a class="headerlink" href="#url-sig-keys" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys</strong></p>
+<blockquote>
+<div><p>Retrieves URL sig keys for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="5%" />
+<col width="83%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">key0</span></code></td>
+<td>string</td>
+<td>base64 encoded key for delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">key2</span></code></td>
+<td>string</td>
+<td>base64 encoded key for delivery service</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keyn...</span></code></td>
+<td>string</td>
+<td>base64 encoded key for delivery service – repeats to 15 (16 total) and is currently unsorted.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="n">key9</span><span class="s2">":"</span><span class="n">ZvVQNYpPVQWQV8tjQnUl6osm4y7xK4zD</span><span class="s2">",</span>
+ <span class="s2">"key6"</span><span class="p">:</span><span class="s2">"JhGdpw5X9o8TqHfgezCm0bqb9SQPASWL"</span><span class="p">,</span>
+ <span class="s2">"key8"</span><span class="p">:</span><span class="s2">"ySXdp1T8IeDEE1OCMftzZb9EIw_20wwq"</span><span class="p">,</span>
+ <span class="s2">"key0"</span><span class="p">:</span><span class="s2">"D4AYzJ1AE2nYisA9MxMtY03TPDCHji9C"</span><span class="p">,</span>
+ <span class="s2">"key3"</span><span class="p">:</span><span class="s2">"W90YHlGc_kYlYw5_I0LrkpV9JOzSIneI"</span><span class="p">,</span>
+ <span class="s2">"key12"</span><span class="p">:</span><span class="s2">"ZbtMb3mrKqfS8hnx9_xWBIP_OPWlUpzc"</span><span class="p">,</span>
+ <span class="s2">"key2"</span><span class="p">:</span><span class="s2">"0qgEoDO7sUsugIQemZbwmMt0tNCwB1sf"</span><span class="p">,</span>
+ <span class="s2">"key4"</span><span class="p">:</span><span class="s2">"aFJ2Gb7atmxVB8uv7T9S6OaDml3ycpGf"</span><span class="p">,</span>
+ <span class="s2">"key1"</span><span class="p">:</span><span class="s2">"wnWNR1mCz1O4C7EFPtcqHd0xUMQyNFhA"</span><span class="p">,</span>
+ <span class="s2">"key11"</span><span class="p">:</span><span class="s2">"k6HMzlBH1x6htKkypRFfWQhAndQqe50e"</span><span class="p">,</span>
+ <span class="s2">"key10"</span><span class="p">:</span><span class="s2">"zYONfdD7fGYKj4kLvIj4U0918csuZO0d"</span><span class="p">,</span>
+ <span class="s2">"key15"</span><span class="p">:</span><span class="s2">"3360cGaIip_layZMc_0hI2teJbazxTQh"</span><span class="p">,</span>
+ <span class="s2">"key5"</span><span class="p">:</span><span class="s2">"SIwv3GOhWN7EE9wSwPFj18qE4M07sFxN"</span><span class="p">,</span>
+ <span class="s2">"key13"</span><span class="p">:</span><span class="s2">"SqQKBR6LqEOzp8AewZUCVtBcW_8YFc1g"</span><span class="p">,</span>
+ <span class="s2">"key14"</span><span class="p">:</span><span class="s2">"DtXsu8nsw04YhT0kNoKBhu2G3P9WRpQJ"</span><span class="p">,</span>
+ <span class="s2">"key7"</span><span class="p">:</span><span class="s2">"cmKoIIxXGAxUMdCsWvnGLoIMGmNiuT5I"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys/generate</strong></p>
+<blockquote>
+<div><p>Generates Url sig keys for a delivery service</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="36%" />
+<col width="21%" />
+<col width="44%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>response string</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully generated and stored keys"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/deliveryservices/xmlId/:xmlid/urlkeys/copyFromXmlId/:copyFromXmlId</strong></p>
+<blockquote>
+<div><p>Allows user to copy url sig keys from a specified delivery service to a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operations</p>
+</div></blockquote>
+<p><strong>Request Route Parameters</strong></p>
+<blockquote>
+<div><table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="11%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">copyFromXmlId</span></code></td>
+<td>yes</td>
+<td>xml_id of the delivery service to copy url sig keys from</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="36%" />
+<col width="21%" />
+<col width="44%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">response</span></code></td>
+<td>string</td>
+<td>response string</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td>API version</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully copied and stored keys"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>POST /api/1.2/deliveryservices/request</strong></p>
+<blockquote>
+<div><p>Allows a user to send delivery service request details to a specified email address.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="5%" />
+<col width="7%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">emailTo</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>The email to which the delivery service request will be sent.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">details</span></code></td>
+<td>hash</td>
+<td>yes</td>
+<td>Parameters for the delivery service request.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>customer</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Name of the customer to associated with the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>deepCachingType</span></code></td>
+<td>string</td>
+<td>no</td>
+<td><p class="first">When to do Deep Caching for this Delivery Service:</p>
+<ul class="last simple">
+<li>NEVER (default)</li>
+<li>ALWAYS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>deliveryProtocol</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Eg. http or http/https</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>routingType</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Eg. DNS or HTTP Redirect</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>routingName</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>The routing name for the delivery service, e.g. <routingName>.<xmlId>.cdn.com</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>serviceDesc</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>A description of the delivery service.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>peakBPSEstimate</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Used to manage cache efficiency and plan for capacity.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>peakTPSEstimate</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Used to manage cache efficiency and plan for capacity.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>maxLibrarySizeEstimate</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Used to manage cache efficiency and plan for capacity.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>originURL</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>The URL path to the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hasOriginDynamicRemap</span></code></td>
+<td>bool</td>
+<td>yes</td>
+<td>This is a feature which allows services to use multiple origin URLs for the same service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>originTestFile</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>A URL path to a test file available on the origin server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hasOriginACLWhitelist</span></code></td>
+<td>bool</td>
+<td>yes</td>
+<td>Is access to your origin restricted using an access control list (ACL or whitelist) of Ips?</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>originHeaders</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Header values that must be passed to requests to your origin.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>otherOriginSecurity</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Other origin security measures that need to be considered for access.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>queryStringHandling</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>How to handle query strings that come with the request.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>rangeRequestHandling</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>How to handle range requests.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>hasSignedURLs</span></code></td>
+<td>bool</td>
+<td>yes</td>
+<td>Are Urls signed?</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>hasNegativeCachingCustomization</span></code></td>
+<td>bool</td>
+<td>yes</td>
+<td>Any customization required for negative caching?</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>negativeCachingCustomizationNote</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Negative caching customization instructions.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>serviceAliases</span></code></td>
+<td>array</td>
+<td>no</td>
+<td>Service aliases which will be used for this service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>rateLimitingGBPS</span></code></td>
+<td>int</td>
+<td>no</td>
+<td>Rate Limiting - Bandwidth (Gbps)</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>rateLimitingTPS</span></code></td>
+<td>int</td>
+<td>no</td>
+<td>Rate Limiting - Transactions/Second</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>overflowService</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>An overflow point (URL or IP address) used if rate limits are met.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>headerRewriteEdge</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Headers can be added or altered at each layer of the CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>headerRewriteMid</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Headers can be added or altered at each layer of the CDN.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>headerRewriteRedirectRouter</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Headers can be added or altered at each layer of the CDN.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>notes</span></code></td>
+<td>string</td>
+<td>no</td>
+<td>Additional instructions to provide the delivery service provisioning team.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"emailTo"</span><span class="p">:</span> <span class="s2">"foo@bar.com"</span><span class="p">,</span>
+ <span class="s2">"details"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"customer"</span><span class="p">:</span> <span class="s2">"XYZ Corporation"</span><span class="p">,</span>
+ <span class="s2">"contentType"</span><span class="p">:</span> <span class="s2">"video-on-demand"</span><span class="p">,</span>
+ <span class="s2">"deepCachingType"</span><span class="p">:</span> <span class="s2">"NEVER"</span><span class="p">,</span>
+ <span class="s2">"deliveryProtocol"</span><span class="p">:</span> <span class="s2">"http"</span><span class="p">,</span>
+ <span class="s2">"routingType"</span><span class="p">:</span> <span class="s2">"dns"</span><span class="p">,</span>
+ <span class="s2">"routingName"</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span>
+ <span class="s2">"serviceDesc"</span><span class="p">:</span> <span class="s2">"service description goes here"</span><span class="p">,</span>
+ <span class="s2">"peakBPSEstimate"</span><span class="p">:</span> <span class="s2">"less-than-5-Gbps"</span><span class="p">,</span>
+ <span class="s2">"peakTPSEstimate"</span><span class="p">:</span> <span class="s2">"less-than-1000-TPS"</span><span class="p">,</span>
+ <span class="s2">"maxLibrarySizeEstimate"</span><span class="p">:</span> <span class="s2">"less-than-200-GB"</span><span class="p">,</span>
+ <span class="s2">"originURL"</span><span class="p">:</span> <span class="s2">"http://myorigin.com"</span><span class="p">,</span>
+ <span class="s2">"hasOriginDynamicRemap"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"originTestFile"</span><span class="p">:</span> <span class="s2">"http://myorigin.com/crossdomain.xml"</span><span class="p">,</span>
+ <span class="s2">"hasOriginACLWhitelist"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"originHeaders"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"otherOriginSecurity"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"queryStringHandling"</span><span class="p">:</span> <span class="s2">"ignore-in-cache-key-and-pass-up"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"range-requests-not-used"</span><span class="p">,</span>
+ <span class="s2">"hasSignedURLs"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"hasNegativeCachingCustomization"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"negativeCachingCustomizationNote"</span><span class="p">:</span> <span class="s2">"negative caching instructions"</span><span class="p">,</span>
+ <span class="s2">"serviceAliases"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://alias1.com"</span><span class="p">,</span>
+ <span class="s2">"http://alias2.com"</span>
+ <span class="p">],</span>
+ <span class="s2">"rateLimitingGBPS"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span>
+ <span class="s2">"rateLimitingTPS"</span><span class="p">:</span> <span class="mi">5000</span><span class="p">,</span>
+ <span class="s2">"overflowService"</span><span class="p">:</span> <span class="s2">"http://overflowcdn.com"</span><span class="p">,</span>
+ <span class="s2">"headerRewriteEdge"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"headerRewriteMid"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"headerRewriteRedirectRouter"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"notes"</span><span class="p">:</span> <span class="s2">""</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery Service request sent to foo@bar.com."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/deliveryservices</strong></p>
+<blockquote>
+<div><p>Allows user to create a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="7%" />
+<col width="72%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>active</td>
+<td>yes</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td>anonymousBlockingEnabled</td>
+<td>no</td>
+<td><ul class="first last simple">
+<li>true: enable blocking clients with anonymous ips</li>
+<li>false: disabled</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td>cacheurl</td>
+<td>no</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-odd"><td>ccrDnsTtl</td>
+<td>no</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host.</td>
+</tr>
+<tr class="row-even"><td>cdnId</td>
+<td>yes</td>
+<td>cdn id</td>
+</tr>
+<tr class="row-odd"><td>checkPath</td>
+<td>no</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-even"><td>deepCachingType</td>
+<td>no</td>
+<td><p class="first">When to do Deep Caching for this Delivery Service:</p>
+<ul class="last simple">
+<li>NEVER (default)</li>
+<li>ALWAYS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td>displayName</td>
+<td>yes</td>
+<td>Display name</td>
+</tr>
+<tr class="row-even"><td>dnsBypassCname</td>
+<td>no</td>
+<td>Bypass CNAME</td>
+</tr>
+<tr class="row-odd"><td>dnsBypassIp</td>
+<td>no</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td>dnsBypassIp6</td>
+<td>no</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td>dnsBypassTtl</td>
+<td>no</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-even"><td>dscp</td>
+<td>yes</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-odd"><td>edgeHeaderRewrite</td>
+<td>no</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td>fqPacingRate</td>
+<td>no</td>
+<td>The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded,
+will be rate limited by the Linux kernel. A default value of 0 disables this feature</td>
+</tr>
+<tr class="row-odd"><td>geoLimitRedirectURL</td>
+<td>no</td>
+<td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td>
+</tr>
+<tr class="row-even"><td>geoLimit</td>
+<td>yes</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from geo limit countries</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-odd"><td>geoLimitCountries</td>
+<td>no</td>
+<td>The geo limit countries.</td>
+</tr>
+<tr class="row-even"><td>geoProvider</td>
+<td>yes</td>
+<td><ul class="first last simple">
+<li>0: Maxmind(default)</li>
+<li>1: Neustar</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td>globalMaxMbps</td>
+<td>no</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-even"><td>globalMaxTps</td>
+<td>no</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-odd"><td>httpBypassFqdn</td>
+<td>no</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more
+than the globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td>infoUrl</td>
+<td>no</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td>initialDispersion</td>
+<td>yes|no</td>
+<td>Initial dispersion. Required for HTTP* delivery services.</td>
+</tr>
+<tr class="row-even"><td>ipv6RoutingEnabled</td>
+<td>yes|no</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.
+Required for DNS*, HTTP* and STEERING* delivery services.</td>
+</tr>
+<tr class="row-odd"><td>logsEnabled</td>
+<td>yes</td>
+<td><ul class="first last simple">
+<li>false: No</li>
+<li>true: Yes</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td>longDesc</td>
+<td>no</td>
+<td>Description field.</td>
+</tr>
+<tr class="row-odd"><td>longDesc1</td>
+<td>no</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-even"><td>longDesc2</td>
+<td>no</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td>maxDnsAnswers</td>
+<td>no</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-even"><td>midHeaderRewrite</td>
+<td>no</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td>missLat</td>
+<td>yes|no</td>
+<td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services.</td>
+</tr>
+<tr class="row-even"><td>missLong</td>
+<td>yes|no</td>
+<td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services.</td>
+</tr>
+<tr class="row-odd"><td>multiSiteOrigin</td>
+<td>yes|no</td>
+<td>true if enabled, false if disabled. Required for DNS* and HTTP* delivery services.</td>
+</tr>
+<tr class="row-even"><td>orgServerFqdn</td>
+<td>yes|no</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server. This field is
+required if type is DNS* or HTTP*.</td>
+</tr>
+<tr class="row-odd"><td>originShield</td>
+<td>no</td>
+<td>Origin shield</td>
+</tr>
+<tr class="row-even"><td>profileId</td>
+<td>no</td>
+<td>DS profile ID</td>
+</tr>
+<tr class="row-odd"><td>protocol</td>
+<td>yes|no</td>
+<td><ul class="first simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+<p class="last">Required for DNS*, HTTP* or <em>STEERING</em> delivery services.</p>
+</td>
+</tr>
+<tr class="row-even"><td>qstringIgnore</td>
+<td>yes|no</td>
+<td><ul class="first simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+<p class="last">Required for DNS* and HTTP* delivery services.</p>
+</td>
+</tr>
+<tr class="row-odd"><td>rangeRequestHandling</td>
+<td>yes|no</td>
+<td>How to treat range requests (required for DNS* and HTTP* delivery services):
+- 0 Do not cache (ranges requested from files taht are already cached due to a non range request will
+be a HIT)
+- 1 Use the background_fetch plugin.
+- 2 Use the cache_range_requests plugin.</td>
+</tr>
+<tr class="row-even"><td>regexRemap</td>
+<td>no</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td>regionalGeoBlocking</td>
+<td>yes</td>
+<td>Is the Regional Geo Blocking feature enabled.</td>
+</tr>
+<tr class="row-even"><td>remapText</td>
+<td>no</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-odd"><td>routingName</td>
+<td>yes</td>
+<td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td>
+</tr>
+<tr class="row-even"><td>signed</td>
+<td>no</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td>signingAlgorithm</td>
+<td>no</td>
+<td><ul class="first last simple">
+<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>“url_sig”: URL Sign token based auth is enabled for this deliveryservice.</li>
+<li>“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td>sslKeyVersion</td>
+<td>no</td>
+<td>SSL key version</td>
+</tr>
+<tr class="row-odd"><td>tenantId</td>
+<td>No</td>
+<td>Owning tenant ID</td>
+</tr>
+<tr class="row-even"><td>trRequestHeaders</td>
+<td>no</td>
+<td>Traffic router log request headers</td>
+</tr>
+<tr class="row-odd"><td>trResponseHeaders</td>
+<td>no</td>
+<td>Traffic router additional response headers</td>
+</tr>
+<tr class="row-even"><td>typeId</td>
+<td>yes</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td>xmlId</td>
+<td>yes</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"my_ds_1"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"my_ds_displayname_1"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://10.75.168.91"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">42</span><span class="p">,</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="mf">39.7391500</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="o">-</span><span class="mf">104.9847000</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="5%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">anonymousBlockingEnabled</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>true: enable blocking clients with anonymous ips</li>
+<li>false: disabled</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cacheurl</span></code></td>
+<td>string</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ccrDnsTtl</span></code></td>
+<td>int</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>int</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">checkPath</span></code></td>
+<td>string</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deepCachingType</span></code></td>
+<td>string</td>
+<td><p class="first">When to do Deep Caching for this Delivery Service:</p>
+<ul class="last simple">
+<li>NEVER (default)</li>
+<li>ALWAYS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp</span></code></td>
+<td>string</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp6</span></code></td>
+<td>string</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassTtl</span></code></td>
+<td>int</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td>
+<td>int</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">edgeHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fqPacingRate</span></code></td>
+<td>int</td>
+<td>The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded,
+will be rate limited by the Linux kernel. A default value of 0 disables this feature</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td>
+<td>int</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from USA</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td>
+<td>int</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td>
+<td>int</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpBypassFqdn</span></code></td>
+<td>string</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>The deliveryservice id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">infoUrl</span></code></td>
+<td>string</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<td>bool</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td>
+<td>string</td>
+<td>Description field.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td>
+<td>string</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc2</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">matchList</span></code></td>
+<td>array</td>
+<td>Array of matchList hashes.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>setNumber</span></code></td>
+<td>string</td>
+<td>The set Number of the matchList.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>pattern</span></code></td>
+<td>string</td>
+<td>The regexp for the matchList.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maxDnsAnswers</span></code></td>
+<td>int</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td>
+<td>float</td>
+<td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+- e.g. 39.7391500 or null</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td>
+<td>float</td>
+<td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+- e.g. -104.9847000 or null</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">orgServerFqdn</span></code></td>
+<td>string</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>int</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td>
+<td>int</td>
+<td><ul class="first last simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td>
+<td>int</td>
+<td>How to treat range requests:
+- 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)
+- 1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.
+- 2 Use the cache_range_requests plugin.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regexRemap</span></code></td>
+<td>string</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">remapText</span></code></td>
+<td>string</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routingName</span></code></td>
+<td>string</td>
+<td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">signed</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">signingAlgorithm</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>“url_sig”: URL Sign token based auth is enabled for this deliveryservice.</li>
+<li>“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>int</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"deepCachingType"</span><span class="p">:</span> <span class="s2">"NEVER"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://foo.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"fqPacingRate"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"routingName"</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/deliveryservices/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to edit a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>delivery service id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="7%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>active</td>
+<td>yes</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td>anonymousBlockingEnabled</td>
+<td>no</td>
+<td><ul class="first last simple">
+<li>true: enable blocking clients with anonymous ips</li>
+<li>false: disabled</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td>cacheurl</td>
+<td>no</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-odd"><td>ccrDnsTtl</td>
+<td>no</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host.</td>
+</tr>
+<tr class="row-even"><td>cdnId</td>
+<td>yes</td>
+<td>cdn id</td>
+</tr>
+<tr class="row-odd"><td>checkPath</td>
+<td>no</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-even"><td>deepCachingType</td>
+<td>no</td>
+<td><p class="first">When to do Deep Caching for this Delivery Service:</p>
+<ul class="last simple">
+<li>NEVER (default)</li>
+<li>ALWAYS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td>displayName</td>
+<td>yes</td>
+<td>Display name</td>
+</tr>
+<tr class="row-even"><td>dnsBypassCname</td>
+<td>no</td>
+<td>Bypass CNAME</td>
+</tr>
+<tr class="row-odd"><td>dnsBypassIp</td>
+<td>no</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td>dnsBypassIp6</td>
+<td>no</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td>dnsBypassTtl</td>
+<td>no</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-even"><td>dscp</td>
+<td>yes</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-odd"><td>edgeHeaderRewrite</td>
+<td>no</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td>fqPacingRate</td>
+<td>no</td>
+<td>The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded,
+will be rate limited by the Linux kernel. A default value of 0 disables this feature</td>
+</tr>
+<tr class="row-odd"><td>geoLimitRedirectURL</td>
+<td>no</td>
+<td>This is the URL Traffic Router will redirect to when Geo Limit Failure.</td>
+</tr>
+<tr class="row-even"><td>geoLimit</td>
+<td>yes</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from geo limit countries</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-odd"><td>geoLimitCountries</td>
+<td>no</td>
+<td>The geo limit countries.</td>
+</tr>
+<tr class="row-even"><td>geoProvider</td>
+<td>yes</td>
+<td><ul class="first last simple">
+<li>0: Maxmind(default)</li>
+<li>1: Neustar</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td>globalMaxMbps</td>
+<td>no</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-even"><td>globalMaxTps</td>
+<td>no</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-odd"><td>httpBypassFqdn</td>
+<td>no</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more
+than the globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td>infoUrl</td>
+<td>no</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td>initialDispersion</td>
+<td>yes|no</td>
+<td>Initial dispersion. Required for HTTP* delivery services.</td>
+</tr>
+<tr class="row-even"><td>ipv6RoutingEnabled</td>
+<td>yes|no</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.
+Required for DNS*, HTTP* and STEERING* delivery services.</td>
+</tr>
+<tr class="row-odd"><td>logsEnabled</td>
+<td>yes</td>
+<td><ul class="first last simple">
+<li>false: No</li>
+<li>true: Yes</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td>longDesc</td>
+<td>no</td>
+<td>Description field.</td>
+</tr>
+<tr class="row-odd"><td>longDesc1</td>
+<td>no</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-even"><td>longDesc2</td>
+<td>no</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td>maxDnsAnswers</td>
+<td>no</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-even"><td>midHeaderRewrite</td>
+<td>no</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td>missLat</td>
+<td>yes|no</td>
+<td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+e.g. 39.7391500 or null. Required for DNS* and HTTP* delivery services.</td>
+</tr>
+<tr class="row-even"><td>missLong</td>
+<td>yes|no</td>
+<td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+e.g. -104.9847000 or null. Required for DNS* and HTTP* delivery services.</td>
+</tr>
+<tr class="row-odd"><td>multiSiteOrigin</td>
+<td>yes|no</td>
+<td>true if enabled, false if disabled. Required for DNS* and HTTP* delivery services.</td>
+</tr>
+<tr class="row-even"><td>orgServerFqdn</td>
+<td>yes|no</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server. This field is
+required if type is DNS* or HTTP*.</td>
+</tr>
+<tr class="row-odd"><td>originShield</td>
+<td>no</td>
+<td>Origin shield</td>
+</tr>
+<tr class="row-even"><td>profileId</td>
+<td>no</td>
+<td>DS profile ID</td>
+</tr>
+<tr class="row-odd"><td>protocol</td>
+<td>yes|no</td>
+<td><ul class="first simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+<p class="last">Required for DNS*, HTTP* or <em>STEERING</em> delivery services.</p>
+</td>
+</tr>
+<tr class="row-even"><td>qstringIgnore</td>
+<td>yes|no</td>
+<td><ul class="first simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+<p class="last">Required for DNS* and HTTP* delivery services.</p>
+</td>
+</tr>
+<tr class="row-odd"><td>rangeRequestHandling</td>
+<td>yes|no</td>
+<td>How to treat range requests (required for DNS* and HTTP* delivery services):
+- 0 Do not cache (ranges requested from files taht are already cached due to a non range request will
+be a HIT)
+- 1 Use the background_fetch plugin.
+- 2 Use the cache_range_requests plugin.</td>
+</tr>
+<tr class="row-even"><td>regexRemap</td>
+<td>no</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td>regionalGeoBlocking</td>
+<td>yes</td>
+<td>Is the Regional Geo Blocking feature enabled.</td>
+</tr>
+<tr class="row-even"><td>remapText</td>
+<td>no</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-odd"><td>routingName</td>
+<td>yes</td>
+<td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td>
+</tr>
+<tr class="row-even"><td>signed</td>
+<td>no</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td>signingAlgorithm</td>
+<td>no</td>
+<td><ul class="first last simple">
+<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>“url_sig”: URL Sign token based auth is enabled for this deliveryservice.</li>
+<li>“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td>sslKeyVersion</td>
+<td>no</td>
+<td>SSL key version</td>
+</tr>
+<tr class="row-odd"><td>tenantId</td>
+<td>No</td>
+<td>Owning tenant ID</td>
+</tr>
+<tr class="row-even"><td>trRequestHeaders</td>
+<td>no</td>
+<td>Traffic router log request headers</td>
+</tr>
+<tr class="row-odd"><td>trResponseHeaders</td>
+<td>no</td>
+<td>Traffic router additional response headers</td>
+</tr>
+<tr class="row-even"><td>typeId</td>
+<td>yes</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td>xmlId</td>
+<td>yes</td>
+<td>Unique string that describes this deliveryservice. This value cannot be changed on update.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"my_ds_1"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"my_ds_displayname_1"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://10.75.168.91"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">42</span><span class="p">,</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="mf">39.7391500</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="o">-</span><span class="mf">104.9847000</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="5%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">anonymousBlockingEnabled</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>true: enable blocking clients with anonymous ips</li>
+<li>false: disabled</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cacheurl</span></code></td>
+<td>string</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ccrDnsTtl</span></code></td>
+<td>int</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>int</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">checkPath</span></code></td>
+<td>string</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deepCachingType</span></code></td>
+<td>string</td>
+<td><p class="first">When to do Deep Caching for this Delivery Service:</p>
+<ul class="last simple">
+<li>NEVER (default)</li>
+<li>ALWAYS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp</span></code></td>
+<td>string</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp6</span></code></td>
+<td>string</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassTtl</span></code></td>
+<td>int</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td>
+<td>int</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">edgeHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fqPacingRate</span></code></td>
+<td>int</td>
+<td>The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded,
+will be rate limited by the Linux kernel. A default value of 0 disables this feature</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td>
+<td>int</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from USA</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td>
+<td>int</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td>
+<td>int</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpBypassFqdn</span></code></td>
+<td>string</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>The deliveryservice id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">infoUrl</span></code></td>
+<td>string</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<td>bool</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td>
+<td>string</td>
+<td>Description field.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td>
+<td>string</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc2</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">matchList</span></code></td>
+<td>array</td>
+<td>Array of matchList hashes.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>setNumber</span></code></td>
+<td>string</td>
+<td>The set Number of the matchList.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>pattern</span></code></td>
+<td>string</td>
+<td>The regexp for the matchList.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maxDnsAnswers</span></code></td>
+<td>int</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td>
+<td>float</td>
+<td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+- e.g. 39.7391500 or null</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td>
+<td>float</td>
+<td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+- e.g. -104.9847000 or null</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">orgServerFqdn</span></code></td>
+<td>string</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>int</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td>
+<td>int</td>
+<td><ul class="first last simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td>
+<td>int</td>
+<td>How to treat range requests:
+- 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)
+- 1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.
+- 2 Use the cache_range_requests plugin.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regexRemap</span></code></td>
+<td>string</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">remapText</span></code></td>
+<td>string</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routingName</span></code></td>
+<td>string</td>
+<td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">signed</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">signingAlgorithm</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>“url_sig”: URL Sign token based auth is enabled for this deliveryservice.</li>
+<li>“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>int</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"deepCachingType"</span><span class="p">:</span> <span class="s2">"NEVER"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://foo.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"fqPacingRate"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"routingName"</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/deliveryservices/{:id}/safe</strong></p>
+<blockquote>
+<div><p>Allows a user to edit limited fields of an assigned delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: users with the delivery service assigned or ops and above</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>delivery service id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="7%" />
+<col width="76%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>displayName</td>
+<td>no</td>
+<td>Display name</td>
+</tr>
+<tr class="row-odd"><td>infoUrl</td>
+<td>no</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td>longDesc</td>
+<td>no</td>
+<td>Description field.</td>
+</tr>
+<tr class="row-odd"><td>longDesc1</td>
+<td>no</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-even"><td>all other fields</td>
+<td>n/a</td>
+<td>All other fields will be silently ignored</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">"www.info.com"</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">"some info about the service"</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">"the customer label"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="5%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">anonymousBlockingEnabled</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>true: enable blocking clients with anonymous ips</li>
+<li>false: disabled</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cacheurl</span></code></td>
+<td>string</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ccrDnsTtl</span></code></td>
+<td>int</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>int</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">checkPath</span></code></td>
+<td>string</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deepCachingType</span></code></td>
+<td>string</td>
+<td><p class="first">When to do Deep Caching for this Delivery Service:</p>
+<ul class="last simple">
+<li>NEVER (default)</li>
+<li>ALWAYS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassCname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp</span></code></td>
+<td>string</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp6</span></code></td>
+<td>string</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassTtl</span></code></td>
+<td>int</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td>
+<td>int</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">edgeHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fqPacingRate</span></code></td>
+<td>int</td>
+<td>The maximum rate in bytes per second for each TCP connection in this delivery service. If exceeded,
+will be rate limited by the Linux kernel. A default value of 0 disables this feature</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td>
+<td>int</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from USA</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td>
+<td>int</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td>
+<td>int</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpBypassFqdn</span></code></td>
+<td>string</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>The deliveryservice id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">infoUrl</span></code></td>
+<td>string</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<td>bool</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td>
+<td>string</td>
+<td>Description field.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td>
+<td>string</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc2</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">matchList</span></code></td>
+<td>array</td>
+<td>Array of matchList hashes.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>setNumber</span></code></td>
+<td>string</td>
+<td>The set Number of the matchList.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>pattern</span></code></td>
+<td>string</td>
+<td>The regexp for the matchList.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">maxDnsAnswers</span></code></td>
+<td>int</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td>
+<td>float</td>
+<td>The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+- e.g. 39.7391500 or null</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td>
+<td>float</td>
+<td>The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.
+- e.g. -104.9847000 or null</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">orgServerFqdn</span></code></td>
+<td>string</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>int</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td>
+<td>int</td>
+<td><ul class="first last simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td>
+<td>int</td>
+<td>How to treat range requests:
+- 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)
+- 1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.
+- 2 Use the cache_range_requests plugin.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regexRemap</span></code></td>
+<td>string</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">remapText</span></code></td>
+<td>string</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routingName</span></code></td>
+<td>string</td>
+<td>The routing name of this deliveryservice, e.g. <routingName>.<xmlId>.cdn.com.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">signed</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">signingAlgorithm</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>null: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>“url_sig”: URL Sign token based auth is enabled for this deliveryservice.</li>
+<li>“uri_signing”: URI Signing token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>int</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"anonymousBlockingEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"deepCachingType"</span><span class="p">:</span> <span class="s2">"NEVER"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://foo.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"fqPacingRate"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">"www.info.com"</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">"some info about the service"</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">"the customer label"</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"routingName"</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"signingAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/deliveryservices/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to delete a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>delivery service id.</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<div><p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service was deleted."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/deliveryservices/:xml_id/servers</strong></p>
+<blockquote>
+<div><p>Assign caches to a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="19%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>xml_id</td>
+<td>yes</td>
+<td>the xml_id of the deliveryservice</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="8%" />
+<col width="82%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>serverNames</td>
+<td>yes</td>
+<td>array of hostname of cache servers to assign to this deliveryservice, for example: [ “server1”, “server2” ]</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"tc1_ats1"</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="6%" />
+<col width="83%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>xml_id</td>
+<td>string</td>
+<td>Unique string that describes this delivery service.</td>
+</tr>
+<tr class="row-odd"><td>serverNames</td>
+<td>string</td>
+<td>array of hostname of cache servers to assign to this deliveryservice, for example: [ “server1”, “server2” ]</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<div><p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"serverNames"</span><span class="p">:[</span>
+ <span class="s2">"tc1_ats1"</span>
+ <span class="p">],</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span><span class="s2">"my_ds_1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+<div class="section" id="uri-signing-keys">
+<h2>URI Signing Keys<a class="headerlink" href="#uri-signing-keys" title="Permalink to this headline">¶</a></h2>
+<p><strong>DELETE /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p>
+<blockquote>
+<div><p>Deletes URISigning objects for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>xml_id</td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>GET /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p>
+<blockquote>
+<div><p>Retrieves one or more URISigning objects for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>xml_id</td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="5%" />
+<col width="83%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">Issuer</span></code></td>
+<td>string</td>
+<td>a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">renewal_kid</span></code></td>
+<td>string</td>
+<td>a string naming the jwt key used for renewals.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keys</span></code></td>
+<td>string</td>
+<td>json array of jwt symmetric keys .</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alg</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">kid</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">kty</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">k</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"Kabletown URI Authority"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"renewal_kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span>
+ <span class="s2">"keys"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span>
+ <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"First Key"</span><span class="p">,</span>
+ <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span>
+ <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span>
+ <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span>
+ <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span>
+ <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>POST /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p>
+<blockquote>
+<div><p>Assigns URISigning objects to a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>xml_id</td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="5%" />
+<col width="83%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">Issuer</span></code></td>
+<td>string</td>
+<td>a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">renewal_kid</span></code></td>
+<td>string</td>
+<td>a string naming the jwt key used for renewals.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keys</span></code></td>
+<td>string</td>
+<td>json array of jwt symmetric keys .</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alg</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">kid</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">kty</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">k</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"Kabletown URI Authority"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"renewal_kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span>
+ <span class="s2">"keys"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span>
+ <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"First Key"</span><span class="p">,</span>
+ <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span>
+ <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span>
+ <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span>
+ <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span>
+ <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>PUT /api/1.2/deliveryservices/:xml_id/urisignkeys</strong></p>
+<blockquote>
+<div><p>updates URISigning objects on a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="16%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>xml_id</td>
+<td>yes</td>
+<td>xml_id of the desired delivery service</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="5%" />
+<col width="83%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">Issuer</span></code></td>
+<td>string</td>
+<td>a string describing the issuer of the URI signing object. Multiple URISigning objects may be returned in a response, see example</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">renewal_kid</span></code></td>
+<td>string</td>
+<td>a string naming the jwt key used for renewals.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keys</span></code></td>
+<td>string</td>
+<td>json array of jwt symmetric keys .</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alg</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the jwa encryption algorithm to use with this key, RFC 7518.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">kid</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the unique id for the key as defined in RFC 7516.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">kty</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the key type as defined in RFC 7516.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">k</span></code></td>
+<td>string</td>
+<td>this parameter repeats for each jwt key in the array and specifies the base64 encoded symmetric key see RFC 7516.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"Kabletown URI Authority"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"renewal_kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span>
+ <span class="s2">"keys"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span>
+ <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"First Key"</span><span class="p">,</span>
+ <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span>
+ <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"Kh_RkUMj-fzbD37qBnDf_3e_RvQ3RP9PaSmVEpE24AM"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"alg"</span><span class="p">:</span> <span class="s2">"HS256"</span><span class="p">,</span>
+ <span class="s2">"kid"</span><span class="p">:</span> <span class="s2">"Second Key"</span><span class="p">,</span>
+ <span class="s2">"kty"</span><span class="p">:</span> <span class="s2">"oct"</span><span class="p">,</span>
+ <span class="s2">"k"</span><span class="p">:</span> <span class="s2">"fZBpDBNbk2GqhwoB_DGBAsBxqQZVix04rIoLJ7p_RlE"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="deliveryservice_regex.html" class="btn btn-neutral float-right" title="Delivery Service Regexes">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="configfiles_ats.html" class="btn btn-neutral" title="Config Files and Config File Metadata"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/deliveryservice_regex.html b/docs/latest/api/v12/deliveryservice_regex.html
new file mode 100644
index 0000000..8ef6def
--- /dev/null
+++ b/docs/latest/api/v12/deliveryservice_regex.html
@@ -0,0 +1,859 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Delivery Service Regexes — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Delivery Service Statistics" href="deliveryservice_stats.html"/>
+ <link rel="prev" title="Delivery Service" href="deliveryservice.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Delivery Service Regexes</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/deliveryservice_regex.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="deliveryservice_stats.html" class="btn btn-neutral float-right" title="Delivery Service Statistics">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="delivery-service-regexes">
+<span id="to-api-v12-ds-regexes"></span><h1>Delivery Service Regexes<a class="headerlink" href="#delivery-service-regexes" title="Permalink to this headline">¶</a></h1>
+<p id="to-api-v12-ds-regexes-route"><strong>GET /api/1.2/deliveryservices_regexes</strong></p>
+<blockquote>
+<div><p>Retrieves regexes for all delivery services.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Oper</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsName</span></code></td>
+<td>array</td>
+<td>Delivery service name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regexes</span></code></td>
+<td>array</td>
+<td>An array of regexes for the delivery service.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>type</span></code></td>
+<td>string</td>
+<td>The regex type.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>pattern</span></code></td>
+<td>string</td>
+<td>The regex pattern.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>setNumber</span></code></td>
+<td>string</td>
+<td>The order in which the regex is evaluated.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"dsName"</span><span class="p">:</span> <span class="s2">"foo-bar"</span><span class="p">,</span>
+ <span class="s2">"regexes"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">"foo.bar.com"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">},</span>
+ <span class="p">{</span> <span class="o">...</span> <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/{:dsId}/regexes</strong></p>
+<blockquote>
+<div><p>Retrieves regexes for a specific delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>Delivery service id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Delivery service regex ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Delivery service regex type ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>Delivery service regex type name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">pattern</span></code></td>
+<td>string</td>
+<td>Delivery service regex pattern.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">setNumber</span></code></td>
+<td>string</td>
+<td>The order in which the regex is evaluated for the delivery service.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">852</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">853</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">"foo.bar.com"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/deliveryservices/{:dsId}/regexes/{:id}</strong></p>
+<blockquote>
+<div><p>Retrieves a regex for a specific delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>Delivery service id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Delivery service regex id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Delivery service regex ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Delivery service regex type ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>Delivery service regex type name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">pattern</span></code></td>
+<td>string</td>
+<td>Delivery service regex pattern.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">setNumber</span></code></td>
+<td>string</td>
+<td>The order in which the regex is evaluated for the delivery service.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">852</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/deliveryservices/{:dsId}/regexes</strong></p>
+<blockquote>
+<div><p>Create a regex for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>Delivery service id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="14%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">pattern</span></code></td>
+<td>yes</td>
+<td>Regex pattern.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>yes</td>
+<td>Regex type ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">setNumber</span></code></td>
+<td>yes</td>
+<td>Regex type ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Delivery service regex ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Delivery service regex type ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>Delivery service regex type name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">pattern</span></code></td>
+<td>string</td>
+<td>Delivery service regex pattern.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">setNumber</span></code></td>
+<td>string</td>
+<td>The order in which the regex is evaluated for the delivery service.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">852</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service regex creation was successful."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/deliveryservices/{:dsId}/regexes/{:id}</strong></p>
+<blockquote>
+<div><p>Update a regex for a delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>Delivery service id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Delivery service regex id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="14%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">pattern</span></code></td>
+<td>yes</td>
+<td>Regex pattern.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>yes</td>
+<td>Regex type ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">setNumber</span></code></td>
+<td>yes</td>
+<td>Regex type ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="8%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Delivery service regex ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Delivery service regex type ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeName</span></code></td>
+<td>string</td>
+<td>Delivery service regex type name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">pattern</span></code></td>
+<td>string</td>
+<td>Delivery service regex pattern.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">setNumber</span></code></td>
+<td>string</td>
+<td>The order in which the regex is evaluated for the delivery service.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">852</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span>
+ <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*\.foo-bar\..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="mi">0</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service regex update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/deliveryservices/{:dsId}/regexes/{:id}</strong></p>
+<blockquote>
+<div><p>Delete delivery service regex.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>Delivery service id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Delivery service regex id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service regex delete was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="deliveryservice_stats.html" class="btn btn-neutral float-right" title="Delivery Service Statistics">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="deliveryservice.html" class="btn btn-neutral" title="Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/deliveryservice_stats.html b/docs/latest/api/v12/deliveryservice_stats.html
new file mode 100644
index 0000000..f7e684e
--- /dev/null
+++ b/docs/latest/api/v12/deliveryservice_stats.html
@@ -0,0 +1,494 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Delivery Service Statistics — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Divisions" href="division.html"/>
+ <link rel="prev" title="Delivery Service Regexes" href="deliveryservice_regex.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Delivery Service Statistics</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/deliveryservice_stats.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="division.html" class="btn btn-neutral float-right" title="Divisions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="deliveryservice_regex.html" class="btn btn-neutral" title="Delivery Service Regexes"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="delivery-service-statistics">
+<span id="to-api-v12-ds-stats"></span><h1>Delivery Service Statistics<a class="headerlink" href="#delivery-service-statistics" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-deliveryservice-stats">
+<span id="to-api-v12-ds-stats-route"></span><h2>/api/1.2/deliveryservice_stats<a class="headerlink" href="#api-1-2-deliveryservice-stats" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/deliveryservice_stats.json</strong></p>
+<blockquote>
+<div><p>Retrieves statistics on the delivery services. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryServiceName</span></code></td>
+<td>yes</td>
+<td>The delivery service with the desired stats</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">metricType</span></code></td>
+<td>yes</td>
+<td>The metric type (valid metric types: ‘kbps’, ‘out_bytes’, ‘status_4xx’, ‘status_5xx’, tps_total’, ‘tps_2xx’,’tps_3xx’, ‘tps_4xx’, ‘tps_5xx’)</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">startDate</span></code></td>
+<td>yes</td>
+<td>The begin date (Formatted as ISO8601, for example: ‘2015-08-11T12:30:00-06:00’)</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">endDate</span></code></td>
+<td>yes</td>
+<td>The end date (Formatted as ISO8601, for example: ‘2015-08-12T12:30:00-06:00’)</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="11%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">source</span></code></td>
+<td>string</td>
+<td>The source of the data</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">summary</span></code></td>
+<td>hash</td>
+<td>Summary data</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>totalBytes</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>min</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>max</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>fifthPercentile</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>ninetyEighthPercentile</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>ninetyFifthPercentile</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>average</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>totalTransactions</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">series</span></code></td>
+<td>hash</td>
+<td>Series data</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>count</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>columns</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>values</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>time</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>value</span></code></td>
+<td>float</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"source"</span><span class="p">:</span> <span class="s2">"TrafficStats"</span><span class="p">,</span>
+ <span class="s2">"summary"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"average"</span><span class="p">:</span> <span class="mf">1081172.785</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">28</span><span class="p">,</span>
+ <span class="s2">"fifthPercentile"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span>
+ <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1326680.31</span><span class="p">,</span>
+ <span class="s2">"min"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span>
+ <span class="s2">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span>
+ <span class="s2">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span>
+ <span class="s2">"totalBytes"</span><span class="p">:</span> <span class="mf">37841047.475</span><span class="p">,</span>
+ <span class="s2">"totalTransactions"</span><span class="p">:</span> <span class="mi">1020202030101</span>
+ <span class="p">},</span>
+ <span class="s2">"series"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"columns"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"time"</span><span class="p">,</span>
+ <span class="s2">""</span>
+ <span class="p">],</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">60</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"kbps"</span><span class="p">,</span>
+ <span class="s2">"tags"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"total"</span>
+ <span class="p">},</span>
+ <span class="s2">"values"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-11T11:36:00Z"</span><span class="p">,</span>
+ <span class="mf">888827.26</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-11T11:37:00Z"</span><span class="p">,</span>
+ <span class="mf">980336.563333333</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-11T11:38:00Z"</span><span class="p">,</span>
+ <span class="mf">952111.975</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-11T11:39:00Z"</span><span class="p">,</span>
+ <span class="n">null</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-11T11:43:00Z"</span><span class="p">,</span>
+ <span class="n">null</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-11T11:44:00Z"</span><span class="p">,</span>
+ <span class="mf">934682.943333333</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-11T11:45:00Z"</span><span class="p">,</span>
+ <span class="mf">1251121.28</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="s2">"2015-08-11T11:46:00Z"</span><span class="p">,</span>
+ <span class="mf">1111012.99</span>
+ <span class="p">]</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="division.html" class="btn btn-neutral float-right" title="Divisions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="deliveryservice_regex.html" class="btn btn-neutral" title="Delivery Service Regexes"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/division.html b/docs/latest/api/v12/division.html
new file mode 100644
index 0000000..00eed04
--- /dev/null
+++ b/docs/latest/api/v12/division.html
@@ -0,0 +1,585 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Divisions — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Federation" href="federation.html"/>
+ <link rel="prev" title="Delivery Service Statistics" href="deliveryservice_stats.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Divisions</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/division.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation.html" class="btn btn-neutral float-right" title="Federation">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="deliveryservice_stats.html" class="btn btn-neutral" title="Delivery Service Statistics"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="divisions">
+<span id="to-api-v12-division"></span><h1>Divisions<a class="headerlink" href="#divisions" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-divisions">
+<span id="to-api-v12-division-route"></span><h2>/api/1.2/divisions<a class="headerlink" href="#api-1-2-divisions" title="Permalink to this headline">¶</a></h2>
+<dl class="docutils">
+<dt><strong>GET /api/1.2/divisions</strong></dt>
+<dd><p class="first">Get all divisions.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Division id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Division name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Central"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"West"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>GET /api/1.2/divisions/:id</strong></dt>
+<dd><p class="first">Get division by Id.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Division id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Division name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Central"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>PUT /api/1.2/divisions/:id</strong></dt>
+<dd><p class="first">Update a division</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Division id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="21%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the division</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Division update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/divisions</strong></dt>
+<dd><p class="first">Create division</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="21%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the division</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'4'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation.html" class="btn btn-neutral float-right" title="Federation">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="deliveryservice_stats.html" class="btn btn-neutral" title="Delivery Service Statistics"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/federation.html b/docs/latest/api/v12/federation.html
new file mode 100644
index 0000000..52cb216
--- /dev/null
+++ b/docs/latest/api/v12/federation.html
@@ -0,0 +1,931 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Federation — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Federation Delivery Service" href="federation_deliveryservice.html"/>
+ <link rel="prev" title="Divisions" href="division.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Federation</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/federation.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation_deliveryservice.html" class="btn btn-neutral float-right" title="Federation Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="federation">
+<span id="to-api-v12-federation"></span><h1>Federation<a class="headerlink" href="#federation" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-federations">
+<span id="to-api-v12-federation-route"></span><h2>/api/1.2/federations<a class="headerlink" href="#api-1-2-federations" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/federations.json</strong></p>
+<blockquote>
+<div><p>Retrieves a list of federation mappings (aka federation resolvers) for a the current user.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Federation</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>int</td>
+<td>Time to live for the cname.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>Unique string that describes the deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"cname-01."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">8865</span><span class="p">,</span>
+ <span class="p">]</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/federations.json</strong></p>
+<blockquote>
+<div><p>Allows a user to add federations for their delivery service(s).</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Federation</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>Unique string that describes the deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">resolve4</span></code></td>
+<td>array</td>
+<td>Array of IPv4 Addresses.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">resolve6</span></code></td>
+<td>array</td>
+<td>Array of IPv6 Addresses.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"federations"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span>
+ <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"resolve4"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"255.255.255.255"</span>
+ <span class="p">],</span>
+ <span class="s2">"resolve6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/federations.json</strong></p>
+<blockquote>
+<div><p>Deletes <strong>all</strong> federations associated with a user’s delivery service(s).</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Federation</p>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/federations.json</strong></p>
+<blockquote>
+<div><p>Deletes <strong>all</strong> federations associated with a user’s delivery service(s) then adds the new federations.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Federation</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>Unique string that describes the deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">resolve4</span></code></td>
+<td>array</td>
+<td>Array of IPv4 Addresses.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">resolve6</span></code></td>
+<td>array</td>
+<td>Array of IPv6 Addresses.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"federations"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span>
+ <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"resolve4"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"255.255.255.255"</span>
+ <span class="p">],</span>
+ <span class="s2">"resolve6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:name/federations</strong></p>
+<blockquote>
+<div><p>Retrieves a list of federations for a cdn.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>int</td>
+<td>Time to live for the cname.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>id</span></code></td>
+<td>int</td>
+<td>Delivery service ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>xmlId</span></code></td>
+<td>string</td>
+<td>Delivery service xml id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">41</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"booya.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">34</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"fooya"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">61</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"the-xml-id"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/:name/federations/:id</strong></p>
+<blockquote>
+<div><p>Retrieves a federation for a cdn.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td>
+<td>string</td>
+<td>Federation ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>int</td>
+<td>Time to live for the cname.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>id</span></code></td>
+<td>int</td>
+<td>Delivery service ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>xmlId</span></code></td>
+<td>string</td>
+<td>Delivery service xml id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">41</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"booya.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">34</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"fooya"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">61</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"the-xml-id"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/cdns/:name/federations</strong></dt>
+<dd><p class="first">Create a federation</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="38%" />
+<col width="17%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cname</span></code></td>
+<td>yes</td>
+<td>CNAME ending with a dot</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>yes</td>
+<td>TTL</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>no</td>
+<td>Description</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation created [ cname = the.cname. ] with id: 26."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">26</span><span class="p">,</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</span><span class="p">,</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>PUT /api/1.2/cdns/:name/federations/:id</strong></dt>
+<dd><p class="first">Update a federation</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td>
+<td>string</td>
+<td>Federation ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="38%" />
+<col width="17%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cname</span></code></td>
+<td>yes</td>
+<td>CNAME ending with a dot</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>yes</td>
+<td>TTL</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>no</td>
+<td>Description</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation updated [ cname = the.cname. ] with id: 26."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">26</span><span class="p">,</span>
+ <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"the.cname.com."</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">48</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"the description"</span><span class="p">,</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/cdns/:name/federations/{:id}</strong></p>
+<blockquote>
+<div><p>Allow user to delete a federation.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td>CDN name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td>
+<td>string</td>
+<td>Federation ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation deleted [ cname = the.cname. ] with id: 26."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation_deliveryservice.html" class="btn btn-neutral float-right" title="Federation Delivery Service">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="division.html" class="btn btn-neutral" title="Divisions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/federation_deliveryservice.html b/docs/latest/api/v12/federation_deliveryservice.html
new file mode 100644
index 0000000..1219a13
--- /dev/null
+++ b/docs/latest/api/v12/federation_deliveryservice.html
@@ -0,0 +1,500 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Federation Delivery Service — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Federation Federation Resolver" href="federation_federationresolver.html"/>
+ <link rel="prev" title="Federation" href="federation.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Federation Delivery Service</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/federation_deliveryservice.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation_federationresolver.html" class="btn btn-neutral float-right" title="Federation Federation Resolver">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation.html" class="btn btn-neutral" title="Federation"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="federation-delivery-service">
+<span id="to-api-v12-federation-deliveryservice"></span><h1>Federation Delivery Service<a class="headerlink" href="#federation-delivery-service" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-federations-id-deliveryservices">
+<span id="to-api-v12-federation-deliveryservice-route"></span><h2>/api/1.2/federations/:id/deliveryservices<a class="headerlink" href="#api-1-2-federations-id-deliveryservices" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/federations/:id/deliveryservices</strong></p>
+<blockquote>
+<div><p>Retrieves delivery services assigned to a federation.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td>
+<td>string</td>
+<td>Federation ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">41</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"DNS"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"booya-12"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/federations/:id/deliveryservices</strong></p>
+<blockquote>
+<div><p>Create one or more federation / delivery service assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsIds</span></code></td>
+<td>yes</td>
+<td>An array of delivery service IDs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>no</td>
+<td>Replace existing fed/ds assignments? (true|false)</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"dsIds"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsIds</span></code></td>
+<td>array</td>
+<td>An array of delivery service IDs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>array</td>
+<td>Existing fed/ds assignments replaced? (true|false).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"5 delivery service(s) were assigned to the cname. federation"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"dsIds"</span> <span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span> <span class="p">:</span> <span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/federations/:id/deliveryservices/:id</strong></p>
+<blockquote>
+<div><p>Removes a delivery service from a federation.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td>
+<td>yes</td>
+<td>Federation ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ds</span></code></td>
+<td>yes</td>
+<td>Delivery Service ID.</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<div><p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Removed delivery service [ booya-12 ] from federation [ cname1. ]"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation_federationresolver.html" class="btn btn-neutral float-right" title="Federation Federation Resolver">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation.html" class="btn btn-neutral" title="Federation"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/federation_federationresolver.html b/docs/latest/api/v12/federation_federationresolver.html
new file mode 100644
index 0000000..efbeb7a
--- /dev/null
+++ b/docs/latest/api/v12/federation_federationresolver.html
@@ -0,0 +1,449 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Federation Federation Resolver — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Federation Resolver" href="federation_resolver.html"/>
+ <link rel="prev" title="Federation Delivery Service" href="federation_deliveryservice.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Federation Federation Resolver</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/federation_federationresolver.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation_resolver.html" class="btn btn-neutral float-right" title="Federation Resolver">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation_deliveryservice.html" class="btn btn-neutral" title="Federation Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="federation-federation-resolver">
+<span id="to-api-v12-federation-federationresolver"></span><h1>Federation Federation Resolver<a class="headerlink" href="#federation-federation-resolver" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-federations-id-federation-resolvers">
+<span id="to-api-v12-federation-federationresolver-route"></span><h2>/api/1.2/federations/:id/federation_resolvers<a class="headerlink" href="#api-1-2-federations-id-federation-resolvers" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/federations/:id/federation_resolvers</strong></p>
+<blockquote>
+<div><p>Retrieves federation resolvers assigned to a federation.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td>
+<td>string</td>
+<td>Federation ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">41</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"2.2.2.2/16"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"RESOLVE4"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/federations/:id/federation_resolvers</strong></p>
+<blockquote>
+<div><p>Create one or more federation / federation resolver assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fedResolverIds</span></code></td>
+<td>yes</td>
+<td>An array of federation resolver IDs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>no</td>
+<td>Replace existing fed/ds assignments? (true|false)</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"fedResolverIds"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fedResolverIds</span></code></td>
+<td>array</td>
+<td>An array of federation resolver IDs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>array</td>
+<td>Existing fed/fed resolver assignments replaced? (true|false).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"5 resolvers(s) were assigned to the cname. federation"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"fedResolverIds"</span> <span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span> <span class="p">:</span> <span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation_resolver.html" class="btn btn-neutral float-right" title="Federation Resolver">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation_deliveryservice.html" class="btn btn-neutral" title="Federation Delivery Service"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/federation_resolver.html b/docs/latest/api/v12/federation_resolver.html
new file mode 100644
index 0000000..851b5d1
--- /dev/null
+++ b/docs/latest/api/v12/federation_resolver.html
@@ -0,0 +1,432 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Federation Resolver — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Federation User" href="federation_user.html"/>
+ <link rel="prev" title="Federation Federation Resolver" href="federation_federationresolver.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Federation Resolver</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/federation_resolver.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation_user.html" class="btn btn-neutral float-right" title="Federation User">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation_federationresolver.html" class="btn btn-neutral" title="Federation Federation Resolver"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="federation-resolver">
+<span id="to-api-v12-federation-resolver"></span><h1>Federation Resolver<a class="headerlink" href="#federation-resolver" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-federation-resolvers">
+<span id="to-api-v12-federation-resolver-route"></span><h2>/api/1.2/federation_resolvers<a class="headerlink" href="#api-1-2-federation-resolvers" title="Permalink to this headline">¶</a></h2>
+<p><strong>POST /api/1.2/federation_resolvers</strong></p>
+<blockquote>
+<div><p>Create a federation resolver.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: ADMIN</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="13%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>yes</td>
+<td>IP or CIDR range</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>yes</td>
+<td>Type Id where useintable=federation</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"2.2.2.2/32"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">245</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation resolver created [ IP = 2.2.2.2/32 ] with id: 27"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span> <span class="p">:</span> <span class="mi">27</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span> <span class="p">:</span> <span class="s2">"2.2.2.2/32"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span> <span class="p">:</span> <span class="mi">245</span><span class="p">,</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/federation_resolvers/:id</strong></p>
+<blockquote>
+<div><p>Deletes a federation resolver.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">resolver</span></code></td>
+<td>yes</td>
+<td>Federation resolver ID.</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<div><p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Federation resolver deleted [ IP = 2.2.2.2/32 ] with id: 27"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="federation_user.html" class="btn btn-neutral float-right" title="Federation User">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation_federationresolver.html" class="btn btn-neutral" title="Federation Federation Resolver"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/federation_user.html b/docs/latest/api/v12/federation_user.html
new file mode 100644
index 0000000..aa78127
--- /dev/null
+++ b/docs/latest/api/v12/federation_user.html
@@ -0,0 +1,510 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Federation User — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Hardware Info" href="hwinfo.html"/>
+ <link rel="prev" title="Federation Resolver" href="federation_resolver.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Federation User</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/federation_user.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="hwinfo.html" class="btn btn-neutral float-right" title="Hardware Info">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation_resolver.html" class="btn btn-neutral" title="Federation Resolver"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="federation-user">
+<span id="to-api-v12-federation-user"></span><h1>Federation User<a class="headerlink" href="#federation-user" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-federations-id-users">
+<span id="to-api-v12-federation-user-route"></span><h2>/api/1.2/federations/:id/users<a class="headerlink" href="#api-1-2-federations-id-users" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/federations/:id/users</strong></p>
+<blockquote>
+<div><p>Retrieves users assigned to a federation.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td>
+<td>string</td>
+<td>Federation ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">41</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"booya"</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">"XYZ Corporation"</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"federation"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"booya@fooya.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Booya Fooya"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/federations/:id/users</strong></p>
+<blockquote>
+<div><p>Create one or more federation / user assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">userIds</span></code></td>
+<td>yes</td>
+<td>An array of user IDs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>no</td>
+<td>Replace existing fed/user assignments? (true|false)</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"userIds"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">userIds</span></code></td>
+<td>array</td>
+<td>An array of user IDs.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>array</td>
+<td>Existing fed/user assignments replaced? (true|false).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"5 user(s) were assigned to the cname. federation"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"userIds"</span> <span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span> <span class="p">:</span> <span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/federations/:id/users/:id</strong></p>
+<blockquote>
+<div><p>Removes a user from a federation.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">federation</span></code></td>
+<td>yes</td>
+<td>Federation ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">user</span></code></td>
+<td>yes</td>
+<td>User ID.</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<div><p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Removed user [ bobmack ] from federation [ cname1. ]"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="hwinfo.html" class="btn btn-neutral float-right" title="Hardware Info">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation_resolver.html" class="btn btn-neutral" title="Federation Resolver"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/hwinfo.html b/docs/latest/api/v12/hwinfo.html
new file mode 100644
index 0000000..ab58d1e
--- /dev/null
+++ b/docs/latest/api/v12/hwinfo.html
@@ -0,0 +1,364 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Hardware Info — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="ISO" href="iso.html"/>
+ <link rel="prev" title="Federation User" href="federation_user.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Hardware Info</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/hwinfo.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="iso.html" class="btn btn-neutral float-right" title="ISO">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation_user.html" class="btn btn-neutral" title="Federation User"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="hardware-info">
+<span id="to-api-v12-hwinfo"></span><h1>Hardware Info<a class="headerlink" href="#hardware-info" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-hwinfo">
+<span id="to-api-v12-hwinfo-route"></span><h2>/api/1.2/hwinfo<a class="headerlink" href="#api-1-2-hwinfo" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/hwinfo.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="8%" />
+<col width="71%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">serverId</span></code></td>
+<td>string</td>
+<td>Local unique identifier for this specific server’s hardware info</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">serverHostName</span></code></td>
+<td>string</td>
+<td>Hostname for this specific server’s hardware info</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">val</span></code></td>
+<td>string</td>
+<td>Freeform value used to track anything about a server’s hardware info</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>Freeform description for this specific server’s hardware info</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span>
+ <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:0"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span>
+ <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:1"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="iso.html" class="btn btn-neutral float-right" title="ISO">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federation_user.html" class="btn btn-neutral" title="Federation User"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/index.html b/docs/latest/api/v12/index.html
new file mode 100644
index 0000000..1ab0555
--- /dev/null
+++ b/docs/latest/api/v12/index.html
@@ -0,0 +1,341 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>API 1.2 Reference — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="APIs" href="../index.html"/>
+ <link rel="next" title="API-Capabilities" href="api_capability.html"/>
+ <link rel="prev" title="Users" href="../v11/user.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li>API 1.2 Reference</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/index.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="api_capability.html" class="btn btn-neutral float-right" title="API-Capabilities">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../v11/user.html" class="btn btn-neutral" title="Users"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="api-1-2-reference">
+<h1>API 1.2 Reference<a class="headerlink" href="#api-1-2-reference" title="Permalink to this headline">¶</a></h1>
+<p>Traffic Ops API V1.2</p>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="api_capability.html">API-Capabilities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="asn.html">ASN</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cache.html">Cache</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cachegroup.html">Cache Group</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cachegroup_parameter.html">Cache Group parameters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cachegroup_fallbacks.html">Cache Group Fallback</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cache_stats.html">Cache Statistics</a></li>
+<li class="toctree-l1"><a class="reference internal" href="capability.html">Capabilities</a></li>
+<li class="toctree-l1"><a class="reference internal" href="cdn.html">CDN</a></li>
+<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Logs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="configfiles_ats.html">Config Files and Config File Metadata</a></li>
+<li class="toctree-l1"><a class="reference internal" href="deliveryservice.html">Delivery Service</a></li>
+<li class="toctree-l1"><a class="reference internal" href="deliveryservice_regex.html">Delivery Service Regexes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="deliveryservice_stats.html">Delivery Service Statistics</a></li>
+<li class="toctree-l1"><a class="reference internal" href="division.html">Divisions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="federation.html">Federation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="federation_deliveryservice.html">Federation Delivery Service</a></li>
+<li class="toctree-l1"><a class="reference internal" href="federation_federationresolver.html">Federation Federation Resolver</a></li>
+<li class="toctree-l1"><a class="reference internal" href="federation_resolver.html">Federation Resolver</a></li>
+<li class="toctree-l1"><a class="reference internal" href="federation_user.html">Federation User</a></li>
+<li class="toctree-l1"><a class="reference internal" href="hwinfo.html">Hardware Info</a></li>
+<li class="toctree-l1"><a class="reference internal" href="iso.html">ISO</a></li>
+<li class="toctree-l1"><a class="reference internal" href="job.html">Jobs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="parameter.html">Parameter</a></li>
+<li class="toctree-l1"><a class="reference internal" href="phys_location.html">Physical Location</a></li>
+<li class="toctree-l1"><a class="reference internal" href="profile.html">Profiles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="profile_parameter.html">Profile parameters</a></li>
+<li class="toctree-l1"><a class="reference internal" href="influxdb.html">InfluxDB</a></li>
+<li class="toctree-l1"><a class="reference internal" href="region.html">Regions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="role.html">Roles</a></li>
+<li class="toctree-l1"><a class="reference internal" href="server.html">Server</a></li>
+<li class="toctree-l1"><a class="reference internal" href="static_dns.html">Static DNS Entries</a></li>
+<li class="toctree-l1"><a class="reference internal" href="status.html">Status</a></li>
+<li class="toctree-l1"><a class="reference internal" href="steering_target.html">Steering Targets</a></li>
+<li class="toctree-l1"><a class="reference internal" href="system.html">System</a></li>
+<li class="toctree-l1"><a class="reference internal" href="tenant.html">Tenants</a></li>
+<li class="toctree-l1"><a class="reference internal" href="to_extension.html">TO Extensions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="type.html">Types</a></li>
+<li class="toctree-l1"><a class="reference internal" href="user.html">Users</a></li>
+<li class="toctree-l1"><a class="reference internal" href="topology.html">Snapshot CRConfig</a></li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="api_capability.html" class="btn btn-neutral float-right" title="API-Capabilities">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../v11/user.html" class="btn btn-neutral" title="Users"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/influxdb.html b/docs/latest/api/v12/influxdb.html
new file mode 100644
index 0000000..4bafec9
--- /dev/null
+++ b/docs/latest/api/v12/influxdb.html
@@ -0,0 +1,353 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>InfluxDB — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Regions" href="region.html"/>
+ <link rel="prev" title="Profile parameters" href="profile_parameter.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>InfluxDB</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/influxdb.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="profile_parameter.html" class="btn btn-neutral" title="Profile parameters"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="influxdb">
+<span id="to-api-v12-influxdb"></span><h1>InfluxDB<a class="headerlink" href="#influxdb" title="Permalink to this headline">¶</a></h1>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The documentation needs a thorough review!</p>
+</div>
+<p><strong>GET /api/1.2/traffic_monitor/stats.json</strong></p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">aaData</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"aaData"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">[</span>
+ <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"true"</span><span class="p">,</span>
+ <span class="s2">"ALL"</span><span class="p">,</span>
+ <span class="s2">"142035"</span><span class="p">,</span>
+ <span class="s2">"172365661.85"</span>
+ <span class="p">],</span>
+ <span class="p">[</span>
+ <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"EDGE1_TOP_421_PSPP"</span><span class="p">,</span>
+ <span class="s2">"odol-atsec-atl-03"</span><span class="p">,</span>
+ <span class="s2">"us-ga-atlanta"</span><span class="p">,</span>
+ <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"REPORTED"</span><span class="p">,</span>
+ <span class="s2">"596"</span><span class="p">,</span>
+ <span class="s2">"923510.04"</span><span class="p">,</span>
+ <span class="s2">"69.241.82.126"</span>
+ <span class="p">]</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="region.html" class="btn btn-neutral float-right" title="Regions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="profile_parameter.html" class="btn btn-neutral" title="Profile parameters"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/iso.html b/docs/latest/api/v12/iso.html
new file mode 100644
index 0000000..cb78c0a
--- /dev/null
+++ b/docs/latest/api/v12/iso.html
@@ -0,0 +1,468 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>ISO — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Jobs" href="job.html"/>
+ <link rel="prev" title="Hardware Info" href="hwinfo.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>ISO</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/iso.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="job.html" class="btn btn-neutral float-right" title="Jobs">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="iso">
+<span id="to-api-v12-iso"></span><h1>ISO<a class="headerlink" href="#iso" title="Permalink to this headline">¶</a></h1>
+<p id="to-api-v12-iso-route"><strong>GET /api/1.2/osversions</strong></p>
+<blockquote>
+<div><p>Get all OS versions for ISO generation and the directory where the kickstarter files are found. The values are retrieved from osversions.cfg found in either /var/www/files or in the location defined by the kickstart.files.location parameter (if defined).</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="77%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">OS</span> <span class="pre">version</span> <span class="pre">name</span></code></td>
+<td>OS version name. For example, “CentOS 7.2 vda”.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">OS</span> <span class="pre">version</span> <span class="pre">dir</span></code></td>
+<td>The directory where the kickstarter ISO files are found. For example,
+centos72-netinstall.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s2">"CentOS 7.2"</span><span class="p">:</span> <span class="s2">"centos72-netinstall"</span>
+ <span class="s2">"CentOS 7.2 vda"</span><span class="p">:</span> <span class="s2">"centos72-netinstall-vda"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/isos</strong></p>
+<blockquote>
+<div><p>Generate an ISO.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operations</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="7%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">osversionDir</span></code></td>
+<td>yes</td>
+<td>The directory name where the kickstarter ISO files are found.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">hostName</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rootPass</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dhcp</span></code></td>
+<td>yes</td>
+<td>Valid values are ‘yes’ or ‘no’. If yes, other IP settings will be ignored.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceMtu</span></code></td>
+<td>yes</td>
+<td>1500 or 9000</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>yes|no</td>
+<td>Required if dhcp=no</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td>
+<td>yes|no</td>
+<td>Required if dhcp=no</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td>
+<td>yes|no</td>
+<td>Required if dhcp=no</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>no</td>
+<td>/64 is assumed if prefix is omitted.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td>
+<td>no</td>
+<td>Ignored if an IPV4 gateway is specified.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceName</span></code></td>
+<td>no</td>
+<td>Typical values are bond0, eth4, etc. If you enter bond0, a LACP bonding config will be written.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">disk</span></code></td>
+<td>no</td>
+<td>Typical values are “sda”</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"osversionDir"</span><span class="p">:</span> <span class="s2">"centos72-netinstall-vda"</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"foo-bar"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"baz.com"</span><span class="p">,</span>
+ <span class="s2">"rootPass"</span><span class="p">:</span> <span class="s2">"password"</span><span class="p">,</span>
+ <span class="s2">"dhcp"</span><span class="p">:</span> <span class="s2">"no"</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="mi">1500</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.10.10"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.252"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.10.10"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="8%" />
+<col width="76%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">isoURL</span></code></td>
+<td>string</td>
+<td>The URL location of the ISO. ISO locations can be found in cnd.conf file.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"isoURL"</span><span class="p">:</span> <span class="s2">"https://traffic_ops.domain.net/iso/fqdn-centos72-netinstall.iso"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Generate ISO was successful."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="job.html" class="btn btn-neutral float-right" title="Jobs">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/job.html b/docs/latest/api/v12/job.html
new file mode 100644
index 0000000..33b29dc
--- /dev/null
+++ b/docs/latest/api/v12/job.html
@@ -0,0 +1,472 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Jobs — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Parameter" href="parameter.html"/>
+ <link rel="prev" title="ISO" href="iso.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Jobs</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/job.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="parameter.html" class="btn btn-neutral float-right" title="Parameter">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="iso.html" class="btn btn-neutral" title="ISO"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="jobs">
+<span id="to-api-v12-job"></span><h1>Jobs<a class="headerlink" href="#jobs" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-jobs">
+<span id="to-api-v12-job-route"></span><h2>/api/1.2/jobs<a class="headerlink" href="#api-1-2-jobs" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/jobs</strong></p>
+<blockquote>
+<div><p>Get all jobs (currently limited to invalidate content (PURGE) jobs) sorted by start time (descending).</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operations or Admin</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>no</td>
+<td>Filter jobs by Delivery Service ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">userId</span></code></td>
+<td>no</td>
+<td>Filter jobs by User ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Job id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">assetUrl</span></code></td>
+<td>string</td>
+<td>URL of the asset to invalidate.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>Unique identifier of the job’s DS.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">keyword</span></code></td>
+<td>string</td>
+<td>Job keyword (PURGE)</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameters</span></code></td>
+<td>string</td>
+<td>Parameters associated with the job.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">startTime</span></code></td>
+<td>string</td>
+<td>Start time of the job.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">createdBy</span></code></td>
+<td>string</td>
+<td>Username that initiated the job.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">"http:\/\/foo-bar.domain.net\/taco.html"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"foo-bar"</span><span class="p">,</span>
+ <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:48h"</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-05-14 08:56:36-06"</span><span class="p">,</span>
+ <span class="s2">"createdBy"</span><span class="p">:</span> <span class="s2">"jdog24"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">"http:\/\/foo-bar.domain.net\/bell.html"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"foo-bar"</span><span class="p">,</span>
+ <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:72h"</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-05-16 08:56:36-06"</span><span class="p">,</span>
+ <span class="s2">"createdBy"</span><span class="p">:</span> <span class="s2">"jdog24"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/jobs/:id</strong></p>
+<blockquote>
+<div><p>Get a job by ID (currently limited to invalidate content (PURGE) jobs).</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Operations or Admin</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Job id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">assetUrl</span></code></td>
+<td>string</td>
+<td>URL of the asset to invalidate.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>Unique identifier of the job’s DS.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">keyword</span></code></td>
+<td>string</td>
+<td>Job keyword (PURGE)</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameters</span></code></td>
+<td>string</td>
+<td>Parameters associated with the job.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">startTime</span></code></td>
+<td>string</td>
+<td>Start time of the job.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">createdBy</span></code></td>
+<td>string</td>
+<td>Username that initiated the job.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">"http:\/\/foo-bar.domain.net\/taco.html"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"foo-bar"</span><span class="p">,</span>
+ <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:48h"</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-05-14 08:56:36-06"</span><span class="p">,</span>
+ <span class="s2">"createdBy"</span><span class="p">:</span> <span class="s2">"jdog24"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="parameter.html" class="btn btn-neutral float-right" title="Parameter">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="iso.html" class="btn btn-neutral" title="ISO"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/parameter.html b/docs/latest/api/v12/parameter.html
new file mode 100644
index 0000000..10d9154
--- /dev/null
+++ b/docs/latest/api/v12/parameter.html
@@ -0,0 +1,1382 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Parameter — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Physical Location" href="phys_location.html"/>
+ <link rel="prev" title="Jobs" href="job.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Parameter</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/parameter.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="phys_location.html" class="btn btn-neutral float-right" title="Physical Location">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="job.html" class="btn btn-neutral" title="Jobs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="parameter">
+<span id="to-api-v12-parameter"></span><h1>Parameter<a class="headerlink" href="#parameter" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-parameters">
+<span id="to-api-v12-parameters-route"></span><h2>/api/1.2/parameters<a class="headerlink" href="#api-1-2-parameters" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/parameters</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>no</td>
+<td>Filter parameters by name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">configFile</span></code></td>
+<td>no</td>
+<td>Filter parameters by config file.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">configFile</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profiles</span></code></td>
+<td>array</td>
+<td>An array of profiles attached to this parameter.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span><span class="p">,</span>
+ <span class="s2">"profiles"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"EDGE-FOO, MID-FOO"</span> <span class="p">]</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span> <span class="s2">"storage.config"</span><span class="p">,</span>
+ <span class="s2">"profiles"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"EDGE-FOO, MID-FOO"</span> <span class="p">]</span>
+
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="s2">"profiles"</span><span class="p">:</span> <span class="p">[</span> <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/parameters/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: if secure of the parameter fetched is 1, require admin role, or any valid role can access.</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter index</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/parameters/:id/profiles</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Retrieves all profiles assigned to the parameter.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="13%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Parameter ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/parameters/:id/unassigned_profiles</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Retrieves all profiles NOT assigned to the parameter.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="13%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Parameter ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>array</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/profiles/:id/parameters</strong></p>
+<blockquote>
+<div><p>Retrieves all parameters assigned to the profile.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Profile id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">last_updated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/profiles/:id/unassigned_parameters</strong></p>
+<blockquote>
+<div><p>Retrieves all parameters NOT assigned to the profile.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Profile id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">last_updated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/profiles/name/:name/parameters</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="20%" />
+<col width="45%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>Profile name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">last_updated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>boolean</td>
+<td>When true, the parameter is accessible only by admin users. Defaults to false.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/parameters</strong></dt>
+<dd><p class="first">Create parameters.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong>
+The request route parameters accept 2 formats, both single paramter and parameters array formats are acceptable.</p>
+<p>single parameter format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="8%" />
+<col width="7%" />
+<col width="71%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">configFile</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>yes</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p>parameters array format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="8%" />
+<col width="7%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>yes</td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>configFile</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>value</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>secure</span></code></td>
+<td>yes</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="8%" />
+<col width="77%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>configFile</span></code></td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>value</span></code></td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>secure</span></code></td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<ol class="arabic">
+<li><p class="first">single parameter format example:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</li>
+<li><p class="first">array format example:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span>
+ <span class="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+</li>
+</ol>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1139"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1140"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>PUT /api/1.2/parameters/{:id}</strong></dt>
+<dd><p class="first">Edit parameter.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: if the parameter’s secure equals 1, only admin role can edit the parameter, or admin or oper role can access the API.</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="24%" />
+<col width="47%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="8%" />
+<col width="7%" />
+<col width="71%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>no</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">configFile</span></code></td>
+<td>no</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>no</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>no</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>integer</td>
+<td>When 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1134"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>DELETE /api/1.2/parameters/{:id}</strong></dt>
+<dd><p class="first">delete parameter. If the parameter have profile associated, can not be deleted.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper role</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="29%" />
+<col width="24%" />
+<col width="47%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>No Request Route Parameters</strong></p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Parameter was successfully deleted."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/parameters/validate</strong></dt>
+<dd><p class="first">Validate if the parameter exists.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="17%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type | Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>string | parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">configFile</span></code></td>
+<td>yes</td>
+<td>string | parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>yes</td>
+<td>string | parameter value</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="8%" />
+<col width="75%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>integer</td>
+<td>The parameter id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>integer</td>
+<td>When 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>The parameter value, only visible to admin if secure is true</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config_file</span></code></td>
+<td>string</td>
+<td>The parameter config_file</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1134"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="phys_location.html" class="btn btn-neutral float-right" title="Physical Location">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="job.html" class="btn btn-neutral" title="Jobs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/phys_location.html b/docs/latest/api/v12/phys_location.html
new file mode 100644
index 0000000..acc3876
--- /dev/null
+++ b/docs/latest/api/v12/phys_location.html
@@ -0,0 +1,1008 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Physical Location — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Profiles" href="profile.html"/>
+ <link rel="prev" title="Parameter" href="parameter.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Physical Location</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/phys_location.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="profile.html" class="btn btn-neutral float-right" title="Profiles">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="parameter.html" class="btn btn-neutral" title="Parameter"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="physical-location">
+<span id="to-api-v12-phys-loc"></span><h1>Physical Location<a class="headerlink" href="#physical-location" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-phys-locations">
+<span id="to-api-v12-phys-loc-route"></span><h2>/api/1.2/phys_locations<a class="headerlink" href="#api-1-2-phys-locations" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/phys_locations</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="14%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">region</span></code></td>
+<td>no</td>
+<td>Filter by Region ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/phys_locations/trimmed.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="11%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/phys_locations/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Physical location ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>PUT /api/1.2/phys_locations/:id</strong></dt>
+<dd><p class="first">Update a physical location</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Physical location id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>yes</td>
+<td>Physical location address.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td>Physical location city.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td>Physical location comments.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>no</td>
+<td>Physical location email.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>Physical location name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td>Physical location phone.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Physical location point of contact.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td>
+<td>no</td>
+<td>Physical location region ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>Physical location short name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td>Physical location state.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td>Physical location zip.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">region</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Physical location update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
+ <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/regions/:region_name/phys_locations</strong></dt>
+<dd><p class="first">Create physical location.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p>region_name: the name of the region to create physical location into.</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="16%" />
+<col width="56%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">region_name</span></code></td>
+<td>yes</td>
+<td>The name of the physical location</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the location</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>yes</td>
+<td>The short name of the location</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>no</td>
+<td>Point of contact</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>no</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span> <span class="p">:</span> <span class="s2">"my physical location1"</span><span class="p">,</span>
+ <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span>
+ <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span>
+ <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span>
+ <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span>
+ <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="11%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The id of the physical location created.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the location</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">shortName</span></code></td>
+<td>string</td>
+<td>The short name of the location</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionName</span></code></td>
+<td>string</td>
+<td>The region name the physical location belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regionId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">state</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">zip</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phone</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">poc</span></code></td>
+<td>string</td>
+<td>Point of contact</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">comments</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span>
+ <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span>
+ <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span>
+ <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span>
+ <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span>
+ <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span>
+ <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span>
+ <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="profile.html" class="btn btn-neutral float-right" title="Profiles">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="parameter.html" class="btn btn-neutral" title="Parameter"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/profile.html b/docs/latest/api/v12/profile.html
new file mode 100644
index 0000000..974369e
--- /dev/null
+++ b/docs/latest/api/v12/profile.html
@@ -0,0 +1,981 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Profiles — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Profile parameters" href="profile_parameter.html"/>
+ <link rel="prev" title="Physical Location" href="phys_location.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Profiles</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/profile.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="profile_parameter.html" class="btn btn-neutral float-right" title="Profile parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="profiles">
+<span id="to-api-v12-profile"></span><h1>Profiles<a class="headerlink" href="#profiles" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-profiles">
+<span id="to-api-v12-profiles-route"></span><h2>/api/1.2/profiles<a class="headerlink" href="#api-1-2-profiles" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/profiles</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="13%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">param</span></code></td>
+<td>no</td>
+<td>Used to filter profiles by parameter ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>no</td>
+<td>Used to filter profiles by CDN ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="10%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>int</td>
+<td>The CDN ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>The CDN name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Profile type</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routingDisabled</span></code></td>
+<td>bool</td>
+<td>Traffic router routing disabled - defaults to false.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>array</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_27_PROFILE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"A profile with all the Foo parameters"</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn1"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span>
+ <span class="s2">"routingDisabled"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/profiles/trimmed</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="10%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_27_PROFILE"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/profiles/:id</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="16%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>The ID of the profile.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="10%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Primary key</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name for the profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>The description for the profile</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>int</td>
+<td>The CDN ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>The CDN name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Profile type</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routingDisabled</span></code></td>
+<td>bool</td>
+<td>Traffic router routing disabled</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>array</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_27_PROFILE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"A profile with all the Foo parameters"</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn1"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span>
+ <span class="s2">"routingDisabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/profiles</strong></dt>
+<dd><blockquote class="first">
+<div><p>Create a new empty profile.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="12%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Profile name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Profile description</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>int</td>
+<td>no</td>
+<td>CDN ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Profile type</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routingDisabled</span></code></td>
+<td>bool</td>
+<td>no</td>
+<td>Traffic router routing disabled.
+Defaults to false.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE description"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span><span class="p">,</span>
+ <span class="s2">"routingDisabled"</span><span class="p">:</span> <span class="n">false</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Profile ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Profile name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>Profile description</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>int</td>
+<td>CDN ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Profile type</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routingDisabled</span></code></td>
+<td>bool</td>
+<td>Traffic router routing disabled</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE description"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span><span class="p">,</span>
+ <span class="s2">"routingDisabled"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/profiles/name/:profile_name/copy/:profile_copy_from</strong></dt>
+<dd><blockquote class="first">
+<div><p>Copy profile to a new profile. The new profile name must not exist.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="36%" />
+<col width="16%" />
+<col width="48%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile_name</span></code></td>
+<td>yes</td>
+<td>The name of profile to copy</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profile_copy_from</span></code></td>
+<td>yes</td>
+<td>The name of profile copy from</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Id of the new profile</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the new profile</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileCopyFrom</span></code></td>
+<td>string</td>
+<td>The name of profile to copy</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">idCopyFrom</span></code></td>
+<td>string</td>
+<td>The id of profile to copy</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>new profile’s description (copied)</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"66"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_COPY"</span><span class="p">,</span>
+ <span class="s2">"profileCopyFrom"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"CCR_COPY description"</span><span class="p">,</span>
+ <span class="s2">"idCopyFrom"</span><span class="p">:</span> <span class="s2">"3"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/profiles/{:id}</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Allows user to edit a profile.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="9%" />
+<col width="12%" />
+<col width="52%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Profile name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Profile description</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>int</td>
+<td>no</td>
+<td>CDN ID - must use the same ID as any
+servers assigned to the profile.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Profile type</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routingDisabled</span></code></td>
+<td>bool</td>
+<td>no</td>
+<td>Traffic router routing disabled.
+When not present, value defaults to false.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE description"</span><span class="p">,</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span><span class="p">,</span>
+ <span class="s2">"routingDisabled"</span><span class="p">:</span> <span class="n">false</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Profile ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Profile name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>Profile description</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>int</td>
+<td>CDN ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Profile type</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routingDisabled</span></code></td>
+<td>bool</td>
+<td>Traffic router routing disabled</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"219"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"EDGE_28_PROFILE description"</span>
+ <span class="s2">"cdn"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"ATS_PROFILE"</span><span class="p">,</span>
+ <span class="s2">"routingDisabled"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile was updated: 219"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/profiles/{:id}</strong></p>
+<blockquote>
+<div><p>Allows user to delete a profile.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="18%" />
+<col width="51%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile was deleted."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="profile_parameter.html" class="btn btn-neutral float-right" title="Profile parameters">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="phys_location.html" class="btn btn-neutral" title="Physical Location"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/profile_parameter.html b/docs/latest/api/v12/profile_parameter.html
new file mode 100644
index 0000000..adb3137
--- /dev/null
+++ b/docs/latest/api/v12/profile_parameter.html
@@ -0,0 +1,1105 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Profile parameters — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="InfluxDB" href="influxdb.html"/>
+ <link rel="prev" title="Profiles" href="profile.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Profile parameters</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/profile_parameter.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="profile.html" class="btn btn-neutral" title="Profiles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="profile-parameters">
+<span id="to-api-v12-profileparameters"></span><h1>Profile parameters<a class="headerlink" href="#profile-parameters" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-profileparameters">
+<span id="to-api-v12-profileparameters-route"></span><h2>/api/1.2/profileparameters<a class="headerlink" href="#api-1-2-profileparameters" title="Permalink to this headline">¶</a></h2>
+<p><strong>POST /api/1.2/profileparameters</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Associate parameter to profile.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Properties</strong>
+This accept two formats: single profile-parameter, profile-parameter array.</p>
+<p>Single profile-parameter format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parameterId</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+<p>Profile-parameter array format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>yes</td>
+<td>profile-parameter array.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>profileId</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>parameterId</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>Single profile-parameter format:
+
+{
+ "profileId": 2,
+ "parameterId": 6
+}
+
+Profile-parameter array format:
+
+[
+ {
+ "profileId": 2,
+ "parameterId": 6
+ },
+ {
+ "profileId": 2,
+ "parameterId": 7
+ },
+ {
+ "profileId": 3,
+ "parameterId": 6
+ }
+]
+
+ **Response Properties**
+
+ +-------------------+---------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+=========+=====================================================+
+ | ``response`` | array | Profile-parameter associations. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>profileId`` | string | Profile id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>parameterId`` | string | Parameter id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+---------+-----------------------------------------------------+
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"7"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"6"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile parameter associations were created."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/profileparameters/{:profile_id}/{:parameter_id}</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Delete a profile parameter association.</p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile_id</span></code></td>
+<td>yes</td>
+<td>profile id.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parameter_id</span></code></td>
+<td>yes</td>
+<td>parameter id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="10%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+</div></blockquote>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Profile parameter association was deleted."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/profiles/name/{:name}/parameters</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+If the profile does not exist, the API returns fail.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper. If there is parameter’s secure equals 1 in the request properties, need admin role.</p>
+<blockquote>
+<div><p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="14%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>profile name.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Request Properties</strong>
+The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.</p>
+<p>single parameter format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="8%" />
+<col width="7%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">configFile</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>yes</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p>array parameters format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="8%" />
+<col width="7%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>yes</td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>configFile</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>value</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>secure</span></code></td>
+<td>yes</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">single</span> <span class="n">parameter</span> <span class="nb">format</span> <span class="n">exampe</span><span class="p">:</span>
+<span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
+<span class="p">}</span>
+
+<span class="mf">2.</span> <span class="n">array</span> <span class="nb">format</span> <span class="n">example</span><span class="p">:</span>
+<span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
+ <span class="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>+------------------+---------+--------------------------------------------------------------------------------------+
+| Name | Type | Description |
++==================+=========+======================================================================================+
+| ``response`` | | Parameters associated with the profile. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileName`` | string | profile name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileId`` | integer | profile index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>parameters`` | array | parameters array |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>id`` | integer | parameter index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>name`` | string | parameter name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>configFile`` | string | parameter config_file |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>value`` | string | parameter value |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``alerts`` | array | A collection of alert messages. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>level`` | string | success, info, warning or error. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>text`` | string | Alert message. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``version`` | string | |
++------------------+---------+--------------------------------------------------------------------------------------+
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span> <span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">""</span><span class="n">Assign</span> <span class="n">parameters</span> <span class="n">successfully</span> <span class="n">to</span> <span class="n">profile</span> <span class="n">CCR1</span><span class="s2">"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/profiles/id/{:id}/parameters</strong></p>
+<blockquote>
+<div><blockquote>
+<div><p>Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+If the profile does not exist, the API returns fail.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper. If there is parameter’s secure equals 1 in the request properties, need admin role.</p>
+<blockquote>
+<div><p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="14%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>profile name.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Request Properties</strong>
+The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.</p>
+<p>single parameter format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="8%" />
+<col width="7%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">configFile</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">secure</span></code></td>
+<td>yes</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+<p>array parameters format:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="8%" />
+<col width="7%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td> </td>
+<td>yes</td>
+<td>array</td>
+<td>parameters array</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>name</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>configFile</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter config_file</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>value</span></code></td>
+<td>yes</td>
+<td>string</td>
+<td>parameter value</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>secure</span></code></td>
+<td>yes</td>
+<td>integer</td>
+<td>secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0.</td>
+</tr>
+</tbody>
+</table>
+</div></blockquote>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">single</span> <span class="n">parameter</span> <span class="nb">format</span> <span class="n">exampe</span><span class="p">:</span>
+<span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
+<span class="p">}</span>
+
+<span class="mf">2.</span> <span class="n">array</span> <span class="nb">format</span> <span class="n">example</span><span class="p">:</span>
+<span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
+ <span class="p">}</span>
+<span class="p">]</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>+------------------+---------+--------------------------------------------------------------------------------------+
+| Name | Type | Description |
++==================+=========+======================================================================================+
+| ``response`` | | Parameters associated with the profile. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileName`` | string | profile name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>profileId`` | integer | profile index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>parameters`` | array | parameters array |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>id`` | integer | parameter index |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>name`` | string | parameter name |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>configFile`` | string | parameter config_file |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>value`` | string | parameter value |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``alerts`` | array | A collection of alert messages. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>level`` | string | success, info, warning or error. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``>text`` | string | Alert message. |
++------------------+---------+--------------------------------------------------------------------------------------+
+| ``version`` | string | |
++------------------+---------+--------------------------------------------------------------------------------------+
+</pre></div>
+</div>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:{</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR1"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span> <span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
+ <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span>
+ <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
+ <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">,</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+ <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">""</span><span class="n">Assign</span> <span class="n">parameters</span> <span class="n">successfully</span> <span class="n">to</span> <span class="n">profile</span> <span class="n">CCR1</span><span class="s2">"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/profileparameter</strong></p>
+<blockquote>
+<div><p>Create one or more profile / parameter assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>yes</td>
+<td>The ID of the profile.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">paramIds</span></code></td>
+<td>yes</td>
+<td>An array of parameter IDs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>no</td>
+<td>Replace existing profile/param assignments? (true|false)</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="mi">22</span><span class="p">,</span>
+ <span class="s2">"paramIds"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The ID of the profile.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">paramIds</span></code></td>
+<td>array</td>
+<td>An array of parameter IDs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>bool</td>
+<td>Existing profile/param assignments replaced? (true|false).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"14 parameters where assigned to the foo profile."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"profileId"</span> <span class="p">:</span> <span class="mi">22</span><span class="p">,</span>
+ <span class="s2">"paramIds"</span> <span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span> <span class="p">:</span> <span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/parameterprofile</strong></p>
+<blockquote>
+<div><p>Create one or more parameter / profile assignments.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">paramId</span></code></td>
+<td>yes</td>
+<td>The ID of the parameter.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileIds</span></code></td>
+<td>yes</td>
+<td>An array of profile IDs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>no</td>
+<td>Replace existing param/profile assignments? (true|false)</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"paramId"</span><span class="p">:</span> <span class="mi">22</span><span class="p">,</span>
+ <span class="s2">"profileIds"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span><span class="p">:</span> <span class="n">true</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">paramId</span></code></td>
+<td>int</td>
+<td>The ID of the parameter.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileIds</span></code></td>
+<td>array</td>
+<td>An array of profile IDs.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">replace</span></code></td>
+<td>bool</td>
+<td>Existing param/profile assignments replaced? (true|false).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"14 profiles where assigned to the bar parameter."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"paramId"</span> <span class="p">:</span> <span class="mi">22</span><span class="p">,</span>
+ <span class="s2">"profileIds"</span> <span class="p">:</span> <span class="p">[</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span>
+ <span class="s2">"replace"</span> <span class="p">:</span> <span class="n">true</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="influxdb.html" class="btn btn-neutral float-right" title="InfluxDB">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="profile.html" class="btn btn-neutral" title="Profiles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/region.html b/docs/latest/api/v12/region.html
new file mode 100644
index 0000000..7c4da9b
--- /dev/null
+++ b/docs/latest/api/v12/region.html
@@ -0,0 +1,672 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Regions — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Roles" href="role.html"/>
+ <link rel="prev" title="InfluxDB" href="influxdb.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Regions</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/region.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="role.html" class="btn btn-neutral float-right" title="Roles">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="influxdb.html" class="btn btn-neutral" title="InfluxDB"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="regions">
+<span id="to-api-v12-region"></span><h1>Regions<a class="headerlink" href="#regions" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-regions">
+<span id="to-api-v12-regions-route"></span><h2>/api/1.2/regions<a class="headerlink" href="#api-1-2-regions" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/regions</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="14%" />
+<col width="64%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">division</span></code></td>
+<td>no</td>
+<td>Filter regions by Division ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Region ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"7"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/regions/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Region id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>Region ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Region name.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">division</span></code></td>
+<td>string</td>
+<td>Division ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>Division name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<dl class="docutils">
+<dt><strong>PUT /api/1.2/regions/:id</strong></dt>
+<dd><p class="first">Update a region</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Region id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="31%" />
+<col width="19%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the region</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">division</span></code></td>
+<td>yes</td>
+<td>The division Id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">division</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Region update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
+ <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<dl class="docutils">
+<dt><strong>POST /api/1.2/divisions/:division_name/regions</strong></dt>
+<dd><p class="first">Create Region</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p>division_name - The name of division to create new region into.</p>
+<p>** Request Route Parameters**</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">division_name</span></code></td>
+<td>yes</td>
+<td>The name of division will create new region in</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="14%" />
+<col width="59%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the region</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd>
+</dl>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="11%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>name of region created</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>id of region created</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">divisionName</span></code></td>
+<td>string</td>
+<td>the division name the region belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">divisionId</span></code></td>
+<td>string</td>
+<td>the id of division the region belongs to.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'divisionName'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
+ <span class="s1">'divsionId'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span>
+ <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
+ <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'19'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="role.html" class="btn btn-neutral float-right" title="Roles">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="influxdb.html" class="btn btn-neutral" title="InfluxDB"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/role.html b/docs/latest/api/v12/role.html
new file mode 100644
index 0000000..c5f18f6
--- /dev/null
+++ b/docs/latest/api/v12/role.html
@@ -0,0 +1,354 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Roles — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Server" href="server.html"/>
+ <link rel="prev" title="Regions" href="region.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Roles</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/role.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="server.html" class="btn btn-neutral float-right" title="Server">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="region.html" class="btn btn-neutral" title="Regions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="roles">
+<span id="to-api-v12-roles"></span><h1>Roles<a class="headerlink" href="#roles" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-roles">
+<span id="to-api-v12-roles-route"></span><h2>/api/1.2/roles<a class="headerlink" href="#api-1-2-roles" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/roles.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">privLevel</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"read-only"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"privLevel"</span><span class="p">:</span> <span class="s2">"10"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"read-only user"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="server.html" class="btn btn-neutral float-right" title="Server">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="region.html" class="btn btn-neutral" title="Regions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/server.html b/docs/latest/api/v12/server.html
new file mode 100644
index 0000000..e116809
--- /dev/null
+++ b/docs/latest/api/v12/server.html
@@ -0,0 +1,2702 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Server — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Static DNS Entries" href="static_dns.html"/>
+ <link rel="prev" title="Roles" href="role.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Server</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/server.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="static_dns.html" class="btn btn-neutral float-right" title="Static DNS Entries">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="role.html" class="btn btn-neutral" title="Roles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="server">
+<span id="to-api-v12-server"></span><h1>Server<a class="headerlink" href="#server" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-servers">
+<span id="to-api-v12-servers-route"></span><h2>/api/1.2/servers<a class="headerlink" href="#api-1-2-servers" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/servers</strong></p>
+<blockquote>
+<div><p>Retrieves properties of CDN servers.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="13%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>no</td>
+<td>Used to filter servers by delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>no</td>
+<td>Used to filter servers by status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>no</td>
+<td>Used to filter servers by type.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>no</td>
+<td>Used to filter servers by profile ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn</span></code></td>
+<td>no</td>
+<td>Used to filter servers by CDN ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>no</td>
+<td>Used to filter servers by cache group ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">physLocation</span></code></td>
+<td>no</td>
+<td>Used to filter servers by phys location ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/servers/:id</strong></p>
+<blockquote>
+<div><p>Retrieves properties of a CDN server by server ID.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Server id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">physLocationId</span></code></td>
+<td>string</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileDesc</span></code></td>
+<td>string</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">statusId</span></code></td>
+<td>string</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/servers/:id/deliveryservices</strong></p>
+<blockquote>
+<div><p>Retrieves all delivery services assigned to the server. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Server ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="5%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cacheurl</span></code></td>
+<td>string</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ccrDnsTtl</span></code></td>
+<td>string</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">checkPath</span></code></td>
+<td>string</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deepCachingType</span></code></td>
+<td>string</td>
+<td><p class="first">When to do Deep Caching for this Delivery Service:</p>
+<ul class="last simple">
+<li>NEVER (default)</li>
+<li>ALWAYS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp</span></code></td>
+<td>string</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp6</span></code></td>
+<td>string</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassTtl</span></code></td>
+<td>string</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td>
+<td>string</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">edgeHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td>
+<td>string</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from USA</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td>
+<td>string</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td>
+<td>string</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpBypassFqdn</span></code></td>
+<td>string</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The deliveryservice id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">infoUrl</span></code></td>
+<td>string</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<td>bool</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td>
+<td>string</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc2</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>setNumber</span></code></td>
+<td>string</td>
+<td>The set Number of the matchList.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>pattern</span></code></td>
+<td>string</td>
+<td>The regexp for the matchList.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">maxDnsAnswers</span></code></td>
+<td>string</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td>
+<td>string</td>
+<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td>
+<td>string</td>
+<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">orgServerFqdn</span></code></td>
+<td>string</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regexRemap</span></code></td>
+<td>string</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">remapText</span></code></td>
+<td>string</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routingName</span></code></td>
+<td>string</td>
+<td>The routing name of this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">signed</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>Owning tenant name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td>List of header keys separated by <code class="docutils literal notranslate"><span class="pre">__RETURN__</span></code>. Listed headers will be included in TR access log entries under the “rh=” token.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td>List of header <code class="docutils literal notranslate"><span class="pre">name:value</span></code> pairs separated by <code class="docutils literal notranslate"><span class="pre">__RETURN__</span></code>. Listed pairs will be included in all TR HTTP responses.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"deepCachingType"</span><span class="p">:</span> <span class="s2">"NEVER"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://foo.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"routingName"</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/servers/totals</strong></p>
+<blockquote>
+<div><p>Retrieves a count of CDN servers by type.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="12%" />
+<col width="9%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">count</span></code></td>
+<td>int</td>
+<td>The number of servers of this type in this instance of Traffic Ops.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v12-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CCR"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">55</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"MID"</span><span class="p">,</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">18</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"INFLUXDB"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"RASCAL"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/servers/status</strong></p>
+<blockquote>
+<div><p>Retrieves a count of CDN servers by status.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="12%" />
+<col width="6%" />
+<col width="83%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ONLINE</span></code></td>
+<td>int</td>
+<td>The number of ONLINE servers. Traffic Monitor will not monitor the state of ONLINE servers. True health is unknown.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">REPORTED</span></code></td>
+<td>int</td>
+<td>The number of REPORTED servers. Traffic Monitor monitors the state of REPORTED servers and removes them if unhealthy.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">OFFLINE</span></code></td>
+<td>int</td>
+<td>The number of OFFLINE servers. Used for longer-term maintenance. These servers are excluded from CRConfig.json.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ADMIN_DOWN</span></code></td>
+<td>int</td>
+<td>The number of ADMIN_DOWN servers. Used for short-term maintenance. These servers are included in CRConfig.json.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">CCR_IGNORE</span></code></td>
+<td>int</td>
+<td>The number of CCR_IGNORE servers. These servers are excluded from CRConfig.json.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">PRE_PROD</span></code></td>
+<td>int</td>
+<td>The number of PRE_PROD servers. Used for servers to be deployed. These servers are excluded from CRConfig.json.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s2">"ONLINE"</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
+ <span class="s2">"OFFLINE"</span><span class="p">:</span> <span class="mi">23</span><span class="p">,</span>
+ <span class="s2">"REPORTED"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"ADMIN_DOWN"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
+ <span class="s2">"CCR_IGNORE"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"PRE_PROD"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/servers/hostname/:name/details</strong></p>
+<blockquote>
+<div><p>Retrieves the details of a server.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="19%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The host name part of the cache.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="6%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v12-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryservices</span></code></td>
+<td>array</td>
+<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v12-ds"><span class="std std-ref">Delivery Service</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">hardwareInfo</span></code></td>
+<td>hash</td>
+<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v12-hwinfo"><span class="std std-ref">Hardware Info</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time/Date of the last update for this server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">physLocation</span></code></td>
+<td>string</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v12-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v12-profile"><span class="std std-ref">Profiles</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v12-status"><span class="std std-ref">Status</span></a>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The default HTTPS port on which the main application listens (443 for a cache in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v12-type"><span class="std std-ref">Types</span></a>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">xmppId</span></code></td>
+<td>string</td>
+<td>Deprecated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmppPasswd</span></code></td>
+<td>string</td>
+<td>Deprecated.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"4"</span>
+ <span class="p">],</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s2">"YS08"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Model"</span><span class="p">:</span> <span class="s2">"PowerEdge R720xd"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s2">"4217A5"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Manufacturer"</span><span class="p">:</span> <span class="s2">"Dell Inc."</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"SysMemTotalSize"</span><span class="p">:</span> <span class="s2">"196608"</span><span class="p">,</span>
+ <span class="s2">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s2">"24"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s2">"13.5.7"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s2">"1.00"</span><span class="p">,</span>
+ <span class="s2">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s2">"7.0.0.29"</span><span class="p">,</span>
+ <span class="s2">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s2">"1.57.57"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"ServiceTag"</span><span class="p">:</span> <span class="s2">"D6XPDV1"</span><span class="p">,</span>
+ <span class="s2">"PowerState"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s2">"D903"</span><span class="p">,</span>
+ <span class="s2">"BIOS"</span><span class="p">:</span> <span class="s2">"1.3.6"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"System CPLD"</span><span class="p">:</span> <span class="s2">"1.0.3"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
+ <span class="s2">"PERC H710P Mini"</span><span class="p">:</span> <span class="s2">"21.0.2-0001"</span><span class="p">,</span>
+ <span class="s2">"PowerCap"</span><span class="p">:</span> <span class="s2">"689"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s2">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s2">"1.07"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s2">"7.2.20"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
+ <span class="s2">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s2">"D1S2"</span>
+ <span class="p">},</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"xmppId"</span><span class="p">:</span> <span class="s2">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
+ <span class="s2">"xmppPasswd"</span><span class="p">:</span> <span class="s2">"X"</span>
+
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/servercheck</strong></p>
+<blockquote>
+<div><p>Post a server check result to the serverchecks table.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="55%" />
+<col width="20%" />
+<col width="25%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">host_name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">servercheck_short_name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"host_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">""</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Response</span> <span class="n">Example</span><span class="p">:</span>
+
+<span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server Check was successfully updated."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/servers</strong></p>
+<blockquote>
+<div><p>Allow user to create a server.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="18%" />
+<col width="11%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>hostName</td>
+<td>yes</td>
+<td>The host name part of the server.</td>
+</tr>
+<tr class="row-odd"><td>domainName</td>
+<td>yes</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-even"><td>cachegroupId</td>
+<td>yes</td>
+<td>Cache Group ID</td>
+</tr>
+<tr class="row-odd"><td>interfaceName</td>
+<td>yes</td>
+<td>The interface name (e.g. eth0, p2p1).</td>
+</tr>
+<tr class="row-even"><td>ipAddress</td>
+<td>yes</td>
+<td>Must be unique per server profile.</td>
+</tr>
+<tr class="row-odd"><td>ipNetmask</td>
+<td>yes</td>
+<td>The IPv4 Netmask</td>
+</tr>
+<tr class="row-even"><td>ipGateway</td>
+<td>yes</td>
+<td>The IPv4 Gateway.</td>
+</tr>
+<tr class="row-odd"><td>interfaceMtu</td>
+<td>yes</td>
+<td>1500 or 9000</td>
+</tr>
+<tr class="row-even"><td>physLocationId</td>
+<td>yes</td>
+<td>The ID of the Physical Location.</td>
+</tr>
+<tr class="row-odd"><td>typeId</td>
+<td>yes</td>
+<td>The ID of the Server Type</td>
+</tr>
+<tr class="row-even"><td>profileId</td>
+<td>yes</td>
+<td>Profile ID - Profile’s CDN must match server’s.</td>
+</tr>
+<tr class="row-odd"><td>cdnId</td>
+<td>yes</td>
+<td>CDN ID the server belongs to</td>
+</tr>
+<tr class="row-even"><td>updPending</td>
+<td>yes</td>
+<td>Is there an update pending for this server. (true or false)</td>
+</tr>
+<tr class="row-odd"><td>statusId</td>
+<td>yes</td>
+<td>The Status ID of the server.</td>
+</tr>
+<tr class="row-even"><td>tcpPort</td>
+<td>no</td>
+<td>Must be a valid TCP port if specified.</td>
+</tr>
+<tr class="row-odd"><td>httpsPort</td>
+<td>no</td>
+<td>Must be a valid TCP port if specified.</td>
+</tr>
+<tr class="row-even"><td>xmppId</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>xmppPasswd</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>ip6Address</td>
+<td>no</td>
+<td>IPv6 address and prefix. Must be unique per server profile.</td>
+</tr>
+<tr class="row-odd"><td>ip6Gateway</td>
+<td>no</td>
+<td>IPv6 Gateway</td>
+</tr>
+<tr class="row-even"><td>rack</td>
+<td>no</td>
+<td>The rack location in the Data Center.</td>
+</tr>
+<tr class="row-odd"><td>mgmtIpAddress</td>
+<td>no</td>
+<td>The IPv4 management address.</td>
+</tr>
+<tr class="row-even"><td>mgmtIpNetmask</td>
+<td>no</td>
+<td>The IPv4 management netmask.</td>
+</tr>
+<tr class="row-odd"><td>mgmtIpGateway</td>
+<td>no</td>
+<td>The IPv4 management gateway.</td>
+</tr>
+<tr class="row-even"><td>iloIpAddress</td>
+<td>no</td>
+<td>The IPv4 ILO address.</td>
+</tr>
+<tr class="row-odd"><td>iloIpNetmask</td>
+<td>no</td>
+<td>The IPv4 ILO netmask.</td>
+</tr>
+<tr class="row-even"><td>iloIpGateway</td>
+<td>no</td>
+<td>The IPv4 ILO gateway.</td>
+</tr>
+<tr class="row-odd"><td>iloUsername</td>
+<td>no</td>
+<td>The ILO username.</td>
+</tr>
+<tr class="row-even"><td>iloPassword</td>
+<td>no</td>
+<td>The ILO password.</td>
+</tr>
+<tr class="row-odd"><td>routerHostName</td>
+<td>no</td>
+<td>The hostname of the router the server is connected to.</td>
+</tr>
+<tr class="row-even"><td>routerPortName</td>
+<td>no</td>
+<td>The portname in the router.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"tc1_ats1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"cdn1.kabletown.test"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"eth0"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.74.27.188"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.74.27.1"</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="mi">1500</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="mi">1</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="11%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>hostName</td>
+<td>string</td>
+<td>The host name part of the server.</td>
+</tr>
+<tr class="row-odd"><td>Name</td>
+<td>string</td>
+<td>Description</td>
+</tr>
+<tr class="row-even"><td>domainName</td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td>cachegroup</td>
+<td>string</td>
+<td>cache group name</td>
+</tr>
+<tr class="row-even"><td>interfaceName</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>ipAddress</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>ipNetmask</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>ipGateway</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>interfaceMtu</td>
+<td>string</td>
+<td>1500 or 9000</td>
+</tr>
+<tr class="row-odd"><td>physLocation</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>type</td>
+<td>string</td>
+<td>server type</td>
+</tr>
+<tr class="row-odd"><td>profile</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>cdnName</td>
+<td>string</td>
+<td>cdn name the server belongs to</td>
+</tr>
+<tr class="row-odd"><td>tcpPort</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>httpsPort</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>xmppId</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>xmppPasswd</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>ip6Address</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>ip6Gateway</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>rack</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>mgmtIpAddress</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>mgmtIpNetmask</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>mgmtIpGateway</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>iloIpAddress</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>iloIpNetmask</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>iloIpGateway</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>iloUsername</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>iloPassword</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>routerHostName</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>routerPortName</td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s1">'response'</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'profileId'</span> <span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s1">'xmppPasswd'</span> <span class="p">:</span> <span class="s1">'**********'</span><span class="p">,</span>
+ <span class="s1">'profile'</span> <span class="p">:</span> <span class="s1">'EDGE1_CDN1_421'</span><span class="p">,</span>
+ <span class="s1">'iloUsername'</span> <span class="p">:</span> <span class="s1">'username'</span><span class="p">,</span>
+ <span class="s1">'statusId'</span> <span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s1">'status'</span> <span class="p">:</span> <span class="s1">'REPORTED'</span><span class="p">,</span>
+ <span class="s1">'ipAddress'</span> <span class="p">:</span> <span class="s1">'10.74.27.188'</span><span class="p">,</span>
+ <span class="s1">'cdnId'</span> <span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s1">'physLocation'</span> <span class="p">:</span> <span class="s1">'plocation-chi-1'</span><span class="p">,</span>
+ <span class="s1">'cachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'interfaceName'</span> <span class="p">:</span> <span class="s1">'eth0'</span><span class="p">,</span>
+ <span class="s1">'ip6Gateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'iloPassword'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="mi">1003</span><span class="p">,</span>
+ <span class="s1">'routerPortName'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 14:16:16'</span><span class="p">,</span>
+ <span class="s1">'ipNetmask'</span> <span class="p">:</span> <span class="s1">'255.255.255.0'</span><span class="p">,</span>
+ <span class="s1">'ipGateway'</span> <span class="p">:</span> <span class="s1">'10.74.27.1'</span><span class="p">,</span>
+ <span class="s1">'tcpPort'</span> <span class="p">:</span> <span class="mi">80</span><span class="p">,</span>
+ <span class="s1">'httpsPort'</span> <span class="p">:</span> <span class="mi">443</span><span class="p">,</span>
+ <span class="s1">'mgmtIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'ip6Address'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'interfaceMtu'</span> <span class="p">:</span> <span class="mi">1500</span><span class="p">,</span>
+ <span class="s1">'iloIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'hostName'</span> <span class="p">:</span> <span class="s1">'tc1_ats1'</span><span class="p">,</span>
+ <span class="s1">'xmppId'</span> <span class="p">:</span> <span class="s1">'tc1_ats1'</span><span class="p">,</span>
+ <span class="s1">'rack'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'mgmtIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'iloIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'mgmtIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'type'</span> <span class="p">:</span> <span class="s1">'EDGE'</span><span class="p">,</span>
+ <span class="s1">'domainName'</span> <span class="p">:</span> <span class="s1">'cdn1.kabletown.test'</span><span class="p">,</span>
+ <span class="s1">'iloIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'routerHostName'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'updPending'</span> <span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s1">'guid'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'physLocationId'</span> <span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s1">'offlineReason'</span> <span class="p">:</span> <span class="s1">'N\/A'</span><span class="p">,</span>
+ <span class="s1">'cachegroupId'</span> <span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s1">'typeId'</span> <span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s1">'cdnName'</span> <span class="p">:</span> <span class="s1">'cdn1'</span><span class="p">,</span>
+ <span class="s1">'profileDesc'</span> <span class="p">:</span> <span class="s1">'The profile description'</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/servers/{:id}</strong></p>
+<blockquote>
+<div><p>Allow user to edit server through api.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="21%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>The id of the server to edit.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>hostName</td>
+<td>yes</td>
+<td>The host name part of the server.</td>
+</tr>
+<tr class="row-odd"><td>domainName</td>
+<td>yes</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-even"><td>cachegroup</td>
+<td>yes</td>
+<td>cache group name</td>
+</tr>
+<tr class="row-odd"><td>interfaceName</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>ipAddress</td>
+<td>yes</td>
+<td>Must be unique per server profile.</td>
+</tr>
+<tr class="row-odd"><td>ipNetmask</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>ipGateway</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>interfaceMtu</td>
+<td>no</td>
+<td>1500 or 9000</td>
+</tr>
+<tr class="row-even"><td>physLocation</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>type</td>
+<td>yes</td>
+<td>server type</td>
+</tr>
+<tr class="row-even"><td>profile</td>
+<td>yes</td>
+<td>Profile ID - Profile’s CDN must match server’s.</td>
+</tr>
+<tr class="row-odd"><td>cdnName</td>
+<td>yes</td>
+<td>cdn name the server belongs to</td>
+</tr>
+<tr class="row-even"><td>tcpPort</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>httpsPort</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>xmppId</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>xmppPasswd</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>ip6Address</td>
+<td>no</td>
+<td>Must be unique per server profile.</td>
+</tr>
+<tr class="row-odd"><td>ip6Gateway</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>rack</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>mgmtIpAddress</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>mgmtIpNetmask</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>mgmtIpGateway</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>iloIpAddress</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>iloIpNetmask</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>iloIpGateway</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>iloUsername</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>iloPassword</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>routerHostName</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>routerPortName</td>
+<td>no</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"tc1_ats2"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"my.test.com"</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"eth0"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.74.27.188"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.74.27.1"</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"1500"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="11%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>hostName</td>
+<td>string</td>
+<td>The host name part of the server.</td>
+</tr>
+<tr class="row-odd"><td>Name</td>
+<td>string</td>
+<td>Description</td>
+</tr>
+<tr class="row-even"><td>domainName</td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td>cachegroup</td>
+<td>string</td>
+<td>cache group name</td>
+</tr>
+<tr class="row-even"><td>interfaceName</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>ipAddress</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>ipNetmask</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>ipGateway</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>interfaceMtu</td>
+<td>string</td>
+<td>1500 or 9000</td>
+</tr>
+<tr class="row-odd"><td>physLocation</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>type</td>
+<td>string</td>
+<td>server type</td>
+</tr>
+<tr class="row-odd"><td>profile</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>cdnName</td>
+<td>string</td>
+<td>cdn name the server belongs to</td>
+</tr>
+<tr class="row-odd"><td>tcpPort</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>httpsPort</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>xmppId</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>xmppPasswd</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>ip6Address</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>ip6Gateway</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>rack</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>mgmtIpAddress</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>mgmtIpNetmask</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>mgmtIpGateway</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>iloIpAddress</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>iloIpNetmask</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>iloIpGateway</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>iloUsername</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>iloPassword</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td>routerHostName</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td>routerPortName</td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s1">'response'</span> <span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'xmppPasswd'</span> <span class="p">:</span> <span class="s1">'**********'</span><span class="p">,</span>
+ <span class="s1">'profile'</span> <span class="p">:</span> <span class="s1">'EDGE1_CDN1_421'</span><span class="p">,</span>
+ <span class="s1">'iloUsername'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'status'</span> <span class="p">:</span> <span class="s1">'REPORTED'</span><span class="p">,</span>
+ <span class="s1">'ipAddress'</span> <span class="p">:</span> <span class="s1">'10.74.27.188'</span><span class="p">,</span>
+ <span class="s1">'cdnId'</span> <span class="p">:</span> <span class="s1">'1'</span><span class="p">,</span>
+ <span class="s1">'physLocation'</span> <span class="p">:</span> <span class="s1">'plocation-chi-1'</span><span class="p">,</span>
+ <span class="s1">'cachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s1">'interfaceName'</span> <span class="p">:</span> <span class="s1">'eth0'</span><span class="p">,</span>
+ <span class="s1">'ip6Gateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'iloPassword'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'1003'</span><span class="p">,</span>
+ <span class="s1">'routerPortName'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 14:16:16'</span><span class="p">,</span>
+ <span class="s1">'ipNetmask'</span> <span class="p">:</span> <span class="s1">'255.255.255.0'</span><span class="p">,</span>
+ <span class="s1">'ipGateway'</span> <span class="p">:</span> <span class="s1">'10.74.27.1'</span><span class="p">,</span>
+ <span class="s1">'tcpPort'</span> <span class="p">:</span> <span class="s1">'80'</span><span class="p">,</span>
+ <span class="s1">'httpsPort'</span> <span class="p">:</span> <span class="s1">'443'</span><span class="p">,</span>
+ <span class="s1">'mgmtIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'ip6Address'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'interfaceMtu'</span> <span class="p">:</span> <span class="s1">'1500'</span><span class="p">,</span>
+ <span class="s1">'iloIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'hostName'</span> <span class="p">:</span> <span class="s1">'tc1_ats2'</span><span class="p">,</span>
+ <span class="s1">'xmppId'</span> <span class="p">:</span> <span class="s1">'tc1_ats1'</span><span class="p">,</span>
+ <span class="s1">'rack'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'mgmtIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'iloIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'mgmtIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'type'</span> <span class="p">:</span> <span class="s1">'EDGE'</span><span class="p">,</span>
+ <span class="s1">'domainName'</span> <span class="p">:</span> <span class="s1">'my.test.com'</span><span class="p">,</span>
+ <span class="s1">'iloIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s1">'routerHostName'</span> <span class="p">:</span> <span class="n">null</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/servers/{:id}/status</strong></p>
+<blockquote>
+<div><p>Updates server status and queues updates on all child caches if server type is EDGE or MID. Also, captures offline reason if status is set to ADMIN_DOWN or OFFLINE and prepends offline reason with the user that initiated the status change.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="13%" />
+<col width="21%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>The id of the server.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>status</td>
+<td>yes</td>
+<td>Status ID or name.</td>
+</tr>
+<tr class="row-odd"><td>offlineReason</td>
+<td>yes|no</td>
+<td>Required if status is ADMIN_DOWN or OFFLINE.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"Bad drives"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Updated status [ ADMIN_DOWN ] for foo.bar.net [ user23: bad drives ] and queued updates on all child caches"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/servers/{:id}</strong></p>
+<blockquote>
+<div><p>Allow user to delete server through api.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="12%" />
+<col width="20%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>The id of the server to delete.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server was deleted."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/servers/{:id}/queue_update</strong></p>
+<blockquote>
+<div><p>Queue or dequeue updates for a specific server.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="26%" />
+<col width="46%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>the server id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="13%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>action</td>
+<td>string</td>
+<td>queue or dequeue</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="20%" />
+<col width="13%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>action</td>
+<td>string</td>
+<td>The action processed, queue or dequeue.</td>
+</tr>
+<tr class="row-odd"><td>serverId</td>
+<td>integer</td>
+<td>server id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"queue"</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="static_dns.html" class="btn btn-neutral float-right" title="Static DNS Entries">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="role.html" class="btn btn-neutral" title="Roles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/static_dns.html b/docs/latest/api/v12/static_dns.html
new file mode 100644
index 0000000..f47c0bf
--- /dev/null
+++ b/docs/latest/api/v12/static_dns.html
@@ -0,0 +1,364 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Static DNS Entries — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Status" href="status.html"/>
+ <link rel="prev" title="Server" href="server.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Static DNS Entries</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/static_dns.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="status.html" class="btn btn-neutral float-right" title="Status">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="server.html" class="btn btn-neutral" title="Server"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="static-dns-entries">
+<span id="to-api-v12-dns"></span><h1>Static DNS Entries<a class="headerlink" href="#static-dns-entries" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-staticdnsentries">
+<span id="to-api-v12-static-dns-route"></span><h2>/api/1.2/staticdnsentries<a class="headerlink" href="#api-1-2-staticdnsentries" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/staticdnsentries.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="12%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">address</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">host</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"foo-ds"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CNAME_RECORD"</span><span class="p">,</span>
+ <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"bar.foo.baz.tv."</span><span class="p">,</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span><span class="p">,</span>
+ <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"mm"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="status.html" class="btn btn-neutral float-right" title="Status">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="server.html" class="btn btn-neutral" title="Server"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/status.html b/docs/latest/api/v12/status.html
new file mode 100644
index 0000000..94906b7
--- /dev/null
+++ b/docs/latest/api/v12/status.html
@@ -0,0 +1,447 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Status — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Steering Targets" href="steering_target.html"/>
+ <link rel="prev" title="Static DNS Entries" href="static_dns.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Status</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/status.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="steering_target.html" class="btn btn-neutral float-right" title="Steering Targets">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="static_dns.html" class="btn btn-neutral" title="Static DNS Entries"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="status">
+<span id="to-api-v12-status"></span><h1>Status<a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-statuses">
+<span id="to-api-v12-statuses-route"></span><h2>/api/1.2/statuses<a class="headerlink" href="#api-1-2-statuses" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/statuses</strong></p>
+<blockquote>
+<div><p>Retrieves a list of the server status codes available.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="8%" />
+<col width="76%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The id with which Traffic Ops stores this status, and references it internally</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The string equivalent of the status</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>A short description of the status</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_IGNORE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"OFFLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"REPORTED"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.2/statuses/:id</strong></p>
+<blockquote>
+<div><p>Retrieves a server status by ID.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Status id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="8%" />
+<col width="76%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The id with which Traffic Ops stores this status, and references it internally</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The string equivalent of the status</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td>A short description of the status</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this server entry was last updated</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="steering_target.html" class="btn btn-neutral float-right" title="Steering Targets">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="static_dns.html" class="btn btn-neutral" title="Static DNS Entries"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/steering_target.html b/docs/latest/api/v12/steering_target.html
new file mode 100644
index 0000000..89d029f
--- /dev/null
+++ b/docs/latest/api/v12/steering_target.html
@@ -0,0 +1,800 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Steering Targets — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="System" href="system.html"/>
+ <link rel="prev" title="Status" href="status.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Steering Targets</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/steering_target.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="system.html" class="btn btn-neutral float-right" title="System">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="status.html" class="btn btn-neutral" title="Status"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="steering-targets">
+<span id="to-api-v12-steering-targets"></span><h1>Steering Targets<a class="headerlink" href="#steering-targets" title="Permalink to this headline">¶</a></h1>
+<p id="to-api-v12-steering-target-route"><strong>GET /api/1.2/steering/:dsId/targets</strong></p>
+<blockquote>
+<div><p>Get all targets for a steering delivery service.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="15%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>DS ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryServiceId</span></code></td>
+<td>int</td>
+<td>DS ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>DS XML ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">targetId</span></code></td>
+<td>int</td>
+<td>Target DS ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">target</span></code></td>
+<td>string</td>
+<td>Target DS XML ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>int</td>
+<td>Value is weight or order depending on type</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>int</td>
+<td>Steering target type ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Steering target type name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"steering-ds-one"</span><span class="p">,</span>
+ <span class="s2">"targetId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"target"</span><span class="p">:</span> <span class="s2">"steering-target-one"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">35</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"STEERING_ORDER"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"steering-ds-one"</span><span class="p">,</span>
+ <span class="s2">"targetId"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="s2">"target"</span><span class="p">:</span> <span class="s2">"steering-target-two"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">35</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"STEERING_ORDER"</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/steering/:dsId/targets/:targetId</strong></p>
+<blockquote>
+<div><p>Get a steering target.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="15%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>DS ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">targetId</span></code></td>
+<td>yes</td>
+<td>DS Target ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryServiceId</span></code></td>
+<td>int</td>
+<td>DS ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>DS XML ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">targetId</span></code></td>
+<td>int</td>
+<td>Target DS ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">target</span></code></td>
+<td>string</td>
+<td>Target DS XML ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>int</td>
+<td>Value is weight or order depending on type</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>int</td>
+<td>Steering target type ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Steering target type name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"steering-ds-one"</span><span class="p">,</span>
+ <span class="s2">"targetId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"target"</span><span class="p">:</span> <span class="s2">"steering-target-one"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">35</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"STEERING_ORDER"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/steering/:dsId/targets/:targetId</strong></p>
+<blockquote>
+<div><p>Update a steering target.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Portal</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="15%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>DS ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">targetId</span></code></td>
+<td>yes</td>
+<td>DS Target ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="40%" />
+<col width="17%" />
+<col width="43%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>yes</td>
+<td>Target value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>yes</td>
+<td>Target type ID</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="mi">34</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">46</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="40%" />
+<col width="17%" />
+<col width="43%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryServiceId</span></code></td>
+<td>int</td>
+<td>Steering DS ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>DS XML ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">targetId</span></code></td>
+<td>int</td>
+<td>Target DS ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">target</span></code></td>
+<td>string</td>
+<td>Target DS XML ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>Target value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>int</td>
+<td>Target type ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Steering target type name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"steering-ds-one"</span><span class="p">,</span>
+ <span class="s2">"targetId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"target"</span><span class="p">:</span> <span class="s2">"steering-target-two"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"34"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"STEERING_ORDER"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service steering target update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/steering/:dsId/targets</strong></p>
+<blockquote>
+<div><p>Create a steering target.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Portal</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="15%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>DS ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="40%" />
+<col width="17%" />
+<col width="43%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">targetId</span></code></td>
+<td>yes</td>
+<td>Target DS ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>yes</td>
+<td>Target value</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>yes</td>
+<td>Target type ID</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"targetId"</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="mi">22</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">47</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="40%" />
+<col width="17%" />
+<col width="43%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryServiceId</span></code></td>
+<td>int</td>
+<td>Steering DS ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>DS XML ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">targetId</span></code></td>
+<td>int</td>
+<td>Target DS ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">target</span></code></td>
+<td>string</td>
+<td>Target DS XML ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">value</span></code></td>
+<td>string</td>
+<td>Target value</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>int</td>
+<td>Target type ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>Steering target type name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"steering-ds-one"</span><span class="p">,</span>
+ <span class="s2">"targetId"</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span>
+ <span class="s2">"target"</span><span class="p">:</span> <span class="s2">"steering-target-six"</span><span class="p">,</span>
+ <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">47</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"STEERING_ORDER"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service target creation was successful."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.2/steering/:dsId/targets/:targetId</strong></p>
+<blockquote>
+<div><p>Delete a steering target.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Portal</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="15%" />
+<col width="66%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>yes</td>
+<td>DS ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">targetId</span></code></td>
+<td>yes</td>
+<td>DS Target ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service target delete was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="system.html" class="btn btn-neutral float-right" title="System">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="status.html" class="btn btn-neutral" title="Status"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/system.html b/docs/latest/api/v12/system.html
new file mode 100644
index 0000000..ca3ca47
--- /dev/null
+++ b/docs/latest/api/v12/system.html
@@ -0,0 +1,382 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>System — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Tenants" href="tenant.html"/>
+ <link rel="prev" title="Steering Targets" href="steering_target.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>System</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/system.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="tenant.html" class="btn btn-neutral float-right" title="Tenants">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="steering_target.html" class="btn btn-neutral" title="Steering Targets"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="system">
+<span id="to-api-v12-sys"></span><h1>System<a class="headerlink" href="#system" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-system">
+<span id="to-api-v12-sys-route"></span><h2>/api/1.1/system<a class="headerlink" href="#api-1-1-system" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/system/info.json</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="5%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Key</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameters</span></code></td>
+<td>hash</td>
+<td>This is a hash with the parameter names that describe the Traffic Ops installation as keys.
+These are all the parameters in the <code class="docutils literal notranslate"><span class="pre">GLOBAL</span></code> profile.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tm.toolname</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Ops tool. Usually “Traffic Ops”. Used in the About screen and in the comments headers of the files generated
+(<code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">DO</span> <span class="pre">NOT</span> <span class="pre">EDIT</span> <span class="pre">-</span> <span class="pre">Generated</span> <span class="pre">for</span> <span class="pre">atsec-lax-04</span> <span class="pre">by</span> <span class="pre">Traffic</span> <span class="pre">Ops</span> <span class="pre">(https://traffops.kabletown.net/)</span> <span class="pre">on</span> <span class="pre">Fri</span> <span class="pre">Mar</span>  <span class="pre">6</span> <span class="pre">05:15:15</span> <span class="pre">UTC</span> <span class="pre">2015</span></code>).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.instance_name</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>traffic_rtr_fwd_proxy</span></code></td>
+<td>string</td>
+<td>When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through.
+This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting
+this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to
+set this parameter on a production system.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.url</span></code></td>
+<td>string</td>
+<td>The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated
+(<code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">DO</span> <span class="pre">NOT</span> <span class="pre">EDIT</span> <span class="pre">-</span> <span class="pre">Generated</span> <span class="pre">for</span> <span class="pre">atsec-lax-04</span> <span class="pre">by</span> <span class="pre">Traffic</span> <span class="pre">Ops</span> <span class="pre">(https://traffops.kabletown.net/)</span> <span class="pre">on</span> <span class="pre">Fri</span> <span class="pre">Mar</span>  <span class="pre">6</span> <span class="pre">05:15:15</span> <span class="pre">UTC</span> <span class="pre">2015</span></code>).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>traffic_mon_fwd_proxy</span></code></td>
+<td>string</td>
+<td>When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through.
+This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting
+this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to
+set this parameter on a production system.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>tm.logourl</span></code></td>
+<td>string</td>
+<td>This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>tm.infourl</span></code></td>
+<td>string</td>
+<td>This is the “for more information go here” URL, which is visible in the About page.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"tm.toolname"</span><span class="p">:</span> <span class="s2">"Traffic Ops"</span><span class="p">,</span>
+ <span class="s2">"tm.infourl"</span><span class="p">:</span> <span class="s2">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
+ <span class="s2">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s2">"tm.logourl"</span><span class="p">:</span> <span class="s2">"\/images\/tc_logo.png"</span><span class="p">,</span>
+ <span class="s2">"tm.url"</span><span class="p">:</span> <span class="s2">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
+ <span class="s2">"tm.instance_name"</span><span class="p">:</span> <span class="s2">"Kabletown CDN"</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="tenant.html" class="btn btn-neutral float-right" title="Tenants">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="steering_target.html" class="btn btn-neutral" title="Steering Targets"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/tenant.html b/docs/latest/api/v12/tenant.html
new file mode 100644
index 0000000..43de5d9
--- /dev/null
+++ b/docs/latest/api/v12/tenant.html
@@ -0,0 +1,655 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Tenants — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="TO Extensions" href="to_extension.html"/>
+ <link rel="prev" title="System" href="system.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Tenants</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/tenant.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="to_extension.html" class="btn btn-neutral float-right" title="TO Extensions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="system.html" class="btn btn-neutral" title="System"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="tenants">
+<span id="to-api-v12-tenant"></span><h1>Tenants<a class="headerlink" href="#tenants" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-tenants">
+<span id="to-api-v12-tenant-route"></span><h2>/api/1.2/tenants<a class="headerlink" href="#api-1-2-tenants" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/tenants</strong></p>
+<blockquote>
+<div><p>Get all tenants.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Tenant id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Tenant name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>Active or inactive</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td>
+<td>int</td>
+<td>Parent tenant ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentName</span></code></td>
+<td>string</td>
+<td>Parent tenant name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"parentId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"parentName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"tenant-a"</span><span class="p">,</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"parentId"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="s2">"parentName"</span><span class="p">:</span> <span class="s2">"root"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/tenants/:id</strong></p>
+<blockquote>
+<div><p>Get a tenant by ID.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Tenant id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Tenant name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>Active or inactive</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td>
+<td>int</td>
+<td>Parent tenant ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentName</span></code></td>
+<td>string</td>
+<td>Parent tenant name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"tenant-a"</span><span class="p">,</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"parentId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"parentName"</span><span class="p">:</span> <span class="s2">"root"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/tenants/:id</strong></p>
+<blockquote>
+<div><p>Update a tenant.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="25%" />
+<col width="13%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Tenant id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="18%" />
+<col width="47%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the tenant</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>yes</td>
+<td>True or false</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td>
+<td>yes</td>
+<td>Parent tenant</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"my-tenant"</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="s2">"parentId"</span><span class="p">:</span> <span class="mi">1</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Tenant id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Tenant name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>Active or inactive</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td>
+<td>int</td>
+<td>Parent tenant ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentName</span></code></td>
+<td>string</td>
+<td>Parent tenant name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"my-tenant"</span><span class="p">,</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"parentId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"parentName"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Tenant update was successful."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/tenants</strong></p>
+<blockquote>
+<div><p>Create a tenant.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="35%" />
+<col width="18%" />
+<col width="47%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the tenant</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>no</td>
+<td>Defaults to false</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td>
+<td>yes</td>
+<td>Parent tenant</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"your-tenant"</span>
+ <span class="s2">"parentId"</span><span class="p">:</span> <span class="mi">2</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Tenant id</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>Tenant name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>Active or inactive</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">parentId</span></code></td>
+<td>int</td>
+<td>Parent tenant ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parentName</span></code></td>
+<td>string</td>
+<td>Parent tenant name</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"your-tenant"</span><span class="p">,</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"parentId"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"parentName"</span><span class="p">:</span> <span class="s2">"my-tenant"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</span>
+ <span class="p">},</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Tenant create was successful."</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="to_extension.html" class="btn btn-neutral float-right" title="TO Extensions">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="system.html" class="btn btn-neutral" title="System"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/to_extension.html b/docs/latest/api/v12/to_extension.html
new file mode 100644
index 0000000..dddf1f1
--- /dev/null
+++ b/docs/latest/api/v12/to_extension.html
@@ -0,0 +1,582 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>TO Extensions — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Types" href="type.html"/>
+ <link rel="prev" title="Tenants" href="tenant.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>TO Extensions</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/to_extension.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="type.html" class="btn btn-neutral float-right" title="Types">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="tenant.html" class="btn btn-neutral" title="Tenants"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="to-extensions">
+<span id="to-api-v12-ext"></span><h1>TO Extensions<a class="headerlink" href="#to-extensions" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-to-extensions">
+<span id="to-api-v12-ext-route"></span><h2>/api/1.2/to_extensions<a class="headerlink" href="#api-1-2-to-extensions" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/to_extensions.json</strong></p>
+<p>Retrieves the list of extensions.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="10%" />
+<col width="56%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">script_file</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">info_url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">additional_config_json</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">isactive</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">servercheck_short_name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ilo_ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">9</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }"</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="n">name</span><span class="p">:</span> <span class="s2">"10G_PING"</span><span class="p">,</span>
+ <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }"</span><span class="p">,</span>
+ <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="nb">id</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+ <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"10G"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/to_extensions</strong></p>
+<blockquote>
+<div><p>Creates a Traffic Ops extension.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="10%" />
+<col width="56%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">info_url</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">script_file</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">isactive</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">additional_config_json</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">servercheck_short_name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
+ <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
+ <span class="s2">"info_url"</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
+ <span class="s2">"script_file"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
+ <span class="s2">"isactive"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"additional_config_json"</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.2</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">"ILO"</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="15%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Check Extension loaded."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/to_extensions/:id/delete</strong></p>
+<blockquote>
+<div><p>Deletes a Traffic Ops extension.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="29%" />
+<col width="49%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>TO extension id</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="15%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Extension deleted."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="type.html" class="btn btn-neutral float-right" title="Types">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="tenant.html" class="btn btn-neutral" title="Tenants"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/topology.html b/docs/latest/api/v12/topology.html
new file mode 100644
index 0000000..3135f6b
--- /dev/null
+++ b/docs/latest/api/v12/topology.html
@@ -0,0 +1,519 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Snapshot CRConfig — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="API 1.3 Reference" href="../v13/index.html"/>
+ <link rel="prev" title="Users" href="user.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Snapshot CRConfig</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/topology.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../v13/index.html" class="btn btn-neutral float-right" title="API 1.3 Reference">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="user.html" class="btn btn-neutral" title="Users"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="snapshot-crconfig">
+<span id="to-api-v12-topology"></span><h1>Snapshot CRConfig<a class="headerlink" href="#snapshot-crconfig" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-snapshot-cdn-name">
+<span id="to-api-v12-topology-route"></span><h2>/api/1.2/snapshot/{:cdn_name}<a class="headerlink" href="#api-1-2-snapshot-cdn-name" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/cdns/{:cdn_name}/snapshot</strong></p>
+<blockquote>
+<div><p>Retrieves the CURRENT snapshot for a CDN which doesn’t necessarily represent the current state of the CDN. The contents of this snapshot are currently used by Traffic Monitor and Traffic Router.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="14%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn_name</span></code></td>
+<td>yes</td>
+<td>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="7%" />
+<col width="72%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config</span></code></td>
+<td>hash</td>
+<td>General CDN configuration settings.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">contentRouters</span></code></td>
+<td>hash</td>
+<td>A list of Traffic Routers.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">contentServers</span></code></td>
+<td>hash</td>
+<td>A list of Traffic Servers and the delivery services associated with each.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServices</span></code></td>
+<td>hash</td>
+<td>A list of delivery services.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">edgeLocations</span></code></td>
+<td>hash</td>
+<td>A list of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td>Snapshot properties.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"config"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"contentRouters"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"contentServers"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"edgeLocations"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/cdns/{:cdn_name}/snapshot/new</strong></p>
+<blockquote>
+<div><p>Retrieves a PENDING snapshot for a CDN which represents the current state of the CDN. The contents of this snapshot are NOT currently used by Traffic Monitor and Traffic Router. Once a snapshot is performed, this snapshot will become the CURRENT snapshot and will be used by Traffic Monitor and Traffic Router.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="23%" />
+<col width="14%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdn_name</span></code></td>
+<td>yes</td>
+<td>CDN name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="7%" />
+<col width="72%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">config</span></code></td>
+<td>hash</td>
+<td>General CDN configuration settings.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">contentRouters</span></code></td>
+<td>hash</td>
+<td>A list of Traffic Routers.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">contentServers</span></code></td>
+<td>hash</td>
+<td>A list of Traffic Servers and the delivery services associated with each.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServices</span></code></td>
+<td>hash</td>
+<td>A list of delivery services.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">edgeLocations</span></code></td>
+<td>hash</td>
+<td>A list of cache groups.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
+<td>hash</td>
+<td>Snapshot properties.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"config"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"contentRouters"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"contentServers"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"edgeLocations"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span> <span class="o">...</span> <span class="p">},</span>
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/snapshot/{:cdn_name}</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="16%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>cdn_name</td>
+<td>yes</td>
+<td>The name of the cdn to snapshot configure</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>response</td>
+<td>string</td>
+<td>“SUCCESS”</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"SUCCESS"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../v13/index.html" class="btn btn-neutral float-right" title="API 1.3 Reference">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="user.html" class="btn btn-neutral" title="Users"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/type.html b/docs/latest/api/v12/type.html
new file mode 100644
index 0000000..e6ceb84
--- /dev/null
+++ b/docs/latest/api/v12/type.html
@@ -0,0 +1,501 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Types — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Users" href="user.html"/>
+ <link rel="prev" title="TO Extensions" href="to_extension.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Types</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/type.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="user.html" class="btn btn-neutral float-right" title="Users">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="to_extension.html" class="btn btn-neutral" title="TO Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="types">
+<span id="to-api-v12-type"></span><h1>Types<a class="headerlink" href="#types" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-types">
+<span id="to-api-v12-types-route"></span><h2>/api/1.2/types<a class="headerlink" href="#api-1-2-types" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.1/types</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">useInTable</span></code></td>
+<td>no</td>
+<td>Filter types by the table in which they apply</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">useInTable</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/types/trimmed</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ACTIVE_DIRECTORY"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"A_RECORD"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<p><strong>GET /api/1.1/types/:id</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="21%" />
+<col width="13%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Type ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">useInTable</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="user.html" class="btn btn-neutral float-right" title="Users">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="to_extension.html" class="btn btn-neutral" title="TO Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v12/user.html b/docs/latest/api/v12/user.html
new file mode 100644
index 0000000..4630f20
--- /dev/null
+++ b/docs/latest/api/v12/user.html
@@ -0,0 +1,2302 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Users — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.2 Reference" href="index.html"/>
+ <link rel="next" title="Snapshot CRConfig" href="topology.html"/>
+ <link rel="prev" title="Types" href="type.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v13/index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.2 Reference</a> »</li>
+
+ <li>Users</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v12/user.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="topology.html" class="btn btn-neutral float-right" title="Snapshot CRConfig">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="type.html" class="btn btn-neutral" title="Types"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="users">
+<span id="to-api-v12-users"></span><h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-2-users">
+<span id="to-api-v12-users-route"></span><h2>/api/1.2/users<a class="headerlink" href="#api-1-2-users" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.2/users</strong></p>
+<blockquote>
+<div><p>Retrieves all users.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>no</td>
+<td>Filter users by tenant ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">registrationSent</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>Owning tenant name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">users</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/users/:id</strong></p>
+<blockquote>
+<div><p>Retrieves user by ID.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>User id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>hash</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">registrationSent</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>Owning tenant name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="o">...</span> <span class="n">more</span> <span class="n">users</span>
+ <span class="p">},</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/users</strong></p>
+<blockquote>
+<div><p>Create a user.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="9%" />
+<col width="11%" />
+<col width="53%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">confirmLocalPassword</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">localPassword</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td>
+<td>bool</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>int</td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td>no</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>no</td>
+<td>Owning tenant ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="mi">6</span>
+ <span class="s2">"localPassword"</span><span class="p">:</span> <span class="s2">"password"</span>
+ <span class="s2">"confirmLocalPassword"</span><span class="p">:</span> <span class="s2">"password"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">publicSshKey</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">registrationSent</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">roleName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td>
+<td>int</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">{</span><span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span><span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span><span class="s2">"User creation was successful."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response: {</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"email"</span><span class="p">:</span><span class="s2">"email1@email.com"</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span><span class="s2">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"publicSshKey"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"registrationSent"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span><span class="mi">6</span><span class="p">,</span>
+ <span class="s2">"roleName"</span><span class="p">:</span><span class="s2">"portal"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span><span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span><span class="s2">"tsimpson"</span><span class="p">,</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/users/register</strong></p>
+<blockquote>
+<div><p>Register a user and send registration email.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: Admin or Operations</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="9%" />
+<col width="11%" />
+<col width="53%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td>yes</td>
+<td>Email address of the new user.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>int</td>
+<td>yes</td>
+<td>Role ID of the new user.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>yes</td>
+<td>Tenant ID of the new user.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"foo@bar.com"</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="s2">"1"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span><span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span><span class="s2">"Sent user registration to foo@bar.com with the following permissions [ role: admin | tenant: root ]"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/users/:id/deliveryservices</strong></p>
+<blockquote>
+<div><p>Retrieves all delivery services assigned to the user. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>User ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="5%" />
+<col width="80%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">active</span></code></td>
+<td>bool</td>
+<td>true if active, false if inactive.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cacheurl</span></code></td>
+<td>string</td>
+<td>Cache URL rule to apply to this delivery service.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ccrDnsTtl</span></code></td>
+<td>string</td>
+<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the delivery service belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">checkPath</span></code></td>
+<td>string</td>
+<td>The path portion of the URL to check this deliveryservice for health.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deepCachingType</span></code></td>
+<td>string</td>
+<td><p class="first">When to do Deep Caching for this Delivery Service:</p>
+<ul class="last simple">
+<li>NEVER (default)</li>
+<li>ALWAYS</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td>The display name of the delivery service.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp</span></code></td>
+<td>string</td>
+<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassIp6</span></code></td>
+<td>string</td>
+<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dnsBypassTtl</span></code></td>
+<td>string</td>
+<td>The TTL of the DNS bypass response.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dscp</span></code></td>
+<td>string</td>
+<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">edgeHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The EDGE header rewrite actions to perform.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoLimit</span></code></td>
+<td>string</td>
+<td><ul class="first simple">
+<li>0: None - no limitations</li>
+<li>1: Only route on CZF file hit</li>
+<li>2: Only route on CZF hit or when from USA</li>
+</ul>
+<p class="last">Note that this does not prevent access to content or makes content secure; it just prevents
+routing to the content by Traffic Router.</p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">geoLimitCountries</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">geoProvider</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">globalMaxMbps</span></code></td>
+<td>string</td>
+<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
+dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">globalMaxTps</span></code></td>
+<td>string</td>
+<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
+traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
+HTTP deliveryservices</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">httpBypassFqdn</span></code></td>
+<td>string</td>
+<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
+globalMaxMbps traffic on this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td>The deliveryservice id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">infoUrl</span></code></td>
+<td>string</td>
+<td>Use this to add a URL that points to more information about that deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">initialDispersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<td>bool</td>
+<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">logsEnabled</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc</span></code></td>
+<td>string</td>
+<td>Description field 1.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longDesc1</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longDesc2</span></code></td>
+<td>string</td>
+<td>Description field 2.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>type</span></code></td>
+<td>string</td>
+<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>>setNumber</span></code></td>
+<td>string</td>
+<td>The set Number of the matchList.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>>pattern</span></code></td>
+<td>string</td>
+<td>The regexp for the matchList.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">maxDnsAnswers</span></code></td>
+<td>string</td>
+<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
+available).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">midHeaderRewrite</span></code></td>
+<td>string</td>
+<td>The MID header rewrite actions to perform.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">missLat</span></code></td>
+<td>string</td>
+<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">missLong</span></code></td>
+<td>string</td>
+<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOrigin</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<td>bool</td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">orgServerFqdn</span></code></td>
+<td>string</td>
+<td>The origin server base URL (FQDN when used in this instance, includes the
+protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">originShield</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileDescription</span></code></td>
+<td>string</td>
+<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>string</td>
+<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileName</span></code></td>
+<td>string</td>
+<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
+<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
+<li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">qstringIgnore</span></code></td>
+<td>string</td>
+<td><ul class="first last simple">
+<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
+<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
+<li>2: drop query string at edge, and do not use it in the cache-key.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rangeRequestHandling</span></code></td>
+<td>string</td>
+<td><p class="first">How to treat range requests:</p>
+<ul class="last simple">
+<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
+<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li>
+<li>2 Use the cache_range_requests plugin.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">regexRemap</span></code></td>
+<td>string</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regionalGeoBlocking</span></code></td>
+<td>bool</td>
+<td>Regex Remap rule to apply to this delivery service at the Edge tier.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">remapText</span></code></td>
+<td>string</td>
+<td>Additional raw remap line text.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">routingName</span></code></td>
+<td>string</td>
+<td>The routing name of this deliveryservice.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">signed</span></code></td>
+<td>bool</td>
+<td><ul class="first last simple">
+<li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li>
+<li>true: token based auth is enabled for this deliveryservice.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">sslKeyVersion</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>Owning tenant name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">trRequestHeaders</span></code></td>
+<td>string</td>
+<td>List of header keys separated by <code class="docutils literal notranslate"><span class="pre">__RETURN__</span></code>. Listed headers will be included in TR access log entries under the “rh=” token.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">trResponseHeaders</span></code></td>
+<td>string</td>
+<td>List of header <code class="docutils literal notranslate"><span class="pre">name:value</span></code> pairs separated by <code class="docutils literal notranslate"><span class="pre">__RETURN__</span></code>. Listed pairs will be included in all TR HTTP responses.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">type</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typeId</span></code></td>
+<td>string</td>
+<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td>Unique string that describes this deliveryservice.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"deepCachingType"</span><span class="p">:</span> <span class="s2">"NEVER"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://foo.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"routingName"</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/user/current</strong></p>
+<blockquote>
+<div><p>Retrieves the profile for the authenticated user.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="11%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">localUser</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>Owning tenant name</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"50"</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Callahan"</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span>
+
+ <span class="p">},</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.2/user/current</strong></p>
+<blockquote>
+<div><p>Updates the date for the authenticated user.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="11%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">city</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">phoneNumber</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">company</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fullName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">localUser</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">uid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stateOrProvince</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">newUser</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine2</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">role</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">addressLine1</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">gid</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">postalCode</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"user"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
+ <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"UserProfile was successfully updated."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/user/current/jobs.json</strong></p>
+<blockquote>
+<div><p>Retrieves the user’s list of jobs.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="16%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keyword</span></code></td>
+<td>no</td>
+<td>PURGE</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">keyword</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">objectName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">assetUrl</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">assetType</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">status</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsXmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">username</span></code></td>
+<td>boolean</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">parameters</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">enteredTime</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">objectType</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">agent</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">startTime</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
+ <span class="s2">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"assetType"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"PENDING"</span><span class="p">,</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"dsXmlId"</span><span class="p">:</span> <span class="s2">"ds-xml-id"</span><span class="p">,</span>
+ <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"peewee"</span><span class="p">,</span>
+ <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:56h"</span><span class="p">,</span>
+ <span class="s2">"enteredTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 18:00:16"</span><span class="p">,</span>
+ <span class="s2">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"agent"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 10:45:38"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST/api/1.2/user/current/jobs</strong></p>
+<p>Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the <em>regex_revalidate</em> ATS plugin. This forces a <em>revalidation</em> of the content, rather than a new get.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">This method forces a HTTP <em>revalidation</em> of the content, and not a new <em>GET</em> - the origin needs to support revalidation according to the HTTP/1.2 specification, and send a <code class="docutils literal notranslate"><span class="pre">200</span> <span class="pre">OK</span></code> or <code class="docutils literal notranslate"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> as applicable.</p>
+</div>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<blockquote>
+<div><p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">dsId</span></code></td>
+<td>string</td>
+<td>Unique Delivery Service ID</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">regex</span></code></td>
+<td>string</td>
+<td>Path Regex this should be a
+<a class="reference external" href="http://www.pcre.org/">PCRE</a> compatible
+regular expression for the path to match for
+forcing the revalidation. Be careful to only
+match on the content you need to remove -
+revalidation is an expensive operation for
+many origins, and a simple <code class="docutils literal notranslate"><span class="pre">/.*</span></code> can cause
+an overload condition of the origin.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">startTime</span></code></td>
+<td>string</td>
+<td>Start Time is the time when the revalidation
+rule will be made active. Populate
+with the current time to schedule ASAP. This
+value cannot be more than 2 days before now.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ttl</span></code></td>
+<td>int</td>
+<td>Time To Live is how long the revalidation rule
+will be active for in hours. It usually makes
+sense to make this the same as the
+<code class="docutils literal notranslate"><span class="pre">Cache-Control</span></code> header from the origin which
+sets the object time to live in cache
+(by <code class="docutils literal notranslate"><span class="pre">max-age</span></code> or <code class="docutils literal notranslate"><span class="pre">Expires</span></code>). Entering a
+longer TTL here will make the caches do
+unnecessary work.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
+ <span class="s2">"regex"</span><span class="p">:</span> <span class="s2">"/path/to/content.jpg"</span><span class="p">,</span>
+ <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-27 11:08:37"</span><span class="p">,</span>
+ <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully created purge job for: ."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/user/login</strong></p>
+<blockquote>
+<div><p>Authentication of a user using username and password. Traffic Ops will send back a session cookie.</p>
+<p>Authentication Required: No</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">u</span></code></td>
+<td>string</td>
+<td>username</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">p</span></code></td>
+<td>string</td>
+<td>password</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"u"</span><span class="p">:</span> <span class="s2">"username"</span><span class="p">,</span>
+ <span class="s2">"p"</span><span class="p">:</span> <span class="s2">"password"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully logged in."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.2/user/:id/deliveryservices/available</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">displayName</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">xmlId</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"90"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"Foo Bar DS"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-bar"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"92"</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"Foo Baz DS"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-baz"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/user/login/token</strong></p>
+<blockquote>
+<div><p>Authentication of a user using a token.</p>
+<p>Authentication Required: No</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">t</span></code></td>
+<td>string</td>
+<td>token-value</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="38%" />
+<col width="24%" />
+<col width="38%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Unauthorized, please log in."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/user/logout</strong></p>
+<blockquote>
+<div><p>User logout. Invalidates the session cookie.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><ul class="first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">level</span></code></li>
+</ul>
+</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><ul class="first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">text</span></code></li>
+</ul>
+</td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"You are logged out."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.2/user/reset_password</strong></p>
+<blockquote>
+<div><p>Reset user password.</p>
+<p>Authentication Required: No</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">email</span></code></td>
+<td>string</td>
+<td>The email address of the user to initiate
+password reset.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="28%" />
+<col width="10%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><ul class="first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">level</span></code></li>
+</ul>
+</td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><ul class="first last simple">
+<li><code class="docutils literal notranslate"><span class="pre">text</span></code></li>
+</ul>
+</td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully sent password reset to email 'email@email.com'"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="topology.html" class="btn btn-neutral float-right" title="Snapshot CRConfig">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="type.html" class="btn btn-neutral" title="Types"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v13/coordinate.html b/docs/latest/api/v13/coordinate.html
new file mode 100644
index 0000000..ec19e5b
--- /dev/null
+++ b/docs/latest/api/v13/coordinate.html
@@ -0,0 +1,705 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Coordinate — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.3 Reference" href="index.html"/>
+ <link rel="next" title="Origin" href="origin.html"/>
+ <link rel="prev" title="API 1.3 Reference" href="index.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.3 Reference</a> »</li>
+
+ <li>Coordinate</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v13/coordinate.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="origin.html" class="btn btn-neutral float-right" title="Origin">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="index.html" class="btn btn-neutral" title="API 1.3 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="coordinate">
+<span id="to-api-v13-coordinate"></span><h1>Coordinate<a class="headerlink" href="#coordinate" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-3-coordinates">
+<span id="to-api-v13-coordinates-route"></span><h2>/api/1.3/coordinates<a class="headerlink" href="#api-1-3-coordinates" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.3/coordinates</strong></p>
+<blockquote>
+<div><p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>no</td>
+<td>Filter Coordinates by ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>no</td>
+<td>Filter Coordinates by name.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="7%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Local unique identifier for the Coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>float</td>
+<td>Latitude of the Coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>float</td>
+<td>Longitude of the Coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Coordinate</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">21</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">22</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago-1"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.3/coordinates</strong></p>
+<blockquote>
+<div><p>Create Coordinate.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the Coordinate entry</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>no</td>
+<td>Latitude of the Coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>no</td>
+<td>Longitude of the Coordinate</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"my_coordinate"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mf">1.2</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mf">4.5</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>The id of the Coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>float</td>
+<td>Latitude of the Coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>float</td>
+<td>Longitude of the Coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"coordinate was created"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'longitude'</span> <span class="p">:</span> <span class="mf">4.5</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'my_coordinate'</span><span class="p">,</span>
+ <span class="s1">'latitude'</span> <span class="p">:</span> <span class="mf">1.2</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="mi">1</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.3/coordinates</strong></p>
+<blockquote>
+<div><p>Update coordinate.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="12%" />
+<col width="19%" />
+<col width="69%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>The id of the coordinate to edit.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="30%" />
+<col width="9%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>The id of the Coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the Coordinate entry</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>no</td>
+<td>Latitude of the Coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>no</td>
+<td>Longitude of the Coordinate</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"my_coordinate"</span><span class="p">,</span>
+ <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="32%" />
+<col width="7%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>The id of the Coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">latitude</span></code></td>
+<td>float</td>
+<td>Latitude of the Coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">longitude</span></code></td>
+<td>float</td>
+<td>Longitude of the Coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"coordinate was updated"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s1">'longitude'</span> <span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'my_coordinate'</span><span class="p">,</span>
+ <span class="s1">'latitude'</span> <span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s1">'id'</span> <span class="p">:</span> <span class="mi">1</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.3/coordinates</strong></p>
+<blockquote>
+<div><p>Delete coordinate.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="19%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>The id of the coordinate to delete.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"coordinate was deleted"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="origin.html" class="btn btn-neutral float-right" title="Origin">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="index.html" class="btn btn-neutral" title="API 1.3 Reference"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v13/index.html b/docs/latest/api/v13/index.html
new file mode 100644
index 0000000..b1e2514
--- /dev/null
+++ b/docs/latest/api/v13/index.html
@@ -0,0 +1,303 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>API 1.3 Reference — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="APIs" href="../index.html"/>
+ <link rel="next" title="Coordinate" href="coordinate.html"/>
+ <link rel="prev" title="Snapshot CRConfig" href="../v12/topology.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li>API 1.3 Reference</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v13/index.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="coordinate.html" class="btn btn-neutral float-right" title="Coordinate">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../v12/topology.html" class="btn btn-neutral" title="Snapshot CRConfig"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="api-1-3-reference">
+<h1>API 1.3 Reference<a class="headerlink" href="#api-1-3-reference" title="Permalink to this headline">¶</a></h1>
+<p>Traffic Ops API V1.3</p>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="coordinate.html">Coordinate</a></li>
+<li class="toctree-l1"><a class="reference internal" href="origin.html">Origin</a></li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="coordinate.html" class="btn btn-neutral float-right" title="Coordinate">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="../v12/topology.html" class="btn btn-neutral" title="Snapshot CRConfig"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/api/v13/origin.html b/docs/latest/api/v13/origin.html
new file mode 100644
index 0000000..6aa3b8d
--- /dev/null
+++ b/docs/latest/api/v13/origin.html
@@ -0,0 +1,1034 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Origin — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="API 1.3 Reference" href="index.html"/>
+ <link rel="next" title="FAQ" href="../../faq/index.html"/>
+ <link rel="prev" title="Coordinate" href="coordinate.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="index.html">API 1.3 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.3 Reference</a> »</li>
+
+ <li>Origin</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v13/origin.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../../faq/index.html" class="btn btn-neutral float-right" title="FAQ">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="coordinate.html" class="btn btn-neutral" title="Coordinate"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="origin">
+<span id="to-api-v13-origin"></span><h1>Origin<a class="headerlink" href="#origin" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-3-origins">
+<span id="to-api-v13-origin-route"></span><h2>/api/1.3/origins<a class="headerlink" href="#api-1-3-origins" title="Permalink to this headline">¶</a></h2>
+<p><strong>GET /api/1.3/origins</strong></p>
+<blockquote>
+<div><p>Get Origins.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="18%" />
+<col width="55%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>no</td>
+<td>Filter Origins by cachegroup ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">coordinate</span></code></td>
+<td>no</td>
+<td>Filter Origins by coordinate ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code></td>
+<td>no</td>
+<td>Filter Origins by deliveryservice ID.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>no</td>
+<td>Filter Origins by ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>no</td>
+<td>Filter Origins by name.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>no</td>
+<td>Filter Origins by profile ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">primary</span></code></td>
+<td>no</td>
+<td>Filter Origins by isPrimary.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>no</td>
+<td>Filter Origins by tenant ID.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="15%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Name of the Origin’s cachegroup</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>int</td>
+<td>ID of the Origin’s cachegroup</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">coordinate</span></code></td>
+<td>string</td>
+<td>Name of the Origin’s coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">coordinateID</span></code></td>
+<td>int</td>
+<td>ID of the Origin’s coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>XML_ID of the Origin’s delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServiceId</span></code></td>
+<td>int</td>
+<td>ID of the Origin’s delivery service</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fqdn</span></code></td>
+<td>string</td>
+<td>The FQDN of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Local unique identifier for the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>IPv6 address of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>IPv4 address of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">isPrimary</span></code></td>
+<td>boolean</td>
+<td>Whether or not this is the primary Origin for the delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">port</span></code></td>
+<td>int</td>
+<td>The TCP port on which the Origin listens</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The profile name of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The profile ID of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td>The protocol of the Origin’s URL (http or https)</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>The tenant name of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>The tenant ID of the Origin</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"cg1"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"coordinate"</span><span class="p">:</span> <span class="s2">"coordinate1"</span><span class="p">,</span>
+ <span class="s2">"coordinateId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"myds"</span><span class="p">,</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"fqdn"</span><span class="p">:</span> <span class="s2">"example.com"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"cafe:dead:d0d0::42"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.2.3.4"</span><span class="p">,</span>
+ <span class="s2">"isPrimary"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2018-05-08 19:33:18+00"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"my-origin"</span><span class="p">,</span>
+ <span class="s2">"port"</span><span class="p">:</span> <span class="mi">443</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"my-origins"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"https"</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"tenantA"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">3</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"coordinate"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"coordinateId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"fqdn"</span><span class="p">:</span> <span class="s2">"foo.example.com"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"isPrimary"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2018-05-08 19:35:12+00"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"origin2"</span><span class="p">,</span>
+ <span class="s2">"port"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"http"</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="n">null</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.3/origins</strong></p>
+<blockquote>
+<div><p>Create Origin.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="15%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>no</td>
+<td>ID of the Origin’s cachegroup</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">coordinateID</span></code></td>
+<td>no</td>
+<td>ID of the Origin’s coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryServiceId</span></code></td>
+<td>yes</td>
+<td>ID of the Origin’s delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fqdn</span></code></td>
+<td>yes</td>
+<td>The FQDN of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>no</td>
+<td>IPv6 address of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>no</td>
+<td>IPv4 address of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">port</span></code></td>
+<td>no</td>
+<td>The TCP port on which the Origin listens</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>no</td>
+<td>The profile ID of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>yes</td>
+<td>The protocol of the Origin’s URL (http or https)</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>no</td>
+<td>The tenant ID of the Origin</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"coordinateId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"fqdn"</span><span class="p">:</span> <span class="s2">"foo.example.com"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"cafe:dead:d0d0::42"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.2.3.4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"origin1"</span><span class="p">,</span>
+ <span class="s2">"port"</span><span class="p">:</span> <span class="mi">443</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"https"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="15%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Name of the Origin’s cachegroup</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>int</td>
+<td>ID of the Origin’s cachegroup</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">coordinate</span></code></td>
+<td>string</td>
+<td>Name of the Origin’s coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">coordinateID</span></code></td>
+<td>int</td>
+<td>ID of the Origin’s coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>XML_ID of the Origin’s delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServiceId</span></code></td>
+<td>int</td>
+<td>ID of the Origin’s delivery service</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fqdn</span></code></td>
+<td>string</td>
+<td>The FQDN of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Local unique identifier for the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>IPv6 address of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>IPv4 address of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">isPrimary</span></code></td>
+<td>boolean</td>
+<td>Whether or not this is the primary Origin for the delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">port</span></code></td>
+<td>int</td>
+<td>The TCP port on which the Origin listens</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The profile name of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The profile ID of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td>The protocol of the Origin’s URL (http or https)</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>The tenant name of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>The tenant ID of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"origin was created."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"coordinate"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"coordinateId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"fqdn"</span><span class="p">:</span> <span class="s2">"foo.example.com"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"cafe:dead:d0d0::42"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.2.3.4"</span><span class="p">,</span>
+ <span class="s2">"isPrimary"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2018-05-08 20:30:27+00"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"origin1"</span><span class="p">,</span>
+ <span class="s2">"port"</span><span class="p">:</span> <span class="mi">443</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"https"</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>PUT /api/1.3/origins</strong></p>
+<blockquote>
+<div><p>Update origin.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="12%" />
+<col width="19%" />
+<col width="69%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>The id of the coordinate to edit.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="15%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>no</td>
+<td>ID of the Origin’s cachegroup</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">coordinateID</span></code></td>
+<td>no</td>
+<td>ID of the Origin’s coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryServiceId</span></code></td>
+<td>yes</td>
+<td>ID of the Origin’s delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">fqdn</span></code></td>
+<td>yes</td>
+<td>The FQDN of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>The ID of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>no</td>
+<td>IPv6 address of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>no</td>
+<td>IPv4 address of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>yes</td>
+<td>The name of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">port</span></code></td>
+<td>no</td>
+<td>The TCP port on which the Origin listens</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>no</td>
+<td>The profile ID of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>yes</td>
+<td>The protocol of the Origin’s URL (http or https)</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>no</td>
+<td>The tenant ID of the Origin</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"coordinateId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"fqdn"</span><span class="p">:</span> <span class="s2">"foo.example.com"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"cafe:dead:d0d0::42"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.2.3.4"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"origin1"</span><span class="p">,</span>
+ <span class="s2">"port"</span><span class="p">:</span> <span class="mi">443</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"https"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="15%" />
+<col width="58%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">cachegroup</span></code></td>
+<td>string</td>
+<td>Name of the Origin’s cachegroup</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cachegroupId</span></code></td>
+<td>int</td>
+<td>ID of the Origin’s cachegroup</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">coordinate</span></code></td>
+<td>string</td>
+<td>Name of the Origin’s coordinate</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">coordinateID</span></code></td>
+<td>int</td>
+<td>ID of the Origin’s coordinate</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deliveryService</span></code></td>
+<td>string</td>
+<td>XML_ID of the Origin’s delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">deliveryServiceId</span></code></td>
+<td>int</td>
+<td>ID of the Origin’s delivery service</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">fqdn</span></code></td>
+<td>string</td>
+<td>The FQDN of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">id</span></code></td>
+<td>int</td>
+<td>Local unique identifier for the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>IPv6 address of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>IPv4 address of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">isPrimary</span></code></td>
+<td>boolean</td>
+<td>Whether or not this is the primary Origin for the delivery service</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time / Date this entry was last updated</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">name</span></code></td>
+<td>string</td>
+<td>The name of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">port</span></code></td>
+<td>int</td>
+<td>The TCP port on which the Origin listens</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">profile</span></code></td>
+<td>string</td>
+<td>The profile name of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">profileId</span></code></td>
+<td>int</td>
+<td>The profile ID of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">protocol</span></code></td>
+<td>string</td>
+<td>The protocol of the Origin’s URL (http or https)</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>The tenant name of the Origin</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>The tenant ID of the Origin</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"origin was updated."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"coordinate"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"coordinateId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"fqdn"</span><span class="p">:</span> <span class="s2">"foo.example.com"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"cafe:dead:d0d0::42"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.2.3.4"</span><span class="p">,</span>
+ <span class="s2">"isPrimary"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2018-05-08 20:30:27+00"</span><span class="p">,</span>
+ <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"origin1"</span><span class="p">,</span>
+ <span class="s2">"port"</span><span class="p">:</span> <span class="mi">443</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"https"</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>DELETE /api/1.3/origin</strong></p>
+<blockquote>
+<div><p>Delete origin.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: admin or oper</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="11%" />
+<col width="19%" />
+<col width="70%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>id</td>
+<td>yes</td>
+<td>The id of the origin to delete.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
+ <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"origin was deleted"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../../faq/index.html" class="btn btn-neutral float-right" title="FAQ">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="coordinate.html" class="btn btn-neutral" title="Coordinate"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/latest/basics/cache_revalidation.html b/docs/latest/basics/cache_revalidation.html
index 3879f87..ab8ed7e 100644
--- a/docs/latest/basics/cache_revalidation.html
+++ b/docs/latest/basics/cache_revalidation.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Cache Control Headers and Revalidation — Traffic Control 2.1-dev documentation </title>
+ <title>Cache Control Headers and Revalidation — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="CDN Basics" href="index.html"/>
<link rel="next" title="Traffic Control Overview" href="../overview/index.html"/>
<link rel="prev" title="Caching Proxies" href="caching_proxies.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">CDN Basics</a> »</li>
<li>Cache Control Headers and Revalidation</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/basics/cache_revalidation.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/basics/cache_revalidation.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -192,7 +206,7 @@
<div class="section" id="cache-control-headers-and-revalidation">
<span id="index-0"></span><h1>Cache Control Headers and Revalidation<a class="headerlink" href="#cache-control-headers-and-revalidation" title="Permalink to this headline">¶</a></h1>
<p>The <a class="reference external" href="https://www.ietf.org/rfc/rfc2616.txt">HTTP/1.1 spec</a> allows for origin servers and clients to influence how caches treat their requests and responses. By default, the Traffic Control CDN will honor cache control headers. Most commonly, origin servers will tell the downstream caches how long a response can be cached:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
@@ -205,14 +219,14 @@
<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
-<p>In the above response, the origin server tells downstream caching systems that the maximum time to cache this response for is 86400 seconds. The origin can also add a <code class="docutils literal"><span class="pre">Expires:</span></code> header, explicitly telling the cache the time this response is to be expired. When a response is expired it usually doesn’t get deleted from the cache, but, when a request comes in that would have hit on this response if it was not expired, the cache <em>revalidates</em> the response. In stead of requesting the object again from the origin server, the cache will send a request to the origin indicating what version of the response it has, and asking if it has changed. If it changed, the server will send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> response, with the new data. If it has not changed, the origin server will send back a <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> response indicating the response is still valid, and that the cache can reset the timer on the response expiration. To indicate what version the client (cache) has it will add an <code class="docutils literal"><span class="pre">If-Not-Modified-Since:</span></code> header, or an <code class="docutils literal"><span class="pre">If-None-Match:</span></code> header. For example, in the <code class="docutils literal"><span class="pre">If-None-Match:</span></code> case, the origin will send and <code class="docutils literal"><span class="pre">ETag</span></code> header that uniquely identifies the response. The client can use that in an revalidation request like:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<p>In the above response, the origin server tells downstream caching systems that the maximum time to cache this response for is 86400 seconds. The origin can also add a <code class="docutils literal notranslate"><span class="pre">Expires:</span></code> header, explicitly telling the cache the time this response is to be expired. When a response is expired it usually doesn’t get deleted from the cache, but, when a request comes in that would have hit on this response if it was not expired, the cache <em>revalidates</em> the response. In stead of requesting the object again from the origin server, the cache will send a request to the origin indicating what version of the response it has, and asking if it has changed. If it changed, the server will send a <code class="docutils literal notranslate"><span class="pre">200</span> <span class="pre">OK</span></code> response, with the new data. If it has not changed, the origin server will send back a <code class="docutils literal notranslate"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code> response indicating the response is still valid, and that the cache can reset the timer on the response expiration. To indicate what version the client (cache) has it will add an <code class="docutils literal notranslate"><span class="pre">If-Not-Modified-Since:</span></code> header, or an <code class="docutils literal notranslate"><span class="pre">If-None-Match:</span></code> header. For example, in the <code class="docutils literal notranslate"><span class="pre">If-None-Match:</span></code> case, the origin will send and <code class="docutils literal notranslate"><span class="pre">ETag</span></code> header that uniquely identifies the response. The client can use that in an revalidation request like:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
<span class="n">If</span><span class="o">-</span><span class="kc">None</span><span class="o">-</span><span class="n">Match</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
-<p>If the content has changed (meaning, the new response would not have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code>, like:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<p>If the content has changed (meaning, the new response would not have had the same ETag) it will respond with <code class="docutils literal notranslate"><span class="pre">200</span> <span class="pre">OK</span></code>, like:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
@@ -225,8 +239,8 @@
<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">NOT</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
-<p>If the Content did not change (meaning, the response would have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code>, like:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">304</span> <span class="n">Not</span> <span class="n">Modified</span>
+<p>If the Content did not change (meaning, the response would have had the same ETag) it will respond with <code class="docutils literal notranslate"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code>, like:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">304</span> <span class="n">Not</span> <span class="n">Modified</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
@@ -273,16 +287,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/basics/caching_proxies.html b/docs/latest/basics/caching_proxies.html
index 33bc98e..2281e30 100644
--- a/docs/latest/basics/caching_proxies.html
+++ b/docs/latest/basics/caching_proxies.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Caching Proxies — Traffic Control 2.1-dev documentation </title>
+ <title>Caching Proxies — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="CDN Basics" href="index.html"/>
<link rel="next" title="Cache Control Headers and Revalidation" href="cache_revalidation.html"/>
<link rel="prev" title="HTTP 1.1" href="http_11.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">CDN Basics</a> »</li>
<li>Caching Proxies</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/basics/caching_proxies.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/basics/caching_proxies.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -204,14 +218,14 @@
All EDGE caches in a Traffic Control CDN are reverse proxies.
To the end user a Traffic Control based CDN appears as a reverse proxy since
it retrieves content from the origin server, acting on behalf of that origin server. The client requests a URL that has
-a hostname which resolves to the reverse proxy’s IP address and, in compliance
-with the HTTP 1.1 specification, the client sends a <code class="docutils literal"><span class="pre">Host:</span></code> header to the reverse
+a hostname which resolves to the reverse proxy’s IP address and, in compliance
+with the HTTP 1.1 specification, the client sends a <code class="docutils literal notranslate"><span class="pre">Host:</span></code> header to the reverse
proxy that matches the hostname in the URL.
The proxy looks up this hostname in a
list of mappings to find the origin hostname; if the hostname of the Host header is not found in the list,
-the proxy will send an error (<code class="docutils literal"><span class="pre">404</span> <span class="pre">Not</span> <span class="pre">Found</span></code>) to the client.
+the proxy will send an error (<code class="docutils literal notranslate"><span class="pre">404</span> <span class="pre">Not</span> <span class="pre">Found</span></code>) to the client.
If the supplied hostname is found in this list of mappings, the proxy checks the cache, and when the content is not already present, connects to the
-origin the requested <code class="docutils literal"><span class="pre">Host:</span></code> maps to and requests the path of the original URL, providing the origin hostname in the <code class="docutils literal"><span class="pre">Host</span></code> header. The proxy then stores the URL in cache and serves the contents to the client. When there are subsequent requests for
+origin the requested <code class="docutils literal notranslate"><span class="pre">Host:</span></code> maps to and requests the path of the original URL, providing the origin hostname in the <code class="docutils literal notranslate"><span class="pre">Host</span></code> header. The proxy then stores the URL in cache and serves the contents to the client. When there are subsequent requests for
the same URL, a caching proxy serves the content out of cache thereby reducing
latency and network traffic.</div></blockquote>
<div class="admonition seealso">
@@ -219,15 +233,15 @@
<p class="last"><a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin/reverse-proxy-http-redirects.en.html#http-reverse-proxy">ATS documentation on reverse proxy</a>.</p>
</div>
<p>To insert a reverse proxy into the previous HTTP 1.1 example, the reverse proxy requires provisioning
-for <code class="docutils literal"><span class="pre">www.origin.com</span></code>. By adding a remap rule to the cache, the reverse proxy then maps requests to
+for <code class="docutils literal notranslate"><span class="pre">www.origin.com</span></code>. By adding a remap rule to the cache, the reverse proxy then maps requests to
this origin. The content owner must inform the clients, by updating the URL, to receive the content
from the cache and not from the origin server directly. For this example, the remap rule on the
-cache is: <code class="docutils literal"><span class="pre">http://www-origin-cache.cdn.com</span> <span class="pre">http://www.origin.com</span></code>.</p>
+cache is: <code class="docutils literal notranslate"><span class="pre">http://www-origin-cache.cdn.com</span> <span class="pre">http://www.origin.com</span></code>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">In the previous example minimal headers were shown on both the request and response. In the examples that follow, the origin server response is more realistic.</p>
</div>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
@@ -239,34 +253,34 @@
<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
</pre></div>
</div>
-<p>The client is given the URL <code class="docutils literal"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> (note the different hostname) and when attempting to obtain that URL, the following occurs:</p>
+<p>The client is given the URL <code class="docutils literal notranslate"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> (note the different hostname) and when attempting to obtain that URL, the following occurs:</p>
<ol class="arabic">
-<li><p class="first">The client sends a request to the LDNS server to resolve the name <code class="docutils literal"><span class="pre">www-origin-cache.cdn.com</span></code> to an IPv4 address.</p>
+<li><p class="first">The client sends a request to the LDNS server to resolve the name <code class="docutils literal notranslate"><span class="pre">www-origin-cache.cdn.com</span></code> to an IPv4 address.</p>
</li>
-<li><p class="first">Similar to the previous case, the LDNS server resolves the name <code class="docutils literal"><span class="pre">www-origin-cache.cdn.com</span></code> to an IPv4 address, in this example, this address is 55.44.33.22.</p>
+<li><p class="first">Similar to the previous case, the LDNS server resolves the name <code class="docutils literal notranslate"><span class="pre">www-origin-cache.cdn.com</span></code> to an IPv4 address, in this example, this address is 55.44.33.22.</p>
</li>
<li><p class="first">The client opens a TCP connection from a random port locally, to port 80 (the HTTP default) on 55.44.33.22, and sends the following:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">-</span><span class="n">origin</span><span class="o">-</span><span class="n">cache</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
-<li><p class="first">The reverse proxy looks up <code class="docutils literal"><span class="pre">www-origin-cache.cdn.com</span></code> in its remap rules, and finds the origin is <code class="docutils literal"><span class="pre">www.origin.com</span></code>.</p>
+<li><p class="first">The reverse proxy looks up <code class="docutils literal notranslate"><span class="pre">www-origin-cache.cdn.com</span></code> in its remap rules, and finds the origin is <code class="docutils literal notranslate"><span class="pre">www.origin.com</span></code>.</p>
</li>
-<li><p class="first">The proxy checks its cache to see if the response for <code class="docutils literal"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> is already in the cache.</p>
+<li><p class="first">The proxy checks its cache to see if the response for <code class="docutils literal notranslate"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> is already in the cache.</p>
</li>
</ol>
<p>6a. If the response is not in the cache:</p>
<blockquote>
<div><ol class="arabic">
-<li><p class="first">The proxy uses DNS to get the IPv4 address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>, connect to it on port 80, and sends:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<li><p class="first">The proxy uses DNS to get the IPv4 address for <code class="docutils literal notranslate"><span class="pre">www.origin.com</span></code>, connect to it on port 80, and sends:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
<li><p class="first">The origin server responds with the headers and content as shown:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
@@ -279,8 +293,8 @@
</pre></div>
</div>
</li>
-<li><p class="first">The proxy sends the origin response on to the client adding a <code class="docutils literal"><span class="pre">Via:</span></code> header (and maybe others):</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<li><p class="first">The proxy sends the origin response on to the client adding a <code class="docutils literal notranslate"><span class="pre">Via:</span></code> header (and maybe others):</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
@@ -300,7 +314,7 @@
<p>6b. If it <em>is</em> in the cache:</p>
<blockquote>
<div><p>The proxy responds to the client with the previously retrieved result:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
@@ -323,41 +337,41 @@
unaware of the proxy, the client requests the proxy to retrieve content from a
particular origin server. All MID caches in a Traffic Control based CDN are
forward proxies. In a forward proxy scenario, the client is explicitely configured to use the
-the proxy’s IP address and port as a forward proxy. The client always connects to the forward
+the proxy’s IP address and port as a forward proxy. The client always connects to the forward
proxy for content. The content provider does not have to change the URL the
client obtains, and is unaware of the proxy in the middle.</div></blockquote>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin/forward-proxy.en.html">ATS documentation on forward proxy</a>.</p>
</div>
-<p>Below is an example of the client retrieving the URL <code class="docutils literal"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> through a forward proxy:</p>
+<p>Below is an example of the client retrieving the URL <code class="docutils literal notranslate"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> through a forward proxy:</p>
<ol class="arabic simple">
<li>The client requires configuration to use the proxy, as opposed to the reverse proxy example. Assume the client configuration is through preferences entries or other to use the proxy IP address 99.88.77.66 and proxy port 8080.</li>
-<li>To retrieve <code class="docutils literal"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> URL, the client connects to 99.88.77.66 on port 8080 and sends:</li>
+<li>To retrieve <code class="docutils literal notranslate"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> URL, the client connects to 99.88.77.66 on port 8080 and sends:</li>
</ol>
<blockquote>
-<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">In this case, the client places the entire URL after GET, including protocol and hostname (<code class="docutils literal"><span class="pre">http://www.origin.com</span></code>), but in the reverse proxy and direct-to-origin case it puts only the path portion of the URL (<code class="docutils literal"><span class="pre">/foo/bar/fun.html</span></code>) after the GET.</p>
+<p class="last">In this case, the client places the entire URL after GET, including protocol and hostname (<code class="docutils literal notranslate"><span class="pre">http://www.origin.com</span></code>), but in the reverse proxy and direct-to-origin case it puts only the path portion of the URL (<code class="docutils literal notranslate"><span class="pre">/foo/bar/fun.html</span></code>) after the GET.</p>
</div>
</div></blockquote>
<ol class="arabic simple" start="3">
-<li>The proxy verifies whether the response for <code class="docutils literal"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> is already in the cache.</li>
+<li>The proxy verifies whether the response for <code class="docutils literal notranslate"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> is already in the cache.</li>
</ol>
<p>4a. If it is not in the cache:</p>
<blockquote>
<div><ol class="arabic">
-<li><p class="first">The proxy uses DNS to obtain the IPv4 address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>, connects to it on port 80, and sends:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<li><p class="first">The proxy uses DNS to obtain the IPv4 address for <code class="docutils literal notranslate"><span class="pre">www.origin.com</span></code>, connects to it on port 80, and sends:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
<li><p class="first">The origin server responds with the headers and content as shown below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
@@ -370,8 +384,8 @@
</pre></div>
</div>
</li>
-<li><p class="first">The proxy sends this on to the client adding a <code class="docutils literal"><span class="pre">Via:</span></code> header (and maybe others):</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<li><p class="first">The proxy sends this on to the client adding a <code class="docutils literal notranslate"><span class="pre">Via:</span></code> header (and maybe others):</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
@@ -391,7 +405,7 @@
<p>4b. If it <em>is</em> in the cache:</p>
<blockquote>
<div><p>The proxy responds to the client with the previously retrieved result:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
@@ -447,16 +461,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/basics/content_delivery_networks.html b/docs/latest/basics/content_delivery_networks.html
index aecb5e7..de330da 100644
--- a/docs/latest/basics/content_delivery_networks.html
+++ b/docs/latest/basics/content_delivery_networks.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Content Delivery Networks — Traffic Control 2.1-dev documentation </title>
+ <title>Content Delivery Networks — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="CDN Basics" href="index.html"/>
<link rel="next" title="HTTP 1.1" href="http_11.html"/>
<link rel="prev" title="CDN Basics" href="index.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">CDN Basics</a> »</li>
<li>Content Delivery Networks</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/basics/content_delivery_networks.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/basics/content_delivery_networks.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -191,36 +205,31 @@
<div class="section" id="content-delivery-networks">
<span id="index-0"></span><h1>Content Delivery Networks<a class="headerlink" href="#content-delivery-networks" title="Permalink to this headline">¶</a></h1>
-<p>The vast majority of today’s Internet traffic is media files (often video or audio) being sent from a single source (the <em>Content Provider</em>) to many thousands or even millions of destinations (the <em>Content Consumers</em>). Content Delivery Networks are the technology that make that one-to-many distribution possible in an economical way. A Content Delivery Network (CDN) is a distributed system of servers for delivering content over HTTP. These servers are deployed in multiple locations with the goal of optimizing the delivery of content to the end users, while minimizing the traffic on the network. A CDN typically consists of the following:</p>
-<ul>
+<p>The vast majority of today’s Internet traffic is media files (often video or audio) being sent from a single source (the <em>Content Provider</em>) to many thousands or even millions of destinations (the <em>Content Consumers</em>). Content Delivery Networks are the technology that make that one-to-many distribution possible in an economical way. A Content Delivery Network (CDN) is a distributed system of servers for delivering content over HTTP. These servers are deployed in multiple locations with the goal of optimizing the delivery of content to the end users, while minimizing the traffic on the network. A CDN typically consists of the following:</p>
+<ul class="simple">
<li><dl class="first docutils">
<dt><strong>Caching Proxies</strong></dt>
-<dd><p class="first last">The proxy (cache or caching proxy) is a server that both proxies the requests and caches the results for reusing.</p>
-</dd>
+<dd>The proxy (cache or caching proxy) is a server that both proxies the requests and caches the results for reusing.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Content Router</strong></dt>
-<dd><p class="first last">The Content Router ensures that the end user is connected to the optimal cache for the location of the end user and content availability.</p>
-</dd>
+<dd>The Content Router ensures that the end user is connected to the optimal cache for the location of the end user and content availability.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Health Protocol</strong></dt>
-<dd><p class="first last">The Health Protocol monitors the usage of the caches and tenants in the CDN.</p>
-</dd>
+<dd>The Health Protocol monitors the usage of the caches and tenants in the CDN.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Configuration Management System</strong></dt>
-<dd><p class="first last">In many cases a CDN encompasses hundreds of servers across a large geographic area. The Configuration Management System allows an operator to manage these servers.</p>
-</dd>
+<dd>In many cases a CDN encompasses hundreds of servers across a large geographic area. The Configuration Management System allows an operator to manage these servers.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Log File Analysis System</strong></dt>
-<dd><p class="first last">Every transaction in the CDN gets logged. The Log File Analysis System aggregates all of the log entries from all of the servers to a central location for analysis and troubleshooting.</p>
-</dd>
+<dd>Every transaction in the CDN gets logged. The Log File Analysis System aggregates all of the log entries from all of the servers to a central location for analysis and troubleshooting.</dd>
</dl>
</li>
</ul>
@@ -259,16 +268,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/basics/http_11.html b/docs/latest/basics/http_11.html
index 00e1b6d..6d249b4 100644
--- a/docs/latest/basics/http_11.html
+++ b/docs/latest/basics/http_11.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>HTTP 1.1 — Traffic Control 2.1-dev documentation </title>
+ <title>HTTP 1.1 — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="CDN Basics" href="index.html"/>
<link rel="next" title="Caching Proxies" href="caching_proxies.html"/>
<link rel="prev" title="Content Delivery Networks" href="content_delivery_networks.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">CDN Basics</a> »</li>
<li>HTTP 1.1</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/basics/http_11.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/basics/http_11.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -192,11 +206,11 @@
<div class="section" id="http-1-1">
<span id="index-0"></span><h1>HTTP 1.1<a class="headerlink" href="#http-1-1" title="Permalink to this headline">¶</a></h1>
<p>For a comprehensive look at Traffic Control, it is important to understand basic HTTP 1.1 protocol operations and how caches function. The example below illustrates the fulfillment of an HTTP 1.1 request in a situation without CDN or proxy, followed by viewing the changes after inserting different types of (caching) proxies. Several of the examples below are simplified for clarification of the essentials.</p>
-<p>For complete details on HTTP 1.1 see <a class="reference external" href="https://www.ietf.org/rfc/rfc2616.txt">RFC 2616 - Hypertext Transfer Protocol – HTTP/1.1</a>.</p>
-<p>Below are the steps of a client retrieving the URL <code class="docutils literal"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> using HTTP/1.1 without proxies:</p>
+<p>For complete details on HTTP 1.1 see <a class="reference external" href="https://www.ietf.org/rfc/rfc2616.txt">RFC 2616 - Hypertext Transfer Protocol – HTTP/1.1</a>.</p>
+<p>Below are the steps of a client retrieving the URL <code class="docutils literal notranslate"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> using HTTP/1.1 without proxies:</p>
<ol class="arabic simple">
-<li>The client sends a request to the Local DNS (LDNS) server to resolve the name <code class="docutils literal"><span class="pre">www.origin.com</span></code> to an IPv4 address.</li>
-<li>If the LDNS does not have this name (IPv4 mapping cached), it sends DNS requests to the ., .com, and .origin.com authoritative servers until it receives a response with the address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>. Per the DNS SPEC, this response has a Time To Live (TTL), which indicates how long this mapping can be cached at the LDNS server. In the example, the IP address found by the LDNS server for www.origin.com is 44.33.22.11.</li>
+<li>The client sends a request to the Local DNS (LDNS) server to resolve the name <code class="docutils literal notranslate"><span class="pre">www.origin.com</span></code> to an IPv4 address.</li>
+<li>If the LDNS does not have this name (IPv4 mapping cached), it sends DNS requests to the ., .com, and .origin.com authoritative servers until it receives a response with the address for <code class="docutils literal notranslate"><span class="pre">www.origin.com</span></code>. Per the DNS SPEC, this response has a Time To Live (TTL), which indicates how long this mapping can be cached at the LDNS server. In the example, the IP address found by the LDNS server for www.origin.com is 44.33.22.11.</li>
</ol>
<blockquote>
<div><div class="admonition note">
@@ -206,13 +220,13 @@
</div></blockquote>
<ol class="arabic" start="3">
<li><p class="first">The client opens a TCP connection from a random port locally to port 80 (the HTTP default) on 44.33.22.11, and sends this (showing the minimum HTTP 1.1 request, typically there are additional headers):</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
</li>
-<li><p class="first">The server at <code class="docutils literal"><span class="pre">www.origin.com</span></code> looks up the Host: header to match that to a configuration section, usually referred to as a virtual host section. If the Host: header and configuration section match, the search continues for the content of the path <code class="docutils literal"><span class="pre">/foo/bar/fun.html</span></code>, in the example, this is a file that contains <code class="docutils literal"><span class="pre"><html><body>This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">fun</span> <span class="pre">file</body></html></span></code>, so the server responds with the following:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
+<li><p class="first">The server at <code class="docutils literal notranslate"><span class="pre">www.origin.com</span></code> looks up the Host: header to match that to a configuration section, usually referred to as a virtual host section. If the Host: header and configuration section match, the search continues for the content of the path <code class="docutils literal notranslate"><span class="pre">/foo/bar/fun.html</span></code>, in the example, this is a file that contains <code class="docutils literal notranslate"><span class="pre"><html><body>This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">fun</span> <span class="pre">file</body></html></span></code>, so the server responds with the following:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
@@ -258,16 +272,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/basics/index.html b/docs/latest/basics/index.html
index 68b2980..ad68537 100644
--- a/docs/latest/basics/index.html
+++ b/docs/latest/basics/index.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>CDN Basics — Traffic Control 2.1-dev documentation </title>
+ <title>CDN Basics — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="next" title="Content Delivery Networks" href="content_delivery_networks.html"/>
<link rel="prev" title="Traffic Control" href="../index.html"/>
@@ -94,21 +99,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -119,15 +125,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -163,12 +177,12 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li>CDN Basics</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/basics/index.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/basics/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -237,16 +251,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/development/building.html b/docs/latest/development/building.html
index 48fe26e..2047827 100644
--- a/docs/latest/development/building.html
+++ b/docs/latest/development/building.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Building Traffic Control — Traffic Control 2.1-dev documentation </title>
+ <title>Building Traffic Control — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Developer’s Guide" href="index.html"/>
<link rel="next" title="Traffic Ops" href="traffic_ops.html"/>
<link rel="prev" title="Developer’s Guide" href="index.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Developer’s Guide</a> »</li>
+ <li><a href="index.html">Developer’s Guide</a> »</li>
<li>Building Traffic Control</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/development/building.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/development/building.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -199,17 +213,17 @@
<div class="section" id="requirements">
<h3>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
-<li><code class="docutils literal"><span class="pre">docker</span></code> (<a class="reference external" href="https://docs.docker.com/engine/installation/">https://docs.docker.com/engine/installation/</a>)</li>
-<li><code class="docutils literal"><span class="pre">docker-compose</span></code> (<a class="reference external" href="https://docs.docker.com/compose/install/">https://docs.docker.com/compose/install/</a>)
+<li><code class="docutils literal notranslate"><span class="pre">docker</span></code> (<a class="reference external" href="https://docs.docker.com/engine/installation/">https://docs.docker.com/engine/installation/</a>)</li>
+<li><code class="docutils literal notranslate"><span class="pre">docker-compose</span></code> (<a class="reference external" href="https://docs.docker.com/compose/install/">https://docs.docker.com/compose/install/</a>)
(optional, but recommended)</li>
</ul>
-<p>If <code class="docutils literal"><span class="pre">docker-compose</span></code> is not available, the <code class="docutils literal"><span class="pre">pkg</span></code> script will
+<p>If <code class="docutils literal notranslate"><span class="pre">docker-compose</span></code> is not available, the <code class="docutils literal notranslate"><span class="pre">pkg</span></code> script will
automatically download and run it in a container. This is noticeably
slower than running it natively.</p>
</div>
<div class="section" id="usage">
<h3>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h3>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ ./pkg -?
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./pkg -?
Usage: ./pkg [options] [projects]
-q Quiet mode. Supresses output.
-v Verbose mode. Lists all build output.
@@ -227,12 +241,12 @@
</div>
<p>If any project names are provided on the command line, only those will be built.
Otherwise, all projects are built.</p>
-<p>All artifacts (rpms, logs, source tar ball) are copied to <code class="docutils literal"><span class="pre">dist</span></code> at the top level of the
-<code class="docutils literal"><span class="pre">incubator-trafficcontrol</span></code> directory.</p>
+<p>All artifacts (rpms, logs, source tar ball) are copied to <code class="docutils literal notranslate"><span class="pre">dist</span></code> at the top level of the
+<code class="docutils literal notranslate"><span class="pre">incubator-trafficcontrol</span></code> directory.</p>
</div>
<div class="section" id="example">
<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ ./pkg -v source traffic_ops_build
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./pkg -v source traffic_ops_build
Building source.
Building traffic_ops_build.
</pre></div>
@@ -241,10 +255,10 @@
</div>
<div class="section" id="build-using-docker-compose">
<h2>Build using docker-compose<a class="headerlink" href="#build-using-docker-compose" title="Permalink to this headline">¶</a></h2>
-<p>If the <code class="docutils literal"><span class="pre">pkg</span></code> script fails, <code class="docutils literal"><span class="pre">docker-compose</span></code> can still be used directly.</p>
+<p>If the <code class="docutils literal notranslate"><span class="pre">pkg</span></code> script fails, <code class="docutils literal notranslate"><span class="pre">docker-compose</span></code> can still be used directly.</p>
<div class="section" id="id1">
<h3>Usage<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ docker-compose -f ./infrastructure/docker/build/docker-compose.yml down -v
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ docker-compose -f ./infrastructure/docker/build/docker-compose.yml down -v
$ docker-compose -f ./infrastructure/docker/build/docker-compose.yml up --build source traffic_ops_build
$ ls -1 dist/
build-traffic_ops.log
@@ -292,16 +306,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/development/index.html b/docs/latest/development/index.html
index be63439..02c425e 100644
--- a/docs/latest/development/index.html
+++ b/docs/latest/development/index.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Developer’s Guide — Traffic Control 2.1-dev documentation </title>
+ <title>Developer’s Guide — Traffic Control 2.2-dev documentation </title>
@@ -33,9 +35,12 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="next" title="Building Traffic Control" href="building.html"/>
- <link rel="prev" title="Configure Delivery Service Steering" href="../admin/quick_howto/steering.html"/>
+ <link rel="prev" title="Delivery Service Requests" href="../admin/quick_howto/ds_requests.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -94,21 +99,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -119,15 +125,23 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Developer’s Guide</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -163,12 +177,12 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li>Developer’s Guide</li>
+ <li>Developer’s Guide</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/development/index.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/development/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -180,14 +194,14 @@
<a href="building.html" class="btn btn-neutral float-right" title="Building Traffic Control">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../admin/quick_howto/steering.html" class="btn btn-neutral" title="Configure Delivery Service Steering"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="../admin/quick_howto/ds_requests.html" class="btn btn-neutral" title="Delivery Service Requests"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<div role="main" class="document">
<div class="section" id="developer-s-guide">
-<h1>Developer’s Guide<a class="headerlink" href="#developer-s-guide" title="Permalink to this headline">¶</a></h1>
+<h1>Developer’s Guide<a class="headerlink" href="#developer-s-guide" title="Permalink to this headline">¶</a></h1>
<p>Use this guide to start developing applications that consume the Traffic Control APIs, to create extensions to Traffic Ops, or work on Traffic Control itself.</p>
<div class="toctree-wrapper compound">
<ul>
@@ -205,7 +219,6 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#installing-the-developer-environment">Installing The Developer Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#test-cases">Test Cases</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#extensions">Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a><ul>
@@ -222,32 +235,23 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#traffic-router-project-tree-overview">Traffic Router Project Tree Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#java-formatting-conventions">Java Formatting Conventions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#installing-the-developer-environment">Installing The Developer Environment</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#manual-testing">Manual Testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#test-cases">Test Cases</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#rpm-packaging">RPM Packaging</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#api">API</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Golang</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#software-requirements">Software Requirements</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#traffic-monitor-project-tree-overview">Traffic Monitor Project Tree Overview</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#java-formatting-conventions">Java Formatting Conventions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#project-tree-overview">Project Tree Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#architecture">Architecture</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#formatting-conventions">Formatting Conventions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#installing-the-developer-environment">Installing The Developer Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#test-cases">Test Cases</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html#api">API</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Golang</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#introduction">Introduction</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#software-requirements">Software Requirements</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#project-tree-overview">Project Tree Overview</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#architecture">Architecture</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#formatting-conventions">Formatting Conventions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#installing-the-developer-environment">Installing The Developer Environment</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#test-cases">Test Cases</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html#api">API</a></li>
-</ul>
-</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#software-requirements">Software Requirements</a></li>
@@ -257,7 +261,6 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#test-cases">Test Cases</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
</ul>
</div>
</div>
@@ -271,7 +274,7 @@
<a href="building.html" class="btn btn-neutral float-right" title="Building Traffic Control">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../admin/quick_howto/steering.html" class="btn btn-neutral" title="Configure Delivery Service Steering"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="../admin/quick_howto/ds_requests.html" class="btn btn-neutral" title="Delivery Service Requests"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -295,16 +298,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/development/traffic_monitor.html b/docs/latest/development/traffic_monitor.html
index 7bc082a..6287acd 100644
--- a/docs/latest/development/traffic_monitor.html
+++ b/docs/latest/development/traffic_monitor.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Monitor — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Monitor Golang — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Developer’s Guide" href="index.html"/>
<link rel="next" title="Traffic Monitor APIs" href="traffic_monitor/traffic_monitor_api.html"/>
<link rel="prev" title="Traffic Router API" href="traffic_router/traffic_router_api.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Developer’s Guide</a> »</li>
+ <li><a href="index.html">Developer’s Guide</a> »</li>
- <li>Traffic Monitor</li>
+ <li>Traffic Monitor Golang</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/development/traffic_monitor.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/development/traffic_monitor.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -189,140 +203,254 @@
<div role="main" class="document">
- <div class="section" id="traffic-monitor">
-<h1>Traffic Monitor<a class="headerlink" href="#traffic-monitor" title="Permalink to this headline">¶</a></h1>
+ <div class="section" id="traffic-monitor-golang">
+<h1>Traffic Monitor Golang<a class="headerlink" href="#traffic-monitor-golang" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
-<p>Traffic Monitor is a Java Tomcat application that monitors caches, provides health state information to Traffic Router, and collects statistics for use in tools such as Traffic Ops and Traffic Stats. The health state provided by Traffic Monitor is used by Traffic Router to control which caches are available on the CDN.</p>
+<p>Traffic Monitor is an HTTP service application that monitors caches, provides health state information to Traffic Router, and collects statistics for use in tools such as Traffic Ops and Traffic Stats. The health state provided by Traffic Monitor is used by Traffic Router to control which caches are available on the CDN.</p>
</div>
<div class="section" id="software-requirements">
<h2>Software Requirements<a class="headerlink" href="#software-requirements" title="Permalink to this headline">¶</a></h2>
<p>To work on Traffic Monitor you need a *nix (MacOS and Linux are most commonly used) environment that has the following installed:</p>
<ul class="simple">
-<li>Eclipse >= Kepler SR2 (or another Java IDE)</li>
-<li>Maven >= 3.3.1</li>
-<li>JDK >= 6.0</li>
+<li>Golang</li>
</ul>
</div>
-<div class="section" id="traffic-monitor-project-tree-overview">
-<h2>Traffic Monitor Project Tree Overview<a class="headerlink" href="#traffic-monitor-project-tree-overview" title="Permalink to this headline">¶</a></h2>
-<ul>
-<li><p class="first"><code class="docutils literal"><span class="pre">traffic_control/traffic_monitor/</span></code> - base directory for Traffic Monitor</p>
-<blockquote>
-<div><ul>
-<li><p class="first"><code class="docutils literal"><span class="pre">etc/</span></code> - Miscellaneous simulator utilities</p>
-</li>
-<li><p class="first"><code class="docutils literal"><span class="pre">src/main</span></code> - Main source directory for the Traffic Monitor</p>
-<blockquote>
-<div><ul class="simple">
-<li><code class="docutils literal"><span class="pre">bin/</span></code> - Configuration tools</li>
-<li><code class="docutils literal"><span class="pre">conf/</span></code> - Configuration files</li>
-<li><code class="docutils literal"><span class="pre">java/</span></code> - Java source code for Traffic Monitor</li>
-<li><code class="docutils literal"><span class="pre">opt/tomcat/conf</span></code> - Contains Tomcat configuration file(s) pulled in during an RPM build</li>
-<li><code class="docutils literal"><span class="pre">resources/</span></code> - Resources pulled in during an RPM build</li>
-<li><code class="docutils literal"><span class="pre">scripts/</span></code> - Scripts used by the RPM build process</li>
-<li><code class="docutils literal"><span class="pre">webapp/</span></code> - Java webapp resources</li>
+<div class="section" id="project-tree-overview">
+<h2>Project Tree Overview<a class="headerlink" href="#project-tree-overview" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><code class="docutils literal notranslate"><span class="pre">traffic_control/traffic_monitor/</span></code> - base directory for Traffic Monitor.</li>
+<li><code class="docutils literal notranslate"><span class="pre">cache/</span></code> - Handler for processing cache results.</li>
+<li><code class="docutils literal notranslate"><span class="pre">config/</span></code> - Application configuration; in-memory objects from <code class="docutils literal notranslate"><span class="pre">traffic_monitor.cfg</span></code>.</li>
+<li><code class="docutils literal notranslate"><span class="pre">crconfig/</span></code> - struct for deserlializing the CRConfig from JSON.</li>
+<li><code class="docutils literal notranslate"><span class="pre">deliveryservice/</span></code> - aggregates delivery service data from cache results.</li>
+<li><code class="docutils literal notranslate"><span class="pre">deliveryservicedata/</span></code> - deliveryservice structs. This exists separate from <code class="docutils literal notranslate"><span class="pre">deliveryservice</span></code> to avoid circular dependencies.</li>
+<li><code class="docutils literal notranslate"><span class="pre">enum/</span></code> - enumerations and name alias types.</li>
+<li><code class="docutils literal notranslate"><span class="pre">health/</span></code> - functions for calculating cache health, and creating health event objects.</li>
+<li><dl class="first docutils">
+<dt><code class="docutils literal notranslate"><span class="pre">manager/</span></code> - manager goroutines (microthreads).</dt>
+<dd><ul class="first last">
+<li><code class="docutils literal notranslate"><span class="pre">health.go</span></code> - Health request manager. Processes health results, from the health poller -> fetcher -> manager. The health poll is the “heartbeat” containing a small amount of stats, primarily to determine whether a cache is reachable as quickly as possible. Data is aggregated and inserted into shared threadsafe objects.</li>
+<li><code class="docutils literal notranslate"><span class="pre">manager.go</span></code> - Contains <code class="docutils literal notranslate"><span class="pre">Start</span></code> function to start all pollers, handlers, and managers.</li>
+<li><code class="docutils literal notranslate"><span class="pre">monitorconfig.go</span></code> - Monitor config manager. Gets data from the monitor config poller, which polls Traffic Ops for changes to which caches are monitored and how.</li>
+<li><code class="docutils literal notranslate"><span class="pre">opsconfig.go</span></code> - Ops config manager. Gets data from the ops config poller, which polls Traffic Ops for changes to monitoring settings.</li>
+<li><code class="docutils literal notranslate"><span class="pre">peer.go</span></code> - Peer manager. Gets data from the peer poller -> fetcher -> handler and aggregates it into the shared threadsafe objects.</li>
+<li><code class="docutils literal notranslate"><span class="pre">stat.go</span></code> - Stat request manager. Processes stat results, from the stat poller -> fetcher -> manager. The stat poll is the large statistics poll, containing all stats (such as HTTP codes, transactions, delivery service statistics, and more). Data is aggregated and inserted into shared threadsafe objects.</li>
+<li><code class="docutils literal notranslate"><span class="pre">statecombiner.go</span></code> - Manager for combining local and peer states, into a single combined states threadsafe object, for serving the CrStates endpoint.</li>
</ul>
-</div></blockquote>
+</dd>
+</dl>
</li>
-<li><p class="first"><code class="docutils literal"><span class="pre">src/test</span></code> - Test source directory for Traffic Monitor</p>
-<blockquote>
-<div><ul class="simple">
-<li><code class="docutils literal"><span class="pre">java/</span></code> - JUnit based unit tests for Traffic Monitor</li>
-<li><code class="docutils literal"><span class="pre">resources/conf</span></code> - Configuration files used by unit tests</li>
-<li><code class="docutils literal"><span class="pre">resources/db</span></code> - Files downloaded by unit tests</li>
-<li><code class="docutils literal"><span class="pre">resources/var</span></code> - Files generated by unit tests</li>
-</ul>
-</div></blockquote>
-</li>
-</ul>
-</div></blockquote>
-</li>
+<li><code class="docutils literal notranslate"><span class="pre">datareq/</span></code> - HTTP routing, which has threadsafe health and stat objects populated by stat and health managers.</li>
+<li><code class="docutils literal notranslate"><span class="pre">peer/</span></code> - Manager for getting and populating peer data from other Traffic Monitors</li>
+<li><code class="docutils literal notranslate"><span class="pre">srvhttp/</span></code> - HTTP service. Given a map of endpoint functions, which are lambda closures containing aggregated data objects.</li>
+<li><code class="docutils literal notranslate"><span class="pre">static/</span></code> - Web GUI HTML and javascript files</li>
+<li><code class="docutils literal notranslate"><span class="pre">threadsafe/</span></code> - Threadsafe objects for storing aggregated data needed by multiple goroutines (typically the aggregator and HTTP server)</li>
+<li><code class="docutils literal notranslate"><span class="pre">trafficopsdata/</span></code> - Struct for fetching and storing Traffic Ops data needed from the CRConfig. This is primarily mappings, such as delivery service servers, and server types.</li>
+<li><code class="docutils literal notranslate"><span class="pre">trafficopswrapper/</span></code> - Threadsafe wrapper around the Traffic Ops client. The client used to not be threadsafe, however, it mostly (possibly entirely) is now. But, the wrapper also serves to overwrite the Traffic Ops <code class="docutils literal notranslate"><span class="pre">monitoring.json</span></code> values, which are live, with snapshotted CRConfig values.</li>
</ul>
</div>
-<div class="section" id="java-formatting-conventions">
-<h2>Java Formatting Conventions<a class="headerlink" href="#java-formatting-conventions" title="Permalink to this headline">¶</a></h2>
-<p>None at this time. The codebase will eventually be formatted per Java standards.</p>
+<div class="section" id="architecture">
+<h2>Architecture<a class="headerlink" href="#architecture" title="Permalink to this headline">¶</a></h2>
+<p>At the highest level, Traffic Monitor polls caches, aggregates their data and availability, and serves it at HTTP JSON endpoints.</p>
+<p>In the code, the data flows thru microthread (goroutine) pipelines. All stages of the pipeline are independent running microthreads <a class="footnote-reference" href="#f1" id="id1">[1]</a> . The pipelines are:</p>
+<ul class="simple">
+<li><strong>stat poll</strong> - polls caches for all statistics data. This should be a slower poll, which gets a lot of data.</li>
+<li><strong>health poll</strong> - polls caches for a tiny amount of data, typically system information. This poll is designed to be a heartbeat, determining quickly whether the cache is reachable. Since it’s a small amount of data, it should poll more frequently.</li>
+<li><strong>peer poll</strong> - polls Traffic Monitor peers for their availability data, and aggregates it with its own availability results and that of all other peers.</li>
+<li><strong>monitor config</strong> - polls Traffic Ops for the list of Traffic Monitors and their info.</li>
+<li><strong>ops config</strong> - polls for changes to the ops config file <code class="docutils literal notranslate"><span class="pre">traffic_ops.cfg</span></code>, and sends updates to other pollers when the config file has changed.<ul>
+<li>The ops config manager also updates the shared Traffic Ops client, since it’s the actor which becomes notified of config changes requiring a new client.</li>
+<li>The ops config manager also manages, creates, and recreates the HTTP server, since ops config changes necessitate restarting the HTTP server.</li>
+</ul>
+</li>
+</ul>
+<p>All microthreads in the pipeline are started by <code class="docutils literal notranslate"><span class="pre">manager/manager.go:Start()</span></code>.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">--------------------</span> <span class="o">--------------------</span> <span class="o">--------------------</span>
+<span class="o">|</span> <span class="n">ops</span> <span class="n">config</span> <span class="n">poller</span> <span class="o">|-->|</span> <span class="n">ops</span> <span class="n">config</span> <span class="n">handler</span> <span class="o">|-->|</span> <span class="n">ops</span> <span class="n">config</span> <span class="n">manager</span> <span class="o">|-->-</span><span class="n">restart</span> <span class="n">HTTP</span> <span class="n">server</span><span class="o">-------------------------</span>
+ <span class="o">-------------------</span> <span class="o">--------------------</span> <span class="o">--------------------</span> <span class="o">|</span> <span class="o">|</span>
+ <span class="o">-->-</span><span class="n">ops</span> <span class="n">config</span> <span class="n">change</span> <span class="n">subscriber</span><span class="o">-------------</span> <span class="o">|</span>
+ <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
+ <span class="o">-->-</span><span class="n">Traffic</span> <span class="n">Ops</span> <span class="n">client</span> <span class="n">change</span> <span class="n">subscriber</span><span class="o">--</span> <span class="o">|</span> <span class="o">|</span>
+ <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
+ <span class="o">-------------------------------------------------------------------------------------------------------------</span> <span class="o">|</span> <span class="o">|</span>
+ <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
+ <span class="o">|</span> <span class="o">------------------------------------------------------------------------------------------------------------</span> <span class="o">|</span>
+ <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
+ \<span class="o">/</span> \<span class="o">/</span> <span class="o">|</span>
+ <span class="o">-----------------------</span> <span class="o">------------------------</span> <span class="o">|</span>
+ <span class="o">|</span> <span class="n">monitor</span> <span class="n">config</span> <span class="n">poller</span> <span class="o">|-->|</span> <span class="n">monitor</span> <span class="n">config</span> <span class="n">manager</span> <span class="o">|-->-</span><span class="n">stat</span> <span class="n">subscriber</span><span class="o">--------</span> <span class="o">-----------------------</span>
+ <span class="o">-----------------------</span> <span class="o">------------------------</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
+ <span class="o">|->-</span><span class="n">health</span> <span class="n">subscriber</span><span class="o">---</span> <span class="o">|</span> \<span class="o">/</span> <span class="n">_</span>
+ <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">-------------</span> <span class="n">_</span><span class="p">(</span> <span class="p">)</span><span class="o">.</span><span class="n">_</span>
+ <span class="o">-->-</span><span class="n">peer</span> <span class="n">subscriber</span><span class="o">--</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="n">HTTP</span> <span class="n">server</span> <span class="o">|->-</span><span class="n">HTTP</span> <span class="n">request</span><span class="o">-></span> <span class="p">(</span><span class="n">____</span><span class="p">)</span><span class="n">_</span><span class="p">)</span>
+ <span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">-------------</span>
+<span class="o">-----------------------------------------------------------------------------</span> <span class="o">|</span> <span class="o">|</span> <span class="o">^</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">-----------------------------------------------------------------------------</span> <span class="o">|</span> <span class="o">------------------------</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">-----------------------------------------------------------------------------</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">^</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">-------------</span> <span class="o">--------------</span> <span class="o">--------------</span> <span class="o">--------------</span> <span class="o">-----------------------</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">-->|</span> <span class="n">stat</span> <span class="n">poller</span> <span class="o">|-->|</span> <span class="n">stat</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">stat</span> <span class="n">handler</span> <span class="o">|-->|</span> <span class="n">stat</span> <span class="n">manager</span> <span class="o">|->--------</span><span class="nb">set</span> <span class="n">shared</span> <span class="n">data</span><span class="o">->|</span> <span class="n">shared</span> <span class="n">data</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">-------------</span> <span class="o">|</span> <span class="o">--------------</span> <span class="o">--------------</span> <span class="o">|</span> <span class="o">--------------</span> <span class="o">-----------------------</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">--------------</span> <span class="o">--------------</span> <span class="o">|</span> <span class="o">|</span> <span class="n">events</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">|->|</span> <span class="n">stat</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">stat</span> <span class="n">handler</span> <span class="o">|-|</span> <span class="o">|</span> <span class="n">toData</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="o">--------------</span> <span class="o">--------------</span> <span class="o">|</span> <span class="o">|</span> <span class="n">errorCount</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">...</span> <span class="o">...</span> <span class="o">|</span> <span class="n">healthIteration</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">|</span> <span class="n">fetchCount</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">---------------</span> <span class="o">----------------</span> <span class="o">----------------</span> <span class="o">----------------</span> <span class="o">|</span> <span class="n">localStates</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">---->|</span> <span class="n">health</span> <span class="n">poller</span> <span class="o">|-->|</span> <span class="n">health</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">health</span> <span class="n">handler</span> <span class="o">|-->|</span> <span class="n">health</span> <span class="n">manager</span> <span class="o">|->-</span><span class="nb">set</span> <span class="n">shared</span> <span class="n">data</span><span class="o">->|</span> <span class="n">toSession</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">---------------</span> <span class="o">|</span> <span class="o">----------------</span> <span class="o">----------------</span> <span class="o">|</span> <span class="o">----------------</span> <span class="o">|</span> <span class="n">peerStates</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">----------------</span> <span class="o">----------------</span> <span class="o">|</span> <span class="o">|</span> <span class="n">monitorConfig</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|->|</span> <span class="n">health</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">health</span> <span class="n">handler</span> <span class="o">|-|</span> <span class="o">|</span> <span class="n">combinedStates</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="o">----------------</span> <span class="o">----------------</span> <span class="o">|</span> <span class="o">|</span> <span class="n">statInfoHistory</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">...</span> <span class="o">...</span> <span class="o">|</span> <span class="n">statResultHistory</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">|</span> <span class="n">statMaxKbpses</span> <span class="o">|</span>
+<span class="o">|</span> <span class="o">-------------</span> <span class="o">--------------</span> <span class="o">--------------</span> <span class="o">--------------</span> <span class="o">|</span> <span class="n">lastKbpsStats</span> <span class="o">|</span>
+<span class="o">------>|</span> <span class="n">peer</span> <span class="n">poller</span> <span class="o">|-->|</span> <span class="n">peer</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">peer</span> <span class="n">handler</span> <span class="o">|-->|</span> <span class="n">peer</span> <span class="n">manager</span> <span class="o">|->----------</span><span class="nb">set</span> <span class="n">shared</span> <span class="n">data</span><span class="o">->|</span> <span class="n">dsStats</span> <span class="o">|</span>
+ <span class="o">-------------</span> <span class="o">|</span> <span class="o">--------------</span> <span class="o">--------------</span> <span class="o">|</span> <span class="o">--------------</span> <span class="o">|</span> <span class="n">localCacheStatus</span> <span class="o">|</span>
+ <span class="o">|</span> <span class="o">--------------</span> <span class="o">--------------</span> <span class="o">|</span> <span class="o">|</span> <span class="n">lastHealthDurations</span> <span class="o">|</span>
+ <span class="o">|->|</span> <span class="n">peer</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">peer</span> <span class="n">handler</span> <span class="o">|-|</span> <span class="o">|</span> <span class="n">healthHistory</span> <span class="o">|</span>
+ <span class="o">|</span> <span class="o">--------------</span> <span class="o">--------------</span> <span class="o">|</span> <span class="o">-----------------------</span>
+ <span class="o">...</span> <span class="o">...</span>
+</pre></div>
+</div>
+<table class="docutils footnote" frame="void" id="f1" rules="none">
+<colgroup><col class="label" /><col /></colgroup>
+<tbody valign="top">
+<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>Technically, some stages which are one-to-one simply call the next stage as a function. For example, the Fetcher calls the Handler as a function in the same microthread. But this isn’t architecturally significant.</td></tr>
+</tbody>
+</table>
+<div class="section" id="stat-pipeline">
+<h3>Stat Pipeline<a class="headerlink" href="#stat-pipeline" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">---------</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">---------</span>
+<span class="o">|</span> <span class="n">poller</span> <span class="o">|-->|</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">handler</span> <span class="o">|-->|</span> <span class="n">manager</span> <span class="o">|</span>
+ <span class="o">--------</span> <span class="o">|</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">|</span> <span class="o">---------</span>
+ <span class="o">|</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">|</span>
+ <span class="o">|->|</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">handler</span> <span class="o">|-|</span>
+ <span class="o">|</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">|</span>
+ <span class="o">...</span> <span class="o">...</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li><strong>poller</strong> - <code class="docutils literal notranslate"><span class="pre">common/poller/poller.go:HttpPoller.Poll()</span></code>. Listens for config changes (from the ops config manager), and starts its own internal microthreads, one for each cache to poll. These internal microthreads call the Fetcher at each cache’s poll interval.</li>
+<li><strong>fetcher</strong> - <code class="docutils literal notranslate"><span class="pre">common/fetcher/fetcher.go:HttpFetcher.Fetch()</span></code>. Fetches the given URL, and passes the returned data to the Handler, along with any errors.</li>
+<li><strong>handler</strong> - <code class="docutils literal notranslate"><span class="pre">traffic_monitor/cache/cache.go:Handler.Handle()</span></code>. Takes the given result and does all data computation possible with the single result. Currently, this computation primarily involves processing the denormalized ATS data into Go structs, and processing System data into OutBytes, Kbps, etc. Precomputed data is then passed to its result channel, which is picked up by the Manager.</li>
+<li><strong>manager</strong> - <code class="docutils literal notranslate"><span class="pre">traffic_monitor/manager/stat.go:StartStatHistoryManager()</span></code>. Takes preprocessed results, and aggregates them. Aggregated results are then placed in shared data structures. The major data aggregated are delivery service statistics, and cache availability data. See <a class="reference internal" href="#agg-stat-data"><span class="std std-ref">Aggregated Stat Data</span></a> and <a class="reference internal" href="#agg-avail-data"><span class="std std-ref">Aggregated Availability Data</span></a>.</li>
+</ul>
+</div>
+<div class="section" id="health-pipeline">
+<h3>Health Pipeline<a class="headerlink" href="#health-pipeline" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">---------</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">---------</span>
+<span class="o">|</span> <span class="n">poller</span> <span class="o">|-->|</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">handler</span> <span class="o">|-->|</span> <span class="n">manager</span> <span class="o">|</span>
+ <span class="o">--------</span> <span class="o">|</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">|</span> <span class="o">---------</span>
+ <span class="o">|</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">|</span>
+ <span class="o">|->|</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">handler</span> <span class="o">|-|</span>
+ <span class="o">|</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">|</span>
+ <span class="o">...</span> <span class="o">...</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li><strong>poller</strong> - <code class="docutils literal notranslate"><span class="pre">common/poller/poller.go:HttpPoller.Poll()</span></code>. Same poller type as the Stat Poller pipeline, with a different handler object.</li>
+<li><strong>fetcher</strong> - <code class="docutils literal notranslate"><span class="pre">common/fetcher/fetcher.go:HttpFetcher.Fetch()</span></code>. Same fetcher type as the Stat Poller pipeline, with a different handler object.</li>
+<li><strong>handler</strong> - <code class="docutils literal notranslate"><span class="pre">traffic_monitor/cache/cache.go:Handler.Handle()</span></code>. Same handler type as the Stat Poller pipeline, but constructed with a flag to not precompute. The health endpoint is of the same form as the stat endpoint, but doesn’t return all stat data. So, it doesn’t precompute like the Stat Handler, but only processes the system data, and passes the processed result to its result channel, which is picked up by the Manager.</li>
+<li><strong>manager</strong> - <code class="docutils literal notranslate"><span class="pre">traffic_monitor/manager/health.go:StartHealthResultManager()</span></code>. Takes preprocessed results, and aggregates them. For the Health pipeline, only health availability data is aggregated. Aggregated results are then placed in shared data structures (lastHealthDurationsThreadsafe, lastHealthEndTimes, etc). See <a class="reference internal" href="#agg-avail-data"><span class="std std-ref">Aggregated Availability Data</span></a>.</li>
+</ul>
+</div>
+<div class="section" id="peer-pipeline">
+<h3>Peer Pipeline<a class="headerlink" href="#peer-pipeline" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">---------</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">---------</span>
+<span class="o">|</span> <span class="n">poller</span> <span class="o">|-->|</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">handler</span> <span class="o">|-->|</span> <span class="n">manager</span> <span class="o">|</span>
+ <span class="o">--------</span> <span class="o">|</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">|</span> <span class="o">---------</span>
+ <span class="o">|</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">|</span>
+ <span class="o">|->|</span> <span class="n">fetcher</span> <span class="o">|-->|</span> <span class="n">handler</span> <span class="o">|-|</span>
+ <span class="o">|</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">|</span>
+ <span class="o">...</span> <span class="o">...</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li><strong>poller</strong> - <code class="docutils literal notranslate"><span class="pre">common/poller/poller.go:HttpPoller.Poll()</span></code>. Same poller type as the Stat and Health Poller pipelines, with a different handler object. Its config changes come from the Monitor Config Manager, and it starts an internal microthread for each peer to poll.</li>
+<li><strong>fetcher</strong> - <code class="docutils literal notranslate"><span class="pre">common/fetcher/fetcher.go:HttpFetcher.Fetch()</span></code>. Same fetcher type as the Stat and Health Poller pipeline, with a different handler object.</li>
+<li><strong>handler</strong> - <code class="docutils literal notranslate"><span class="pre">traffic_monitor/cache/peer.go:Handler.Handle()</span></code>. Decodes the JSON result into an object, and without further processing passes to its result channel, which is picked up by the Manager.</li>
+<li><strong>manager</strong> - <code class="docutils literal notranslate"><span class="pre">traffic_monitor/manager/peer.go:StartPeerManager()</span></code>. Takes JSON peer Traffic Monitor results, and aggregates them. The availability of the Peer Traffic Monitor itself, as well as all cache availability from the given peer result, is stored in the shared <code class="docutils literal notranslate"><span class="pre">peerStates</span></code> object. Results are then aggregated via a call to the <code class="docutils literal notranslate"><span class="pre">combineState()</span></code> lambda, which signals the State Combiner microthread (which stores the combined availability in the shared object <code class="docutils literal notranslate"><span class="pre">combinedStates</span></code>; See <a class="reference internal" href="#state-combiner"><span class="std std-ref">State Combiner</span></a>).</li>
+</ul>
+</div>
+<div class="section" id="monitor-config-pipeline">
+<h3>Monitor Config Pipeline<a class="headerlink" href="#monitor-config-pipeline" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">---------</span> <span class="o">---------</span>
+<span class="o">|</span> <span class="n">poller</span> <span class="o">|-->|</span> <span class="n">manager</span> <span class="o">|--></span> <span class="n">stat</span> <span class="n">subscriber</span> <span class="p">(</span><span class="n">Stat</span> <span class="n">pipeline</span> <span class="n">Poller</span><span class="p">)</span>
+ <span class="o">--------</span> <span class="o">---------</span> <span class="o">|</span>
+ <span class="o">|-></span> <span class="n">health</span> <span class="n">subscriber</span> <span class="p">(</span><span class="n">Health</span> <span class="n">pipeline</span> <span class="n">Poller</span><span class="p">)</span>
+ <span class="o">|</span>
+ <span class="o">--></span> <span class="n">peer</span> <span class="n">subscriber</span> <span class="p">(</span><span class="n">Peer</span> <span class="n">pipeline</span> <span class="n">Poller</span><span class="p">)</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li><strong>poller</strong> - <code class="docutils literal notranslate"><span class="pre">common/poller/poller.go:MonitorConfigPoller.Poll()</span></code>. The Monitor Config poller, on its interval, polls Traffic Ops for the Monitor configuration, and writes the polled value to its result channel, which is read by the Manager.</li>
+<li><strong>manager</strong> - <code class="docutils literal notranslate"><span class="pre">traffic_monitor/manager/monitorconfig.go:StartMonitorConfigManager()</span></code>. Listens for results from the poller, and processes them. Cache changes are written to channels read by the Health, Stat, and Peer pollers. In the Shared Data objects, this also sets the list of new delivery services and removes ones which no longer exist, and sets the list of peer Traffic Monitors.</li>
+</ul>
+</div>
+<div class="section" id="ops-config-pipeline">
+<h3>Ops Config Pipeline<a class="headerlink" href="#ops-config-pipeline" title="Permalink to this headline">¶</a></h3>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">---------</span> <span class="o">---------</span> <span class="o">---------</span>
+<span class="o">|</span> <span class="n">poller</span> <span class="o">|-->|</span> <span class="n">handler</span> <span class="o">|-->|</span> <span class="n">manager</span> <span class="o">|--></span> <span class="n">ops</span> <span class="n">config</span> <span class="n">change</span> <span class="n">subscriber</span> <span class="p">(</span><span class="n">Monitor</span> <span class="n">Config</span> <span class="n">Poller</span><span class="p">)</span>
+ <span class="o">--------</span> <span class="o">---------</span> <span class="o">---------</span> <span class="o">|</span>
+ <span class="o">--></span> <span class="n">Traffic</span> <span class="n">ops</span> <span class="n">client</span> <span class="n">change</span> <span class="n">subscriber</span> <span class="p">(</span><span class="n">Monitor</span> <span class="n">Config</span> <span class="n">Poller</span><span class="p">)</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li><strong>poller</strong> - <code class="docutils literal notranslate"><span class="pre">common/poller/poller.go:FilePoller.Poll()</span></code>. Polls for changes to the Traffic Ops config file <code class="docutils literal notranslate"><span class="pre">traffic_ops.cfg</span></code>, and writes the changed config to its result channel, which is read by the Handler.</li>
+<li><strong>handler</strong> - <code class="docutils literal notranslate"><span class="pre">common/handler/handler.go:OpsConfigFileHandler.Listen()</span></code>. Takes the given raw config, unmarshalls the JSON into an object, and writes the object to its channel, which is read by the Manager, along with any error.</li>
+<li><strong>manager</strong> - <code class="docutils literal notranslate"><span class="pre">traffic_monitor/manager/monitorconfig.go:StartMonitorConfigManager()</span></code>. Listens for new configs, and processes them. When a new config is received, a new HTTP dispatch map is created via <code class="docutils literal notranslate"><span class="pre">traffic_monitor/datareq/datareq.go:MakeDispatchMap()</span></code>, and the HTTP server is restarted with the new dispatch map. The Traffic Ops client is also recreated, and stored in its shared data object. The Ops Config change subscribers and Traffic Ops Client change subscribers (the Monitor Config poller) are also passed the new ops config and new Traffic Ops client.</li>
+</ul>
+</div>
+<div class="section" id="events">
+<h3>Events<a class="headerlink" href="#events" title="Permalink to this headline">¶</a></h3>
+<p>The <code class="docutils literal notranslate"><span class="pre">events</span></code> shared data object is passed to each pipeline microthread which needs to signal events. Most of them do. Events are then logged, and visible in the UI as well as an HTTP JSON endpoint. Most events are caches becoming available or unavailable, but include other things such as peer availability changes.</p>
+</div>
+<div class="section" id="state-combiner">
+<span id="id2"></span><h3>State Combiner<a class="headerlink" href="#state-combiner" title="Permalink to this headline">¶</a></h3>
+<p>The State Combiner is a microthread started in <code class="docutils literal notranslate"><span class="pre">traffic_monitor/manager/manager.go:Start()</span></code> via <code class="docutils literal notranslate"><span class="pre">traffic_monitor/manager/statecombiner.go:StartStateCombiner()</span></code>, which listens for signals to combine states. It should be signaled by any pipeline which updates the local or peer availability shared data objects, <code class="docutils literal notranslate"><span class="pre">localStates</span></code> and <code class="docutils literal notranslate"><span class="pre">peerStates</span></code>. It holds the threadsafe shared data objects for local states and peer states, so no data is passed or returned, only a signal.</p>
+<p>When a signal is received, it combines the local and peer states optimistically. That is, if a cache is marked available locally or by any peer, that cache is marked available in the combined states. There exists a variable to combine pessimistically, which may be set at compile time (it’s unusual for a CDN to operate well with pessimistic cache availability). Combined data is stored in the threadsafe shared data object <code class="docutils literal notranslate"><span class="pre">combinedStates</span></code>.</p>
+</div>
+<div class="section" id="aggregated-stat-data">
+<span id="agg-stat-data"></span><h3>Aggregated Stat Data<a class="headerlink" href="#aggregated-stat-data" title="Permalink to this headline">¶</a></h3>
+<p>The Stat pipeline Manager is responsible for aggregating stats from all caches, into delivery services statistics. This is done via a call to <code class="docutils literal notranslate"><span class="pre">traffic_monitor/deliveryservice/stat.go:CreateStats()</span></code>.</p>
+</div>
+<div class="section" id="aggregated-availability-data">
+<span id="agg-avail-data"></span><h3>Aggregated Availability Data<a class="headerlink" href="#aggregated-availability-data" title="Permalink to this headline">¶</a></h3>
+<p>Both the Stat and Health pipelines aggregate availability data received from caches. This is done via a call to <code class="docutils literal notranslate"><span class="pre">traffic_monitor/deliveryservice/health.go:CalcAvailability()</span></code> followed by a call to <code class="docutils literal notranslate"><span class="pre">combineState()</span></code>. The <code class="docutils literal notranslate"><span class="pre">CalcAvailability</span></code> function calculates the availability of each cache from the result of polling it, that is, local availability. The <code class="docutils literal notranslate"><span class="pre">combineState()</span></code> function is a lambda passed to the Manager, which signals the State Combiner microthread, which will combine the local and peer Traffic Monitor availability data, and insert it into the shared data <code class="docutils literal notranslate"><span class="pre">combinedStates</span></code> object.</p>
+</div>
+<div class="section" id="http-data-requests">
+<h3>HTTP Data Requests<a class="headerlink" href="#http-data-requests" title="Permalink to this headline">¶</a></h3>
+<p>Data is provided to HTTP requests via the threadsafe shared data objects (see <a class="reference internal" href="#shared-data"><span class="std std-ref">Shared Data</span></a>). These objects are closed in lambdas created via <code class="docutils literal notranslate"><span class="pre">traffic_monitor/datareq/datareq.go:MakeDispatchMap()</span></code>. This is called by the Ops Config Manager when it recreates the HTTP server.</p>
+<p>Each HTTP endpoint is mapped to a function which closes around the shared data objects it needs, and takes the request data it needs (such as query parameters). Each endpoint function resides in its own file in <code class="docutils literal notranslate"><span class="pre">traffic_monitor/datareq/</span></code>. Because each Go HTTP routing function must be a <code class="docutils literal notranslate"><span class="pre">http.HandlerFunc</span></code>, wrapper functions take the endpoint functions and return <code class="docutils literal notranslate"><span class="pre">http.HandlerFunc</span></code> functions which call them, and which are stored in the dispatch map, to be registered with the HTTP server.</p>
+</div>
+<div class="section" id="shared-data">
+<span id="id3"></span><h3>Shared Data<a class="headerlink" href="#shared-data" title="Permalink to this headline">¶</a></h3>
+<p>Processed and aggregated data must be shared between the end of the stat and health processing pipelines, and HTTP requests. The CSP paradigm of idiomatic Go does not work efficiently with storing and sharing state. While not idiomatic Go, shared mutexed data structures are faster and simpler than CSP manager microthreads for each data object.</p>
+<p>Traffic Monitor has many threadsafe shared data types and objects. All shared data objects can be seen in <code class="docutils literal notranslate"><span class="pre">manager/manager.go:Start()</span></code>, where they are created and passed to the various pipeline stage microthreads that need them. Their respective types all include the word <code class="docutils literal notranslate"><span class="pre">Threadsafe</span></code>, and can be found in <code class="docutils literal notranslate"><span class="pre">traffic_monitor/threadsafe/</span></code> as well as, for dependency reasons, various appropriate directories.</p>
+<p>Currently, all Threadsafe shared data types use mutexes. In the future, these could be changed to lock-free or wait-free structures, if the performance needs outweighed the readability and correctness costs. They could also easily be changed to internally be manager microthreads and channels, if being idiomatic were deemed more important than readability or performance.</p>
+</div>
+</div>
+<div class="section" id="formatting-conventions">
+<h2>Formatting Conventions<a class="headerlink" href="#formatting-conventions" title="Permalink to this headline">¶</a></h2>
+<p>Go code should be formatted with <code class="docutils literal notranslate"><span class="pre">gofmt</span></code>. See also <code class="docutils literal notranslate"><span class="pre">CONTRIBUTING.md</span></code>.</p>
</div>
<div class="section" id="installing-the-developer-environment">
<h2>Installing The Developer Environment<a class="headerlink" href="#installing-the-developer-environment" title="Permalink to this headline">¶</a></h2>
<p>To install the Traffic Monitor Developer environment:</p>
<ol class="arabic simple">
-<li>Clone the traffic_control repository using Git.</li>
-<li>Change directories into <code class="docutils literal"><span class="pre">traffic_control/traffic_monitor</span></code>.</li>
-<li>Edit the following parameters in src/test/resources/conf/traffic_monitor_config.js:</li>
-</ol>
-<blockquote>
-<div><table border="1" class="docutils">
-<colgroup>
-<col width="22%" />
-<col width="78%" />
-</colgroup>
-<thead valign="bottom">
-<tr class="row-odd"><th class="head">Parameter</th>
-<th class="head">Value</th>
-</tr>
-</thead>
-<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">tm.hostname</span></code></td>
-<td>FQDN of the Traffic Ops instance (do not include <a class="reference external" href="http://">http://</a>).</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">tm.username</span></code></td>
-<td>Admin username for Traffic Ops</td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">tm.password</span></code></td>
-<td>Password for admin user</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
-<td>Name of the CDN this Traffic Monitor will monitor</td>
-</tr>
-</tbody>
-</table>
-<p>Note: any change done later in the configuration file requires a mvn build in order to be applied.</p>
-</div></blockquote>
-<ol class="arabic" start="4">
-<li><p class="first">Import the existing git repo into Eclipse:</p>
-<blockquote>
-<div><ol class="loweralpha simple">
-<li>File -> Import -> Git -> Projects from Git; Next</li>
-<li>Existing local repository; Next</li>
-<li>Add -> browse to find <code class="docutils literal"><span class="pre">traffic_control</span></code>; Add</li>
-<li>Select <code class="docutils literal"><span class="pre">traffic_control</span></code>; Next</li>
-<li>Ensure “Import existing projects” is selected, expand <code class="docutils literal"><span class="pre">traffic_control</span></code>, select <code class="docutils literal"><span class="pre">traffic_monitor</span></code>; Next</li>
-<li>Ensure <code class="docutils literal"><span class="pre">traffic_monitor</span></code> is checked; Finish</li>
-<li>Ensure <code class="docutils literal"><span class="pre">traffic_monitor</span></code> has been opened by Eclipse after importing</li>
-</ol>
-</div></blockquote>
-</li>
-<li><p class="first">Run <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">verify</span></code> from the <code class="docutils literal"><span class="pre">traffic_monitor</span></code> directory</p>
-</li>
-<li><p class="first">Start the embedded Jetty instance from within Eclipse</p>
-<blockquote>
-<div><ol class="loweralpha">
-<li><p class="first">In the package explorer, expand <code class="docutils literal"><span class="pre">traffic_monitor</span></code></p>
-</li>
-<li><p class="first">Expand <code class="docutils literal"><span class="pre">src/test/java</span></code></p>
-</li>
-<li><p class="first">Expand the package <code class="docutils literal"><span class="pre">com.comcast.cdn.traffic_control.traffic_monitor</span></code></p>
-</li>
-<li><p class="first">Open and run <code class="docutils literal"><span class="pre">Start.java</span></code></p>
-<blockquote>
-<div><div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">If an error is displayed in the Console, run <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">verify</span></code> from the <code class="docutils literal"><span class="pre">traffic_monitor</span></code> directory</p>
-</div>
-</div></blockquote>
-</li>
-<li><p class="first">With a web browser, navigate to <a class="reference external" href="http://localhost:8080">http://localhost:8080</a></p>
-</li>
-</ol>
-</div></blockquote>
-</li>
+<li>Install <cite>go</cite> version 1.7 or greater, from <a class="reference external" href="https://golang.org/doc/install">https://golang.org/doc/install</a> and <a class="reference external" href="https://golang.org/doc/code.html">https://golang.org/doc/code.html</a></li>
+<li>Clone the traffic_control repository using Git, into <code class="docutils literal notranslate"><span class="pre">$GOPATH/src/github.com/apache/incubator-trafficcontrol</span></code></li>
+<li>Change directories into <code class="docutils literal notranslate"><span class="pre">$GOPATH/src/github.com/apache/incubator-trafficcontrol/traffic_monitor_golang/traffic_monitor</span></code></li>
+<li>Run <code class="docutils literal notranslate"><span class="pre">./build.sh</span></code></li>
</ol>
</div>
<div class="section" id="test-cases">
<h2>Test Cases<a class="headerlink" href="#test-cases" title="Permalink to this headline">¶</a></h2>
-<p>Unit tests can be executed using Maven by running <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">test</span></code> at the root of the <code class="docutils literal"><span class="pre">traffic_monitor</span></code> project.</p>
+<p>Tests can be executed by running <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">test</span> <span class="pre">./...</span></code> at the root of the <code class="docutils literal notranslate"><span class="pre">traffic_monitor_golang</span></code> project.</p>
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
@@ -365,16 +493,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/development/traffic_monitor/traffic_monitor_api.html b/docs/latest/development/traffic_monitor/traffic_monitor_api.html
index ec8788f..b8d3775 100644
--- a/docs/latest/development/traffic_monitor/traffic_monitor_api.html
+++ b/docs/latest/development/traffic_monitor/traffic_monitor_api.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Monitor APIs — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Monitor APIs — Traffic Control 2.2-dev documentation </title>
@@ -33,10 +35,13 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
- <link rel="up" title="Traffic Monitor" href="../traffic_monitor.html"/>
- <link rel="next" title="Traffic Monitor Golang" href="../traffic_monitor_golang.html"/>
- <link rel="prev" title="Traffic Monitor" href="../traffic_monitor.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
+ <link rel="up" title="Traffic Monitor Golang" href="../traffic_monitor.html"/>
+ <link rel="next" title="Traffic Stats" href="../traffic_stats.html"/>
+ <link rel="prev" title="Traffic Monitor Golang" href="../traffic_monitor.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,16 +178,16 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Developer’s Guide</a> »</li>
+ <li><a href="../index.html">Developer’s Guide</a> »</li>
- <li><a href="../traffic_monitor.html">Traffic Monitor</a> »</li>
+ <li><a href="../traffic_monitor.html">Traffic Monitor Golang</a> »</li>
<li>Traffic Monitor APIs</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/development/traffic_monitor/traffic_monitor_api.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/development/traffic_monitor/traffic_monitor_api.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -182,10 +196,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../traffic_monitor_golang.html" class="btn btn-neutral float-right" title="Traffic Monitor Golang">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../traffic_stats.html" class="btn btn-neutral float-right" title="Traffic Stats">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="../traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor Golang"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -218,15 +232,15 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">hc</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
@@ -252,15 +266,15 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">hc</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
@@ -286,15 +300,15 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">hc</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
@@ -320,15 +334,15 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">hc</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
@@ -369,15 +383,15 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">hc</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
@@ -408,28 +422,28 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">startTime</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">startTime</span></code></td>
<td>number</td>
<td>Window start. The number of milliseconds since the epoch.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">endTime</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">endTime</span></code></td>
<td>number</td>
<td>Window end. The number of milliseconds since the epoch.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">hc</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">hc</span></code></td>
<td>int</td>
<td>The history count, number of items to display.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">stats</span></code></td>
<td>string</td>
<td>A comma separated list of stats to display.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">wildcard</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">wildcard</span></code></td>
<td>boolean</td>
<td>Controls whether specified stats should be
treated as partial strings.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cache</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cache</span></code></td>
<td>string</td>
<td>Summary statistics for just this cache.</td>
</tr>
@@ -448,10 +462,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../traffic_monitor_golang.html" class="btn btn-neutral float-right" title="Traffic Monitor Golang">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../traffic_stats.html" class="btn btn-neutral float-right" title="Traffic Stats">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="../traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor Golang"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -475,16 +489,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/development/traffic_ops.html b/docs/latest/development/traffic_ops.html
index 8554c37..ae65cf6 100644
--- a/docs/latest/development/traffic_ops.html
+++ b/docs/latest/development/traffic_ops.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Ops — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Ops — Traffic Control 2.2-dev documentation </title>
@@ -33,9 +35,12 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Developer’s Guide" href="index.html"/>
- <link rel="next" title="API Routes" href="traffic_ops_api/routes.html"/>
+ <link rel="next" title="Traffic Portal" href="traffic_portal.html"/>
<link rel="prev" title="Building Traffic Control" href="building.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="building.html">Building Traffic Control</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Developer’s Guide</a> »</li>
+ <li><a href="index.html">Developer’s Guide</a> »</li>
<li>Traffic Ops</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/development/traffic_ops.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/development/traffic_ops.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -180,7 +194,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="traffic_ops_api/routes.html" class="btn btn-neutral float-right" title="API Routes">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="traffic_portal.html" class="btn btn-neutral float-right" title="Traffic Portal">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="building.html" class="btn btn-neutral" title="Building Traffic Control"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -193,7 +207,7 @@
<h1>Traffic Ops<a class="headerlink" href="#traffic-ops" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
-<p>Traffic Ops uses a MySql or Postgres database to store the configuration information, and the <a class="reference external" href="http://mojolicio.us/">Mojolicious framework</a> to generate the user interface and REST APIs.</p>
+<p>Traffic Ops uses a Postgres database to store the configuration information, and the <a class="reference external" href="http://mojolicio.us/">Mojolicious framework</a> to generate the user interface and REST APIs.</p>
</div>
<div class="section" id="software-requirements">
<h2>Software Requirements<a class="headerlink" href="#software-requirements" title="Permalink to this headline">¶</a></h2>
@@ -204,16 +218,15 @@
<li>cpan JSON::PP</li>
</ul>
</li>
-<li><a class="reference external" href="http://golang.org/doc/install">Go 1.4</a></li>
+<li><a class="reference external" href="http://golang.org/doc/install">Go 1.8.3</a></li>
<li>Perl 5.10.1</li>
<li>Git</li>
-<li>MySQL 5.1.52</li>
+<li>Postgres 9.6.6</li>
<li><a class="reference external" href="https://bitbucket.org/liamstask/goose/">Goose</a></li>
</ul>
<p>Addionally, the installation of the following RPMs (or equivalent) is required:</p>
<ul class="simple">
<li>All RPMs listed in <a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html#rl-ps"><span class="std std-ref">Traffic Ops - Migrating from 1.x to 2.x</span></a></li>
-<li>mysql-test</li>
</ul>
</div>
<div class="section" id="traffic-ops-project-tree-overview">
@@ -236,7 +249,7 @@
<li>/API - Mojo Controllers for the /API area of the application.</li>
<li>/Common - Common Code between both the API and UI areas.</li>
<li>/Extensions</li>
-<li>Fixtures/ - Test Case fixture data for the ‘to_test’ database.
+<li>Fixtures/ - Test Case fixture data for the ‘to_test’ database.
* /Integration - Integration Tests.</li>
<li>/MojoPlugins - Mojolicious Plugins for Common Controller Code.</li>
<li>Schema/ - Database Schema area.
@@ -274,7 +287,7 @@
<div class="section" id="perl-formatting-conventions">
<h2>Perl Formatting Conventions<a class="headerlink" href="#perl-formatting-conventions" title="Permalink to this headline">¶</a></h2>
<p>Perl tidy is for use in code formatting. See the following config file for formatting conventions.</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>edit a file called $HOME/.perltidyrc
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>edit a file called $HOME/.perltidyrc
-l=156
-et=4
@@ -301,12 +314,12 @@
<div class="section" id="database-management">
<h2>Database Management<a class="headerlink" href="#database-management" title="Permalink to this headline">¶</a></h2>
<p>The admin.pl script is for use in managing the Traffic Ops database tables. Below is an example of its usage.</p>
-<p><code class="docutils literal"><span class="pre">$</span> <span class="pre">db/admin.pl</span></code></p>
-<p>Usage: db/admin.pl [–env (development|test|production)] [arguments]</p>
-<p>Example: <code class="docutils literal"><span class="pre">db/admin.pl</span> <span class="pre">--env=test</span> <span class="pre">reset</span></code></p>
+<p><code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">db/admin.pl</span></code></p>
+<p>Usage: db/admin.pl [–env (development|test|production)] [arguments]</p>
+<p>Example: <code class="docutils literal notranslate"><span class="pre">db/admin.pl</span> <span class="pre">--env=test</span> <span class="pre">reset</span></code></p>
<p>Purpose: This script is used to manage the database. The environments are defined in the dbconf.yml, as well as the database names.</p>
<ul class="simple">
-<li>To use the <code class="docutils literal"><span class="pre">admin.pl</span></code> script, you may need to add <code class="docutils literal"><span class="pre">traffic_ops/lib</span></code> and <code class="docutils literal"><span class="pre">traffic_ops/local/lib/perl5</span></code> to your <a class="reference external" href="http://modperlbook.org/html/3-9-2-2-Using-the-PERL5LIB-environment-variable.html">PERL5LIB</a> environment variable.</li>
+<li>To use the <code class="docutils literal notranslate"><span class="pre">admin.pl</span></code> script, you may need to add <code class="docutils literal notranslate"><span class="pre">traffic_ops/lib</span></code> and <code class="docutils literal notranslate"><span class="pre">traffic_ops/local/lib/perl5</span></code> to your <a class="reference external" href="http://modperlbook.org/html/3-9-2-2-Using-the-PERL5LIB-environment-variable.html">PERL5LIB</a> environment variable.</li>
</ul>
<table border="1" class="docutils">
<colgroup>
@@ -320,13 +333,13 @@
</thead>
<tbody valign="top">
<tr class="row-even"><td>create</td>
-<td>Execute db ‘create’ the database for the current environment.</td>
+<td>Execute db ‘create’ the database for the current environment.</td>
</tr>
<tr class="row-odd"><td>down</td>
<td>Roll back a single migration from the current version.</td>
</tr>
<tr class="row-even"><td>drop</td>
-<td>Execute db ‘drop’ on the database for the current environment.</td>
+<td>Execute db ‘drop’ on the database for the current environment.</td>
</tr>
<tr class="row-odd"><td>redo</td>
<td>Roll back the most recently applied migration, then run it again.</td>
@@ -360,48 +373,26 @@
<li>Install the local dependencies using Carton (cpanfile).</li>
</ol>
<blockquote>
-<div><div class="highlight-default"><div class="highlight"><pre><span></span>$ cd traffic_ops/app
+<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ cd traffic_ops/app
$ carton
</pre></div>
</div>
</div></blockquote>
-<ol class="arabic simple" start="3">
-<li>Set up a user in MySQL.</li>
-</ol>
-<blockquote>
-<div><p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>master $ mysql
-Welcome to the MySQL monitor. Commands end with ; or \g.
-Your MySQL connection id is 305
-Server version: 5.6.19 Homebrew
-
-Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
-
-Oracle is a registered trademark of Oracle Corporation and/or its
-affiliates. Other names may be trademarks of their respective
-owners.
-
-Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
-
-mysql> create user 'to_user'@'localhost';
-mysql> grant all on to_development.* to 'to_user'@'localhost' identified by 'twelve';
-mysql> grant all on to_test.* to 'to_user'@'localhost' identified by 'twelve';
-mysql> grant all on to_integration.* to 'to_user'@'localhost' identified by 'twelve';
-</pre></div>
-</div>
-</div></blockquote>
-<ol class="arabic" start="4">
-<li><p class="first">Enter <code class="docutils literal"><span class="pre">db/admin.pl</span> <span class="pre">--env=<enviroment</span> <span class="pre">name></span> <span class="pre">setup</span></code> to set up the traffic_ops database(s).</p>
+<ol class="arabic" start="3">
+<li><p class="first">Set up a role (user) in Postgres</p>
+<p>See Postgres instructions on initdb <a class="reference external" href="https://wiki.postgresql.org/wiki/First_steps">https://wiki.postgresql.org/wiki/First_steps</a></p>
+</li>
+<li><p class="first">Enter <code class="docutils literal notranslate"><span class="pre">db/admin.pl</span> <span class="pre">--env=<enviroment</span> <span class="pre">name></span> <span class="pre">setup</span></code> to set up the traffic_ops database(s).</p>
<ul class="simple">
-<li>Unit test database: <code class="docutils literal"><span class="pre">$</span> <span class="pre">db/admin.pl</span> <span class="pre">--env=test</span> <span class="pre">setup</span></code></li>
-<li>Development database: <code class="docutils literal"><span class="pre">$</span> <span class="pre">db/admin.pl</span> <span class="pre">--env=development</span> <span class="pre">setup</span></code></li>
-<li>Integration database: <code class="docutils literal"><span class="pre">$</span> <span class="pre">db/admin.pl</span> <span class="pre">--env=integration</span> <span class="pre">setup</span></code></li>
+<li>Unit test database: <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">db/admin.pl</span> <span class="pre">--env=test</span> <span class="pre">setup</span></code></li>
+<li>Development database: <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">db/admin.pl</span> <span class="pre">--env=development</span> <span class="pre">setup</span></code></li>
+<li>Integration database: <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">db/admin.pl</span> <span class="pre">--env=integration</span> <span class="pre">setup</span></code></li>
</ul>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p>Running the the admin.pl script in setup mode should look like this:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>master $ db/admin.pl --env=development setup
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>master $ db/admin.pl --env=development setup
Using database.conf: conf/development/database.conf
Using database.conf: conf/development/database.conf
Using database.conf: conf/development/database.conf
@@ -424,24 +415,24 @@
</pre></div>
</div>
</li>
-<li><p class="first">(Optional) To load temporary data into the tables: <code class="docutils literal"><span class="pre">$</span> <span class="pre">perl</span> <span class="pre">bin/db/setup_kabletown.pl</span></code></p>
+<li><p class="first">(Optional) To load temporary data into the tables: <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">perl</span> <span class="pre">bin/db/setup_kabletown.pl</span></code></p>
</li>
-<li><p class="first">Run the postinstall script: <code class="docutils literal"><span class="pre">traffic_ops/install/bin/postinstall</span></code></p>
+<li><p class="first">Run the postinstall script: <code class="docutils literal notranslate"><span class="pre">traffic_ops/install/bin/postinstall</span></code></p>
</li>
-<li><p class="first">To start Traffic Ops, enter <code class="docutils literal"><span class="pre">$</span> <span class="pre">bin/start.pl</span></code></p>
+<li><p class="first">To start Traffic Ops, enter <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">bin/start.pl</span></code></p>
<p>The local Traffic Ops instance uses an open source framework called morbo, starting following the start command execution.</p>
<p>Start up success includes the following:</p>
</li>
</ol>
<blockquote>
-<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="mi">2015</span><span class="o">-</span><span class="mi">02</span><span class="o">-</span><span class="mi">24</span> <span class="mi">10</span><span class="p">:</span><span class="mi">44</span><span class="p">:</span><span class="mi">34</span><span class="p">,</span><span class="mi">991</span><span class="p">]</span> <span class="p">[</span><span class="n">INFO</span><span class="p">]</span> <span class="n">Listening</span> <span class="n">at</span> <span class="s2">"http://*:3000"</span><span class="o">.</span>
+<div><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="mi">2015</span><span class="o">-</span><span class="mi">02</span><span class="o">-</span><span class="mi">24</span> <span class="mi">10</span><span class="p">:</span><span class="mi">44</span><span class="p">:</span><span class="mi">34</span><span class="p">,</span><span class="mi">991</span><span class="p">]</span> <span class="p">[</span><span class="n">INFO</span><span class="p">]</span> <span class="n">Listening</span> <span class="n">at</span> <span class="s2">"http://*:3000"</span><span class="o">.</span>
<span class="n">Server</span> <span class="n">available</span> <span class="n">at</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span><span class="p">:</span><span class="mf">3000.</span>
</pre></div>
</div>
</div></blockquote>
<ol class="arabic simple" start="8">
-<li>Using a browser, navigate to the given address: <code class="docutils literal"><span class="pre">http://127.0.0.1:3000</span></code></li>
+<li>Using a browser, navigate to the given address: <code class="docutils literal notranslate"><span class="pre">http://127.0.0.1:3000</span></code></li>
<li>For the initial log in:</li>
</ol>
<blockquote>
@@ -458,16 +449,16 @@
<h2>Test Cases<a class="headerlink" href="#test-cases" title="Permalink to this headline">¶</a></h2>
<p>Use prove to execute test cases. Execute after a carton install:</p>
<ul class="simple">
-<li>To run the Unit Tests: <code class="docutils literal"><span class="pre">$</span> <span class="pre">local/bin/prove</span> <span class="pre">-qrp</span> <span class="pre">t/</span></code></li>
-<li>To run the Integration Tests: <code class="docutils literal"><span class="pre">$</span> <span class="pre">local/bin/prove</span> <span class="pre">-qrp</span> <span class="pre">t_integration/</span></code></li>
+<li>To run the Unit Tests: <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">local/bin/prove</span> <span class="pre">-qrp</span>  <span class="pre">t/</span></code></li>
+<li>To run the Integration Tests: <code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">local/bin/prove</span> <span class="pre">-qrp</span> <span class="pre">t_integration/</span></code></li>
</ul>
<div class="section" id="the-kabletown-cdn-example">
<h3>The KableTown CDN example<a class="headerlink" href="#the-kabletown-cdn-example" title="Permalink to this headline">¶</a></h3>
<p>The integration tests will load an example CDN with most of the features of Traffic Control being used. This is mostly for testing purposes, but can also be used as an example of how to configure certain features. To load the KableTown CDN example and access it:</p>
<ol class="arabic simple">
<li>Run the integration tests</li>
-<li>Start morbo against the integration database: <code class="docutils literal"><span class="pre">export</span> <span class="pre">MOJO_MODE=integration;</span> <span class="pre">./bin/start.pl</span></code></li>
-<li>Using a browser, navigate to the given address: <code class="docutils literal"><span class="pre">http://127.0.0.1:3000</span></code></li>
+<li>Start morbo against the integration database: <code class="docutils literal notranslate"><span class="pre">export</span> <span class="pre">MOJO_MODE=integration;</span> <span class="pre">./bin/start.pl</span></code></li>
+<li>Using a browser, navigate to the given address: <code class="docutils literal notranslate"><span class="pre">http://127.0.0.1:3000</span></code></li>
<li>For the initial log in:</li>
</ol>
<blockquote>
@@ -485,7 +476,7 @@
<li>Check Extensions</li>
</ol>
<blockquote>
-<div>These allow you to add custom checks to the “Health->Server Checks” view.</div></blockquote>
+<div>These allow you to add custom checks to the “Health->Server Checks” view.</div></blockquote>
<ol class="arabic simple" start="2">
<li>Configuration Extensions</li>
</ol>
@@ -499,41 +490,41 @@
<p>Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see <a class="reference internal" href="../admin/traffic_ops/extensions.html#admin-to-ext-script"><span class="std std-ref">Managing Traffic Ops Extensions</span></a>.</p>
<div class="section" id="check-extensions">
<h3>Check Extensions<a class="headerlink" href="#check-extensions" title="Permalink to this headline">¶</a></h3>
-<p>In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the “Health->Server Checks” view and that usually run periodically out of cron.</p>
+<p>In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the “Health->Server Checks” view and that usually run periodically out of cron.</p>
<p>It is the responsibility of the check extension script to iterate over the servers it wants to check and post the results.</p>
-<p>An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops’ <code class="docutils literal"><span class="pre">/api/1.1/servers.json</span></code> REST target. This list is walked, running a command to gather the stats from that cache. For some extensions, an HTTP GET request might be made to the ATS astats plugin, while for others the cache might be pinged, or a command run over SSH. The results are then compiled into a numeric or boolean result and the script POSTs tha result back to the Traffic Ops <code class="docutils literal"><span class="pre">/api/1.1/servercheck/</span></code> target.</p>
-<p>A check extension can have a column of <img alt="checkmark" src="../_images/good1.png" />‘s and <img alt="X" src="../_images/bad1.png" />‘s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Script</span> <span class="n">here</span><span class="o">.</span>
+<p>An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops’ <code class="docutils literal notranslate"><span class="pre">/api/1.1/servers.json</span></code> REST target. This list is walked, running a command to gather the stats from that cache. For some extensions, an HTTP GET request might be made to the ATS astats plugin, while for others the cache might be pinged, or a command run over SSH. The results are then compiled into a numeric or boolean result and the script POSTs tha result back to the Traffic Ops <code class="docutils literal notranslate"><span class="pre">/api/1.1/servercheck/</span></code> target.</p>
+<p>A check extension can have a column of <img alt="checkmark" src="../_images/good1.png" />‘s and <img alt="X" src="../_images/bad1.png" />‘s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Script</span> <span class="n">here</span><span class="o">.</span>
</pre></div>
</div>
<p>Check Extension scripts are located in the $TO_HOME/bin/checks directory.</p>
<p>Currently, the following Check Extensions are available and installed by default:</p>
<dl class="docutils">
<dt><strong>Cache Disk Usage Check - CDU</strong></dt>
-<dd>This check shows how much of the available total cache disk is in use. A “warm” cache should show 100.00.</dd>
+<dd>This check shows how much of the available total cache disk is in use. A “warm” cache should show 100.00.</dd>
<dt><strong>Cache Hit Ratio Check - CHR</strong></dt>
<dd>The cache hit ratio for the cache in the last 15 minutes (the interval is determined by the cron entry).</dd>
<dt><strong>DiffServe CodePoint Check - DSCP</strong></dt>
<dd>Checks if the returning traffic from the cache has the correct DSCP value as assigned in the delivery service. (Some routers will overwrite DSCP)</dd>
<dt><strong>Maximum Transmission Check - MTU</strong></dt>
-<dd>Checks if the Traffic Ops host (if that is the one running the check) can send and receive 8192 size packets to the <code class="docutils literal"><span class="pre">ip_address</span></code> of the server in the server table.</dd>
+<dd>Checks if the Traffic Ops host (if that is the one running the check) can send and receive 8192 size packets to the <code class="docutils literal notranslate"><span class="pre">ip_address</span></code> of the server in the server table.</dd>
<dt><strong>Operational Readiness Check - ORT</strong></dt>
<dd>See <a class="reference internal" href="../admin/traffic_server.html#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a> for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.</dd>
<dt><strong>Ping Check - 10G, ILO, 10G6, FQDN</strong></dt>
<dd><p class="first">The bin/checks/ToPingCheck.pl is to check basic IP connectivity, and in the default setup it checks IP connectivity to the following:</p>
<dl class="last docutils">
<dt>10G</dt>
-<dd>Is the <code class="docutils literal"><span class="pre">ip_address</span></code> (the main IPv4 address) from the server table pingable?</dd>
+<dd>Is the <code class="docutils literal notranslate"><span class="pre">ip_address</span></code> (the main IPv4 address) from the server table pingable?</dd>
<dt>ILO</dt>
-<dd>Is the <code class="docutils literal"><span class="pre">ilo_ip_address</span></code> (the lights-out-mangement IPv4 address) from the server table pingable?</dd>
+<dd>Is the <code class="docutils literal notranslate"><span class="pre">ilo_ip_address</span></code> (the lights-out-mangement IPv4 address) from the server table pingable?</dd>
<dt>10G6</dt>
-<dd>Is the <code class="docutils literal"><span class="pre">ip6_address</span></code> (the main IPv6 address) from the server table pingable?</dd>
+<dd>Is the <code class="docutils literal notranslate"><span class="pre">ip6_address</span></code> (the main IPv6 address) from the server table pingable?</dd>
<dt>FQDN</dt>
-<dd>Is the Fully Qualified Domain name (the concatenation of <code class="docutils literal"><span class="pre">host_name</span></code> and <code class="docutils literal"><span class="pre">.</span></code> and <code class="docutils literal"><span class="pre">domain_name</span></code> from the server table) pingable?</dd>
+<dd>Is the Fully Qualified Domain name (the concatenation of <code class="docutils literal notranslate"><span class="pre">host_name</span></code> and <code class="docutils literal notranslate"><span class="pre">.</span></code> and <code class="docutils literal notranslate"><span class="pre">domain_name</span></code> from the server table) pingable?</dd>
</dl>
</dd>
<dt><strong>Traffic Router Check - RTR</strong></dt>
-<dd>Checks the state of each cache as perceived by all Traffic Monitors (via Traffic Router). This extension asks each Traffic Router for the state of the cache. A check failure is indicated if one or more monitors report an error for a cache. A cache is only marked as good if all reports are positive. (This is a pessimistic approach, opposite of how TM marks a cache as up, “the optimistic approach”)</dd>
+<dd>Checks the state of each cache as perceived by all Traffic Monitors (via Traffic Router). This extension asks each Traffic Router for the state of the cache. A check failure is indicated if one or more monitors report an error for a cache. A cache is only marked as good if all reports are positive. (This is a pessimistic approach, opposite of how TM marks a cache as up, “the optimistic approach”)</dd>
</dl>
</div>
<div class="section" id="configuration-extensions">
@@ -551,7 +542,7 @@
<div class="section" id="extension-directories">
<h3>Extension Directories<a class="headerlink" href="#extension-directories" title="Permalink to this headline">¶</a></h3>
<p>PERL5LIB Example Configuration:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops_extensions</span><span class="o">/</span><span class="n">private</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="o">/</span><span class="n">TrafficStats</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops_extensions</span><span class="o">/</span><span class="n">private</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="o">/</span><span class="n">TrafficStats</span>
</pre></div>
</div>
</div>
@@ -569,281 +560,7 @@
</div>
<div class="section" id="development-configuration">
<h3>Development Configuration<a class="headerlink" href="#development-configuration" title="Permalink to this headline">¶</a></h3>
-<p>To incorporate any custom Extensions during development set your PERL5LIB with any number of directories with the understanding that the PERL5LIB search order will come into play, so keep in mind that top-down is how your code will be located. Once Perl locates your custom route or Perl package/class it ‘pins’ on that class or Mojo Route and doesn’t look any further, which allows for the developer to <em>override</em> Traffic Ops functionality.</p>
-</div>
-</div>
-<div class="section" id="api">
-<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
-<p>The Traffic Ops API provides programmatic access to read and write CDN data providing authorized API consumers with the ability to monitor CDN performance and configure CDN settings and parameters.</p>
-<div class="section" id="response-structure">
-<h3>Response Structure<a class="headerlink" href="#response-structure" title="Permalink to this headline">¶</a></h3>
-<p>All successful responses have the following structure:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="o"><</span><span class="n">JSON</span> <span class="nb">object</span> <span class="k">with</span> <span class="n">main</span> <span class="n">response</span><span class="o">></span><span class="p">,</span>
-<span class="p">}</span>
-</pre></div>
-</div>
-<p>To make the documentation easier to read, only the <code class="docutils literal"><span class="pre"><JSON</span> <span class="pre">object</span> <span class="pre">with</span> <span class="pre">main</span> <span class="pre">response></span></code> is documented, even though the response and version fields are always present.</p>
-</div>
-<div class="section" id="using-api-endpoints">
-<h3>Using API Endpoints<a class="headerlink" href="#using-api-endpoints" title="Permalink to this headline">¶</a></h3>
-<ol class="arabic simple">
-<li>Authenticate with your Traffic Portal or Traffic Ops user account credentials.</li>
-<li>Upon successful user authentication, note the mojolicious cookie value in the response headers.</li>
-<li>Pass the mojolicious cookie value, along with any subsequent calls to an authenticated API endpoint.</li>
-</ol>
-<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
-{"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
-[jvd@laika ~]$
-[jvd@laika ~]$ curl -v -H "Accept: application/json" -v -X POST --data '{ "u":"admin", "p":"secret_passwd" }' http://localhost:3000/api/1.1/user/login
-* Hostname was NOT found in DNS cache
-* Trying ::1...
-* connect to ::1 port 3000 failed: Connection refused
-* Trying 127.0.0.1...
-* Connected to localhost (127.0.0.1) port 3000 (#0)
-> POST /api/1.1/user/login HTTP/1.1
-> User-Agent: curl/7.37.1
-> Host: localhost:3000
-> Accept: application/json
-> Content-Length: 32
-> Content-Type: application/x-www-form-urlencoded
->
-* upload completely sent off: 32 out of 32 bytes
-< HTTP/1.1 200 OK
-< Connection: keep-alive
-< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
-< Access-Control-Allow-Origin: http://localhost:8080
-< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
-< Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862; expires=Sun, 19 Apr 2015 00:10:01 GMT; path=/; HttpOnly
-< Content-Type: application/json
-< Date: Sat, 18 Apr 2015 20:10:01 GMT
-< Access-Control-Allow-Credentials: true
-< Content-Length: 81
-< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
-* Server Mojolicious (Perl) is not blacklisted
-< Server: Mojolicious (Perl)
-<
-* Connection #0 to host localhost left intact
-{"alerts":[{"level":"success","text":"Successfully logged in."}]}
-[jvd@laika ~]$
-
-[jvd@laika ~]$ curl -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asns.json
-{"response":{"asns":[{"lastUpdated":"2012-09-17 15:41:22", .. asn data deleted .. ,}
-[jvd@laika ~]$
-</pre></div>
-</div>
-</div>
-<div class="section" id="api-errors">
-<h3>API Errors<a class="headerlink" href="#api-errors" title="Permalink to this headline">¶</a></h3>
-<p><strong>Response Properties</strong></p>
-<table border="1" class="docutils">
-<colgroup>
-<col width="28%" />
-<col width="10%" />
-<col width="62%" />
-</colgroup>
-<thead valign="bottom">
-<tr class="row-odd"><th class="head">Parameter</th>
-<th class="head">Type</th>
-<th class="head">Description</th>
-</tr>
-</thead>
-<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">alerts</span></code></td>
-<td>array</td>
-<td>A collection of alert messages.</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>level</span></code></td>
-<td>string</td>
-<td>Success, info, warning or error.</td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>text</span></code></td>
-<td>string</td>
-<td>Alert message.</td>
-</tr>
-</tbody>
-</table>
-<p>The 3 most common errors returned by Traffic Ops are:</p>
-<dl class="docutils">
-<dt>401 Unauthorized</dt>
-<dd><p class="first">When you don’t supply the right cookie, this is the response.</p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
-* Hostname was NOT found in DNS cache
-* Trying ::1...
-* connect to ::1 port 3000 failed: Connection refused
-* Trying 127.0.0.1...
-* Connected to localhost (127.0.0.1) port 3000 (#0)
-> GET /api/1.1/usage/asns.json HTTP/1.1
-> User-Agent: curl/7.37.1
-> Host: localhost:3000
-> Accept: application/json
->
-< HTTP/1.1 401 Unauthorized
-< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
-< Content-Length: 84
-* Server Mojolicious (Perl) is not blacklisted
-< Server: Mojolicious (Perl)
-< Connection: keep-alive
-< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
-< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
-< Access-Control-Allow-Origin: http://localhost:8080
-< Date: Sat, 18 Apr 2015 20:36:12 GMT
-< Content-Type: application/json
-< Access-Control-Allow-Credentials: true
-<
-* Connection #0 to host localhost left intact
-{"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
-[jvd@laika ~]$
-</pre></div>
-</div>
-</dd>
-<dt>404 Not Found</dt>
-<dd><p class="first">When the resource (path) is non existent Traffic Ops returns a 404:</p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
-* Hostname was NOT found in DNS cache
-* Trying ::1...
-* connect to ::1 port 3000 failed: Connection refused
-* Trying 127.0.0.1...
-* Connected to localhost (127.0.0.1) port 3000 (#0)
-> GET /api/1.1/asnsjj.json HTTP/1.1
-> User-Agent: curl/7.37.1
-> Host: localhost:3000
-> Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;
-> Accept: application/json
->
-< HTTP/1.1 404 Not Found
-* Server Mojolicious (Perl) is not blacklisted
-< Server: Mojolicious (Perl)
-< Content-Length: 75
-< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
-< Content-Type: application/json
-< Date: Sat, 18 Apr 2015 20:37:43 GMT
-< Access-Control-Allow-Credentials: true
-< Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAzODYzLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--8a5a61b91473bc785d4073fe711de8d2c63f02dd; expires=Sun, 19 Apr 2015 00:37:43 GMT; path=/; HttpOnly
-< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
-< Connection: keep-alive
-< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
-< Access-Control-Allow-Origin: http://localhost:8080
-<
-* Connection #0 to host localhost left intact
-{"alerts":[{"text":"Resource not found.","level":"error"}]}
-[jvd@laika ~]$
-</pre></div>
-</div>
-</dd>
-<dt>500 Internal Server Error</dt>
-<dd><p class="first">When you are asking for a correct path, but the database doesn’t match, it returns a 500:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
-* Hostname was NOT found in DNS cache
-* Trying ::1...
-* connect to ::1 port 3000 failed: Connection refused
-* Trying 127.0.0.1...
-* Connected to localhost (127.0.0.1) port 3000 (#0)
-> GET /api/1.1/servers/hostname/jj/details.json HTTP/1.1
-> User-Agent: curl/7.37.1
-> Host: localhost:3000
-> Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;
-> Accept: application/json
->
-< HTTP/1.1 500 Internal Server Error
-* Server Mojolicious (Perl) is not blacklisted
-< Server: Mojolicious (Perl)
-< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
-< Content-Length: 93
-< Set-Cookie: mojolicious=eyJhdXRoX2RhdGEiOiJhZG1pbiIsImV4cGlyZXMiOjE0Mjk0MDQzMDZ9--1b08977e91f8f68b0ff5d5e5f6481c76ddfd0853; expires=Sun, 19 Apr 2015 00:45:06 GMT; path=/; HttpOnly
-< Content-Type: application/json
-< Date: Sat, 18 Apr 2015 20:45:06 GMT
-< Access-Control-Allow-Credentials: true
-< Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
-< Connection: keep-alive
-< Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
-< Access-Control-Allow-Origin: http://localhost:8080
-<
-* Connection #0 to host localhost left intact
-{"alerts":[{"level":"error","text":"An error occurred. Please contact your administrator."}]}
-[jvd@laika ~]$
-</pre></div>
-</div>
-<p class="last">The rest of the API documentation will only document the <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> case, where no errors have occured.</p>
-</dd>
-</dl>
-</div>
-<div class="section" id="traffic-ops-api-routes">
-<h3>Traffic Ops API Routes<a class="headerlink" href="#traffic-ops-api-routes" title="Permalink to this headline">¶</a></h3>
-<div class="toctree-wrapper compound">
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/routes.html">API Routes</a></li>
-</ul>
-</div>
-</div>
-<div class="section" id="api-1-1-reference">
-<h3>API 1.1 Reference<a class="headerlink" href="#api-1-1-reference" title="Permalink to this headline">¶</a></h3>
-<div class="toctree-wrapper compound">
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/asn.html">ASN</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/cachegroup.html">Cache Group</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/cdn.html">CDN</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/changelog.html">Change Logs</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/deliveryservice.html">Delivery Service</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/hwinfo.html">Hardware Info</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/parameter.html">Parameter</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/phys_location.html">Physical Location</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/profile.html">Profiles</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/region.html">Regions</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/role.html">Roles</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/server.html">Server</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/static_dns.html">Static DNS Entries</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/status.html">Status</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/system.html">System</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/to_extension.html">TO Extensions</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/type.html">Types</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v11/user.html">Users</a></li>
-</ul>
-</div>
-</div>
-<div class="section" id="api-1-2-reference">
-<h3>API 1.2 Reference<a class="headerlink" href="#api-1-2-reference" title="Permalink to this headline">¶</a></h3>
-<div class="toctree-wrapper compound">
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/api_capability.html">API-Capabilities</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/asn.html">ASN</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/cachegroup.html">Cache Group</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/cachegroup_parameter.html">Cache Group parameters</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/cache_stats.html">Cache Statistics</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/capability.html">Capabilities</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/cdn.html">CDN</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/changelog.html">Change Logs</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/configfiles_ats.html">/api/1.2/servers/:hostname/configfiles/ats</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/configfiles_ats.html#api-1-2-servers-hostname-configfiles-ats-configfile">/api/1.2/servers/:hostname/configfiles/ats/:configfile</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/configfiles_ats.html#api-1-2-profiles-profile-name-configfiles-ats-configfile">/api/1.2/profiles/:profile_name/configfiles/ats/:configfile</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/configfiles_ats.html#api-1-2-cdns-cdn-name-configfiles-ats-configfile">/api/1.2/cdns/:cdn_name/configfiles/ats/:configfile</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice.html">Delivery Service</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice_regex.html">Delivery Service Regexes</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/deliveryservice_stats.html">Delivery Service Statistics</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/division.html">Divisions</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/federation.html">Federation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/hwinfo.html">Hardware Info</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/job.html">Jobs</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/parameter.html">Parameter</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/phys_location.html">Physical Location</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/profile.html">Profiles</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/profile_parameter.html">Profile parameters</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/influxdb.html">InfluxDB</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/region.html">Regions</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/role.html">Roles</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/server.html">Server</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/static_dns.html">Static DNS Entries</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/status.html">Status</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/steering_target.html">Steering Targets</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/system.html">System</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/tenant.html">Tenants</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/to_extension.html">TO Extensions</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/type.html">Types</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/user.html">Users</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_ops_api/v12/topology.html">Snapshot CRConfig</a></li>
-</ul>
-</div>
+<p>To incorporate any custom Extensions during development set your PERL5LIB with any number of directories with the understanding that the PERL5LIB search order will come into play, so keep in mind that top-down is how your code will be located. Once Perl locates your custom route or Perl package/class it ‘pins’ on that class or Mojo Route and doesn’t look any further, which allows for the developer to <em>override</em> Traffic Ops functionality.</p>
</div>
</div>
</div>
@@ -854,7 +571,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="traffic_ops_api/routes.html" class="btn btn-neutral float-right" title="API Routes">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="traffic_portal.html" class="btn btn-neutral float-right" title="Traffic Portal">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="building.html" class="btn btn-neutral" title="Building Traffic Control"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -881,16 +598,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/development/traffic_portal.html b/docs/latest/development/traffic_portal.html
index 9ac8d69..47ffcd3 100644
--- a/docs/latest/development/traffic_portal.html
+++ b/docs/latest/development/traffic_portal.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Portal — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Portal — Traffic Control 2.2-dev documentation </title>
@@ -33,10 +35,13 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Developer’s Guide" href="index.html"/>
<link rel="next" title="Traffic Router" href="traffic_router.html"/>
- <link rel="prev" title="Snapshot CRConfig" href="traffic_ops_api/v12/topology.html"/>
+ <link rel="prev" title="Traffic Ops" href="traffic_ops.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Developer’s Guide</a> »</li>
+ <li><a href="index.html">Developer’s Guide</a> »</li>
<li>Traffic Portal</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/development/traffic_portal.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/development/traffic_portal.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -183,7 +197,7 @@
<a href="traffic_router.html" class="btn btn-neutral float-right" title="Traffic Router">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_ops_api/v12/topology.html" class="btn btn-neutral" title="Snapshot CRConfig"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="traffic_ops.html" class="btn btn-neutral" title="Traffic Ops"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -193,14 +207,14 @@
<h1>Traffic Portal<a class="headerlink" href="#traffic-portal" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
-<p>Traffic Portal is an <a class="reference external" href="https://angularjs.org/">AngularJS 1.x</a> client served from a <a class="reference external" href="https://nodejs.org/en/">Node.js</a> web server designed to consume the Traffic Ops 1.x API. Traffic Portal provides a set of functionality restricted to the delivery service(s) of the authenticated user. Functionality primarily includes a set of charts / graphs designed to provide insight into the performance of a user’s delivery service(s).</p>
+<p>Traffic Portal is an <a class="reference external" href="https://angularjs.org/">AngularJS 1.x</a> client served from a <a class="reference external" href="https://nodejs.org/en/">Node.js</a> web server designed to consume the Traffic Ops 1.x API. The Traffic Portal replaces the Traffic Ops UI.</p>
</div>
<div class="section" id="software-requirements">
<h2>Software Requirements<a class="headerlink" href="#software-requirements" title="Permalink to this headline">¶</a></h2>
<p>To work on Traffic Portal you need a *nix (MacOS and Linux are most commonly used) environment that has the following installed:</p>
<blockquote>
<div><ul class="simple">
-<li><a class="reference external" href="https://www.ruby-lang.org/en/">Ruby 2.0.x or above</a></li>
+<li><a class="reference external" href="https://www.rpmfind.net/linux/rpm2html/search.php?query=ruby-devel">Ruby Devel 2.0.x or above</a></li>
<li><a class="reference external" href="http://compass-style.org/">Compass 1.0.x or above</a></li>
<li><a class="reference external" href="https://nodejs.org/en/">Node.js 6.0.x or above</a></li>
<li><a class="reference external" href="https://nodejs.org/en/">Bower 1.7.9 or above</a></li>
@@ -223,17 +237,17 @@
<div><ul class="simple">
<li>Clone the traffic_control repository</li>
<li>Navigate to the traffic_control/traffic_portal of your cloned repository.</li>
-<li>Run <code class="docutils literal"><span class="pre">npm</span> <span class="pre">install</span></code> to install application dependencies. Only needs to be done the first time unless traffic_portal/package.json changes.</li>
-<li>Run <code class="docutils literal"><span class="pre">bower</span> <span class="pre">install</span></code> to install client-side dependencies. Only needs to be done the first time unless traffic_portal/bower.json changes.</li>
-<li>Run <code class="docutils literal"><span class="pre">grunt</span></code> to package the application into traffic_portal/app/dist, start a local http server (Express), and start a file watcher.</li>
-<li>Navigate to <a class="reference external" href="http://localhost:8080">http://localhost:8080</a></li>
+<li>Run <code class="docutils literal notranslate"><span class="pre">npm</span> <span class="pre">install</span></code> to install application dependencies into traffic_portal/node_modules. Only needs to be done the first time unless traffic_portal/package.json changes.</li>
+<li>Run <code class="docutils literal notranslate"><span class="pre">bower</span> <span class="pre">install</span></code> to install client-side dependencies into traffic_portal/app/bower_components. Only needs to be done the first time unless traffic_portal/bower.json changes.</li>
+<li>Run <code class="docutils literal notranslate"><span class="pre">grunt</span></code> to package the application into traffic_portal/app/dist, start a local https server (Express), and start a file watcher.</li>
+<li>Navigate to <a class="reference external" href="https://localhost:8443">https://localhost:8443</a></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="notes">
<h2>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
-<li>The Traffic Portal consumes the Traffic Ops API. By default, Traffic Portal assumes Traffic Ops is running on <a class="reference external" href="http://localhost:3000">http://localhost:3000</a>. Temporarily modify conf/config.js if you need to change the location of Traffic Ops.</li>
+<li>The Traffic Portal consumes the Traffic Ops API. By default, Traffic Portal assumes Traffic Ops is running on <a class="reference external" href="https://localhost:8444">https://localhost:8444</a>. Temporarily modify traffic_portal/conf/config.js if you need to change the location of Traffic Ops.</li>
</ul>
</div>
</div>
@@ -247,7 +261,7 @@
<a href="traffic_router.html" class="btn btn-neutral float-right" title="Traffic Router">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_ops_api/v12/topology.html" class="btn btn-neutral" title="Snapshot CRConfig"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="traffic_ops.html" class="btn btn-neutral" title="Traffic Ops"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -271,16 +285,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/development/traffic_router.html b/docs/latest/development/traffic_router.html
index 1f5ef22..261043c 100644
--- a/docs/latest/development/traffic_router.html
+++ b/docs/latest/development/traffic_router.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Router — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Router — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Developer’s Guide" href="index.html"/>
<link rel="next" title="Traffic Router API" href="traffic_router/traffic_router_api.html"/>
<link rel="prev" title="Traffic Portal" href="traffic_portal.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Developer’s Guide</a> »</li>
+ <li><a href="index.html">Developer’s Guide</a> »</li>
<li>Traffic Router</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/development/traffic_router.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/development/traffic_router.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -193,17 +207,16 @@
<h1>Traffic Router<a class="headerlink" href="#traffic-router" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
-<p>Traffic Router is a Java Tomcat application that routes clients to the closest available cache on the CDN using both HTTP and DNS. Cache availability is determined by Traffic Monitor; consequently Traffic Router polls Traffic Monitor for its configuration and cache health state information, and uses this data to make routing decisions. HTTP routing is performed by localizing the client based on the request’s source IP address (IPv4 or IPv6), and issues an HTTP 302 redirect to the nearest cache. HTTP routing utilizes consistent hashing on request URLs to optimize cache performance and request distribution. DNS routing is performed by localizing clients, resolvers in most cases, requesting <code class="docutils literal"><span class="pre">A</span></code> and <code class="docutils literal"><span class="pre">AAAA</span></code> records for a configurable name such as <code class="docutils literal"><span class="pre">edge.deliveryservice.somecdn.net</span></code>. Traffic Router is comprised of four separate Maven modules:</p>
-<blockquote>
-<div><ul class="simple">
-<li>api - Provides a simple JSON interface into certain aspects of core and is deployed as a WAR to a Service (read: connector/listen port) within Tomcat which is separate from core</li>
-<li>connector - A JAR that overrides Tomcat’s standard Http11Protocol Connector class and allows Traffic Router to delay opening listen sockets until it is in a state suitable for routing traffic</li>
+<p>Traffic Router is a Java Tomcat application that routes clients to the closest available cache on the CDN using both HTTP and DNS. Cache availability is determined by Traffic Monitor; consequently Traffic Router polls Traffic Monitor for its configuration and cache health state information, and uses this data to make routing decisions. HTTP routing is performed by localizing the client based on the request’s source IP address (IPv4 or IPv6), and issues an HTTP 302 redirect to the nearest cache. HTTP routing utilizes consistent hashing on request URLs to optimize cache performance and request distribution. DNS routing is performed by localizing clients, resolvers in most cases, requesting <code class="docutils literal notranslate"><span class="pre">A</span></code> and <code class="docutils literal notranslate"><span class="pre">AAAA</span></code> records for a configurable name such as <code class="docutils literal notranslate"><span class="pre">foo.deliveryservice.somecdn.net</span></code>. Traffic Router is comprised of seven separate Maven modules:</p>
+<ul class="simple">
+<li>shared - A reusable utility JAR for defining Delivery Service Certificates</li>
+<li>configuration - A resuable JAR defining the ConfigurationListener interface</li>
+<li>connector - A JAR that overrides Tomcat’s standard Http11Protocol Connector class and allows Traffic Router to delay opening listen sockets until it is in a state suitable for routing traffic</li>
<li>geolocation - Submodule for defining geolocation services</li>
-<li>testServer - A convenience server for easier manual testing of the API portion of Traffic Router on a development machine</li>
+<li>neustar - A Jar that provides a bean “neustarGeolocationService” that implements the GeolocationService interface defined in the geolocation maven submodule, which can optionally be added to the build of Traffic Router</li>
<li>core - Services DNS and HTTP requests, performs localization on routing requests, and is deployed as a WAR to a Service (read: connector/listen port) within Tomcat which is separate from api</li>
-<li>rpm - A simple Maven project which gathers the artifacts from the prior three modules and builds an RPM</li>
+<li>build - A simple Maven project which gathers the artifacts from the modules and builds an RPM</li>
</ul>
-</div></blockquote>
</div>
<div class="section" id="software-requirements">
<h2>Software Requirements<a class="headerlink" href="#software-requirements" title="Permalink to this headline">¶</a></h2>
@@ -211,74 +224,51 @@
<ul class="simple">
<li>Eclipse >= Kepler SR2 (or another Java IDE)</li>
<li>Maven >= 3.3.1</li>
-<li>JDK >= 6.0</li>
+<li>JDK >= 8.0</li>
</ul>
</div>
<div class="section" id="traffic-router-project-tree-overview">
<h2>Traffic Router Project Tree Overview<a class="headerlink" href="#traffic-router-project-tree-overview" title="Permalink to this headline">¶</a></h2>
<ul>
-<li><p class="first"><code class="docutils literal"><span class="pre">traffic_control/traffic_traffic_router/</span></code> - base directory for Traffic Router</p>
+<li><p class="first"><code class="docutils literal notranslate"><span class="pre">traffic_control/traffic_traffic_router/</span></code> - base directory for Traffic Router</p>
<blockquote>
<div><ul>
-<li><p class="first"><code class="docutils literal"><span class="pre">api/</span></code> - Source code for Traffic Router API, which is built as its own deployable WAR file and communicates with Traffic Router Core using JMX</p>
+<li><p class="first"><code class="docutils literal notranslate"><span class="pre">connector/</span></code> - Source code for Traffic Router Connector;</p>
+<blockquote>
+<div><ul class="simple">
+<li><code class="docutils literal notranslate"><span class="pre">src/main/java</span></code> - Java source directory for Traffic Router Connector</li>
+</ul>
+</div></blockquote>
+</li>
+<li><p class="first"><code class="docutils literal notranslate"><span class="pre">core/</span></code> - Source code for Traffic Router Core, which is built as its own deployable WAR file and communicates with Traffic Router API using JMX</p>
<blockquote>
<div><ul>
-<li><p class="first"><code class="docutils literal"><span class="pre">src/main</span></code> - Main source directory for Traffic Router API</p>
+<li><p class="first"><code class="docutils literal notranslate"><span class="pre">src/main</span></code> - Main source directory for Traffic Router Core</p>
<blockquote>
<div><ul class="simple">
-<li><code class="docutils literal"><span class="pre">java/</span></code> - Java source code for Traffic Router API</li>
-<li><code class="docutils literal"><span class="pre">resources/</span></code> - Spring resources pulled in during an RPM build</li>
-<li><code class="docutils literal"><span class="pre">webapp/</span></code> - Java webapp resources</li>
+<li><code class="docutils literal notranslate"><span class="pre">etc/init.d</span></code> - Init script for Tomcat</li>
+<li><code class="docutils literal notranslate"><span class="pre">conf/</span></code> - Minimum required configuration files</li>
+<li><code class="docutils literal notranslate"><span class="pre">java/</span></code> - Java source code for Traffic Router Core</li>
+<li><code class="docutils literal notranslate"><span class="pre">opt/tomcat/conf</span></code> - Contains Tomcat configuration file(s) pulled in during an RPM build</li>
+<li><code class="docutils literal notranslate"><span class="pre">resources/</span></code> - Resources pulled in during an RPM build</li>
+<li><code class="docutils literal notranslate"><span class="pre">scripts/</span></code> - Scripts used by the RPM build process</li>
+<li><code class="docutils literal notranslate"><span class="pre">webapp/</span></code> - Java webapp resources</li>
</ul>
</div></blockquote>
</li>
-<li><p class="first"><code class="docutils literal"><span class="pre">src/test</span></code> - Test source directory for Traffic Router API</p>
-<blockquote>
-<div><ul class="simple">
-<li><code class="docutils literal"><span class="pre">java/</span></code> - JUnit based unit tests for Traffic Router API</li>
-<li><code class="docutils literal"><span class="pre">resources/</span></code> - Resources pulled in by unit tests</li>
-</ul>
-</div></blockquote>
-</li>
-</ul>
-</div></blockquote>
-</li>
-<li><p class="first"><code class="docutils literal"><span class="pre">connector/</span></code> - Source code for Traffic Router Connector;</p>
-<blockquote>
-<div><ul class="simple">
-<li><code class="docutils literal"><span class="pre">src/main/java</span></code> - Java source directory for Traffic Router Connector</li>
-</ul>
-</div></blockquote>
-</li>
-<li><p class="first"><code class="docutils literal"><span class="pre">core/</span></code> - Source code for Traffic Router Core, which is built as its own deployable WAR file and communicates with Traffic Router API using JMX</p>
+<li><p class="first"><code class="docutils literal notranslate"><span class="pre">src/test</span></code> - Test source directory for Traffic Router Core</p>
<blockquote>
<div><ul>
-<li><p class="first"><code class="docutils literal"><span class="pre">src/main</span></code> - Main source directory for Traffic Router Core</p>
+<li><p class="first"><code class="docutils literal notranslate"><span class="pre">conf/</span></code> - Minimal Configuration files that make it possible to run junit tests</p>
+</li>
+<li><p class="first"><code class="docutils literal notranslate"><span class="pre">db/</span></code> - Files downloaded by unit tests</p>
+</li>
+<li><p class="first"><code class="docutils literal notranslate"><span class="pre">java/</span></code> - JUnit based unit tests for Traffic Router Core</p>
+</li>
+<li><p class="first"><code class="docutils literal notranslate"><span class="pre">resources/</span></code> - Example data files used by junit tests</p>
<blockquote>
<div><ul class="simple">
-<li><code class="docutils literal"><span class="pre">etc/init.d</span></code> - Init script for Tomcat</li>
-<li><code class="docutils literal"><span class="pre">conf/</span></code> - Minimum required configuration files</li>
-<li><code class="docutils literal"><span class="pre">java/</span></code> - Java source code for Traffic Router Core</li>
-<li><code class="docutils literal"><span class="pre">opt/tomcat/conf</span></code> - Contains Tomcat configuration file(s) pulled in during an RPM build</li>
-<li><code class="docutils literal"><span class="pre">resources/</span></code> - Resources pulled in during an RPM build</li>
-<li><code class="docutils literal"><span class="pre">scripts/</span></code> - Scripts used by the RPM build process</li>
-<li><code class="docutils literal"><span class="pre">webapp/</span></code> - Java webapp resources</li>
-</ul>
-</div></blockquote>
-</li>
-<li><p class="first"><code class="docutils literal"><span class="pre">src/test</span></code> - Test source directory for Traffic Router Core</p>
-<blockquote>
-<div><ul>
-<li><p class="first"><code class="docutils literal"><span class="pre">conf/</span></code> - Minimal Configuration files that make it possible to run junit tests</p>
-</li>
-<li><p class="first"><code class="docutils literal"><span class="pre">db/</span></code> - Files downloaded by unit tests</p>
-</li>
-<li><p class="first"><code class="docutils literal"><span class="pre">java/</span></code> - JUnit based unit tests for Traffic Router Core</p>
-</li>
-<li><p class="first"><code class="docutils literal"><span class="pre">resources/</span></code> - Example data files used by junit tests</p>
-<blockquote>
-<div><ul class="simple">
-<li><code class="docutils literal"><span class="pre">var/auto-zones</span></code> - BIND formatted zone files generated by Traffic Router Core during unit testing</li>
+<li><code class="docutils literal notranslate"><span class="pre">var/auto-zones</span></code> - BIND formatted zone files generated by Traffic Router Core during unit testing</li>
</ul>
</div></blockquote>
</li>
@@ -300,28 +290,32 @@
<div class="section" id="installing-the-developer-environment">
<h2>Installing The Developer Environment<a class="headerlink" href="#installing-the-developer-environment" title="Permalink to this headline">¶</a></h2>
<p>To install the Traffic Router Developer environment:</p>
-<ol class="arabic">
-<li><p class="first">Clone the traffic_control repository using Git.</p>
+<ol class="arabic simple">
+<li>Clone the traffic_control repository using Git.</li>
+<li>Change directories into <code class="docutils literal notranslate"><span class="pre">traffic_control/traffic_router</span></code>.</li>
+<li>Follow the instructions in “README.DNSSEC” for DNSSEC support.</li>
+<li>Set the environment variable TRAFFIC_MONITOR_HOSTS to be a semicolon delimited list of Traffic Monitors that can be accessed during integration tests</li>
+<li>Additional configuration is set using the below files:</li>
+</ol>
+<blockquote>
+<div><ul>
+<li><p class="first">core/src/test/conf/dns.properties - copy from core/src/main/conf</p>
</li>
-<li><p class="first">Change directories into <code class="docutils literal"><span class="pre">traffic_control/traffic_router</span></code>.</p>
+<li><p class="first">core/src/test/conf/http.properties - copy from core/src/main/conf</p>
</li>
-<li><p class="first">Follow the instructions in “README.DNSSEC” for DNSSEC support.</p>
+<li><p class="first">core/src/test/conf/log4j.properties - copy from core/src/main/conf</p>
</li>
-<li><p class="first">Set the environment variable TRAFFIC_MONITOR_HOSTS to be a semicolon delimited list of Traffic Monitors that can be accessed during integration tests</p>
+<li><p class="first">core/src/test/conf/traffic_monitor.properties - copy from core/src/main/conf</p>
</li>
-<li><dl class="first docutils">
-<dt>Additional configuration is set using the below files:</dt>
-<dd><ul class="first last">
-<li><p class="first">core/src/test/resources no longer exists</p>
-</li>
-<li><p class="first">core/src/test/conf/traffic_ops.properties file holds the credentials for accessing Traffic Ops.</p>
+<li><p class="first">core/src/test/conf/traffic_ops.properties file holds the credentials for accessing Traffic Ops. - copy from core/src/main/conf</p>
</li>
<li><p class="first">Default configuration values now reside in core/src/main/webapp/WEB-INF/applicationContext.xml</p>
</li>
<li><p class="first">The above values may be overridden by creating and/or modifying the property files listed in core/src/main/resources/applicationProperties.xml</p>
</li>
<li><p class="first">Pre-existing properties files are still honored by Traffic Router. For example traffic_monitor.properties:</p>
-<table border="1" class="docutils">
+<blockquote>
+<div><table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="75%" />
@@ -332,65 +326,70 @@
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">traffic_monitor.bootstrap.hosts</span></code></td>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">traffic_monitor.bootstrap.hosts</span></code></td>
<td>FQDN and port of the Traffic Monitor instance(s), separated by semicolons as necessary (do not include <a class="reference external" href="http://">http://</a>).</td>
</tr>
</tbody>
</table>
+</div></blockquote>
</li>
</ul>
-</dd>
-</dl>
-</li>
+</div></blockquote>
+<ol class="arabic" start="6">
<li><p class="first">Import the existing git repo into Eclipse:</p>
<blockquote>
<div><ol class="loweralpha simple">
<li>File -> Import -> Git -> Projects from Git; Next</li>
<li>Existing local repository; Next</li>
-<li>Add -> browse to find <code class="docutils literal"><span class="pre">traffic_control</span></code>; Open</li>
-<li>Select <code class="docutils literal"><span class="pre">traffic_control</span></code>; Next</li>
-<li>Ensure “Import existing projects” is selected, expand <code class="docutils literal"><span class="pre">traffic_control</span></code>, select <code class="docutils literal"><span class="pre">traffic_router</span></code>; Next</li>
-<li>Ensure <code class="docutils literal"><span class="pre">traffic_router_api</span></code>, <code class="docutils literal"><span class="pre">traffic_router_connector</span></code>, and <code class="docutils literal"><span class="pre">traffic_router_core</span></code> are checked; Finish (this step can take several minutes to complete)</li>
-<li>Ensure <code class="docutils literal"><span class="pre">traffic_router_api</span></code>, <code class="docutils literal"><span class="pre">traffic_router_connector</span></code>, and <code class="docutils literal"><span class="pre">traffic_router_core</span></code> have been opened by Eclipse after importing</li>
+<li>Add -> browse to find <code class="docutils literal notranslate"><span class="pre">traffic_control</span></code>; Open</li>
+<li>Select <code class="docutils literal notranslate"><span class="pre">traffic_control</span></code>; Next</li>
+<li>Ensure “Import existing projects” is selected, expand <code class="docutils literal notranslate"><span class="pre">traffic_control</span></code>, select <code class="docutils literal notranslate"><span class="pre">traffic_router</span></code>; Next</li>
+<li>Ensure <code class="docutils literal notranslate"><span class="pre">traffic_router_api</span></code>, <code class="docutils literal notranslate"><span class="pre">traffic_router_connector</span></code>, and <code class="docutils literal notranslate"><span class="pre">traffic_router_core</span></code> are checked; Finish (this step can take several minutes to complete)</li>
+<li>Ensure <code class="docutils literal notranslate"><span class="pre">traffic_router_api</span></code>, <code class="docutils literal notranslate"><span class="pre">traffic_router_connector</span></code>, and <code class="docutils literal notranslate"><span class="pre">traffic_router_core</span></code> have been opened by Eclipse after importing</li>
</ol>
</div></blockquote>
</li>
-<li><p class="first">From the terminal, run <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">verify</span></code> from the <code class="docutils literal"><span class="pre">traffic_router</span></code> directory</p>
+<li><p class="first">From the terminal, run <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">verify</span></code> from the <code class="docutils literal notranslate"><span class="pre">traffic_router</span></code> directory</p>
</li>
-<li><p class="first">Start the embedded Jetty instance for Core from within Eclipse</p>
+<li><p class="first">Start the embedded Tomcat instance for Core from within your IDE by following these steps:</p>
<blockquote>
<div><ol class="loweralpha">
-<li><p class="first">In the package explorer, expand <code class="docutils literal"><span class="pre">traffic_router_core</span></code></p>
+<li><p class="first">In the package explorer, expand <code class="docutils literal notranslate"><span class="pre">traffic_router_core</span></code></p>
</li>
-<li><p class="first">Expand <code class="docutils literal"><span class="pre">src/test/java</span></code></p>
+<li><p class="first">Expand <code class="docutils literal notranslate"><span class="pre">src/test/java</span></code></p>
</li>
-<li><p class="first">Expand the package <code class="docutils literal"><span class="pre">com.comcast.cdn.traffic_control.traffic_router.core</span></code></p>
+<li><p class="first">Expand the package <code class="docutils literal notranslate"><span class="pre">com.comcast.cdn.traffic_control.traffic_router.core</span></code></p>
</li>
-<li><p class="first">Open and run <code class="docutils literal"><span class="pre">TrafficRouterStart.java</span></code></p>
+<li><p class="first">Open and run <code class="docutils literal notranslate"><span class="pre">TrafficRouterStart.java</span></code></p>
<blockquote>
<div><div class="admonition note">
<p class="first admonition-title">Note</p>
-<p class="last">If an error is displayed in the Console, run <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">verify</span></code> from the <code class="docutils literal"><span class="pre">traffic_router</span></code> directory</p>
+<p class="last">If an error is displayed in the Console, run <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">verify</span></code> from the <code class="docutils literal notranslate"><span class="pre">traffic_router</span></code> directory</p>
</div>
</div></blockquote>
</li>
</ol>
</div></blockquote>
</li>
-<li><p class="first">Traffic Router Core should now be running; the HTTP routing interface is available on <a class="reference external" href="http://localhost:8081">http://localhost:8081</a>, while HTTPS is available on <a class="reference external" href="http://localhost:8443">http://localhost:8443</a>. The DNS server and routing interface is available on localhost:1053 via TCP and UDP.</p>
-</li>
</ol>
+<p>9. Traffic Router Core should now be running; the Traffic Router API is available at <a class="reference external" href="http://localhost:3333">http://localhost:3333</a>, the HTTP routing interface is available on <a class="reference external" href="http://localhost:8888">http://localhost:8888</a> and HTTPS is available on <a class="reference external" href="http://localhost:8443">http://localhost:8443</a>.
+The DNS server and routing interface is available on localhost:1053 via TCP and UDP.</p>
+</div>
+<div class="section" id="manual-testing">
+<h2>Manual Testing<a class="headerlink" href="#manual-testing" title="Permalink to this headline">¶</a></h2>
+<p>Look up the URL for your test ‘http’ Delivery Service in Traffic Ops and then:</p>
+<p>curl -vs -H “Host: <Delivery Service URL>” <a class="reference external" href="http://localhost:8888/x">http://localhost:8888/x</a></p>
</div>
<div class="section" id="test-cases">
<h2>Test Cases<a class="headerlink" href="#test-cases" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
-<li>Unit tests can be executed using Maven by running <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">test</span></code> at the root of the <code class="docutils literal"><span class="pre">traffic_router</span></code> project.</li>
-<li>Unit and Integration tests can be executed using Maven by running <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">verify</span></code> at the root of the <code class="docutils literal"><span class="pre">traffic_router</span></code> project.</li>
+<li>Unit tests can be executed using Maven by running <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">test</span></code> at the root of the <code class="docutils literal notranslate"><span class="pre">traffic_router</span></code> project.</li>
+<li>Unit and Integration tests can be executed using Maven by running <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">verify</span></code> at the root of the <code class="docutils literal notranslate"><span class="pre">traffic_router</span></code> project.</li>
</ul>
</div>
<div class="section" id="rpm-packaging">
<h2>RPM Packaging<a class="headerlink" href="#rpm-packaging" title="Permalink to this headline">¶</a></h2>
-<p>Running <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">package</span></code> on a Linux based distribution will trigger the build process to create the Traffic Router rpm.</p>
+<p>Running <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">package</span></code> on a Linux based distribution will trigger the build process to create the Traffic Router rpm.</p>
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
@@ -433,16 +432,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/development/traffic_router/traffic_router_api.html b/docs/latest/development/traffic_router/traffic_router_api.html
index 48814ae..050a11a 100644
--- a/docs/latest/development/traffic_router/traffic_router_api.html
+++ b/docs/latest/development/traffic_router/traffic_router_api.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Router API — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Router API — Traffic Control 2.2-dev documentation </title>
@@ -33,9 +35,12 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/>
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/>
<link rel="up" title="Traffic Router" href="../traffic_router.html"/>
- <link rel="next" title="Traffic Monitor" href="../traffic_monitor.html"/>
+ <link rel="next" title="Traffic Monitor Golang" href="../traffic_monitor.html"/>
<link rel="prev" title="Traffic Router" href="../traffic_router.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,16 +178,16 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="../index.html">Developer’s Guide</a> »</li>
+ <li><a href="../index.html">Developer’s Guide</a> »</li>
<li><a href="../traffic_router.html">Traffic Router</a> »</li>
<li>Traffic Router API</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/development/traffic_router/traffic_router_api.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/development/traffic_router/traffic_router_api.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -182,7 +196,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor Golang">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../traffic_router.html" class="btn btn-neutral" title="Traffic Router"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -198,7 +212,7 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p><strong>/crs/stats/ip/:ipaddress</strong></p>
+<p><strong>/crs/stats/ip/<ipaddress></strong></p>
<p>Geolocation information for an IPv4 or IPv6 address.</p>
<div class="line-block">
<div class="line"><br /></div>
@@ -213,8 +227,43 @@
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p>/crs/locations/:location/caches</p>
+<p><strong>/crs/locations/<location>/caches</strong></p>
<p>A list of caches for this cache group only.</p>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>/crs/consistenthash/cache/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath></strong></p>
+<p>The resulting cache of the consistent hash using coverage zone file for a given client IP, delivery service, and request path.</p>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>/crs/consistenthash/cache/deep/coveragezone/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath></strong></p>
+<p>The resulting cache of the consistent hash using deep coverage zone file (deep caching) for a given client IP, delivery service, and request path.</p>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>/crs/consistenthash/cache/geolocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath></strong></p>
+<p>The resulting cache of the consistent hash using geolocation for a given client IP, delivery service, and request path.</p>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>/crs/consistenthash/deliveryservice/?deliveryServiceId=<deliveryServiceId>&requestPath=<requestPath></strong></p>
+<p>The resulting delivery service of the consistent hash for a given delivery service and request path – used to test steering delivery services.</p>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>/crs/coveragezone/caches/?deliveryServiceId=<deliveryServiceId>&cacheLocationId=<cacheLocationId></strong></p>
+<p>A list of caches for a given delivery service and cache location.</p>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>/crs/coveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId></strong></p>
+<p>The resulting cache location for a given client IP and delivery service.</p>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>/crs/deepcoveragezone/cachelocation/?ip=<ip>&deliveryServiceId=<deliveryServiceId></strong></p>
+<p>The resulting cache location using deep coverage zone file (deep caching) for a given client IP and delivery service.</p>
</div>
@@ -223,7 +272,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="../traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor Golang">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../traffic_router.html" class="btn btn-neutral" title="Traffic Router"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -250,16 +299,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
diff --git a/docs/latest/development/traffic_stats.html b/docs/latest/development/traffic_stats.html
index 9839e27..2e87dc7 100644
--- a/docs/latest/development/traffic_stats.html
+++ b/docs/latest/development/traffic_stats.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Stats — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Stats — Traffic Control 2.2-dev documentation </title>
@@ -33,10 +35,13 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Developer’s Guide" href="index.html"/>
- <link rel="next" title="Traffic Server" href="traffic_server.html"/>
- <link rel="prev" title="Traffic Monitor Golang" href="traffic_monitor_golang.html"/>
+ <link rel="next" title="APIs" href="../api/index.html"/>
+ <link rel="prev" title="Traffic Monitor APIs" href="traffic_monitor/traffic_monitor_api.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
- <li><a href="index.html">Developer’s Guide</a> »</li>
+ <li><a href="index.html">Developer’s Guide</a> »</li>
<li>Traffic Stats</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/development/traffic_stats.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/development/traffic_stats.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -180,10 +194,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="traffic_server.html" class="btn btn-neutral float-right" title="Traffic Server">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../api/index.html" class="btn btn-neutral float-right" title="APIs">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_monitor_golang.html" class="btn btn-neutral" title="Traffic Monitor Golang"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="traffic_monitor/traffic_monitor_api.html" class="btn btn-neutral" title="Traffic Monitor APIs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -193,7 +207,7 @@
<h1>Traffic Stats<a class="headerlink" href="#traffic-stats" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
-<p>Traffic Stats is a utility written in <a class="reference external" href="http.golang.org">Go</a> that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor’s JSON APIs and stores the data in <a class="reference external" href="http://influxdb.com">InfluxDb</a>. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by <a class="reference external" href="http://grafana.org">Grafana</a> which are linked from Traffic Ops. Traffic Stats also calculates daily statistics from InfluxDb and stores them in the Traffic Ops database.</p>
+<p>Traffic Stats is a utility written in <a class="reference external" href="http.golang.org">Go</a> that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor’s JSON APIs and stores the data in <a class="reference external" href="http://influxdb.com">InfluxDb</a>. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by <a class="reference external" href="http://grafana.org">Grafana</a> which are linked from Traffic Ops. Traffic Stats also calculates daily statistics from InfluxDb and stores them in the Traffic Ops database.</p>
</div>
<div class="section" id="software-requirements">
<h2>Software Requirements<a class="headerlink" href="#software-requirements" title="Permalink to this headline">¶</a></h2>
@@ -228,10 +242,10 @@
<div><ul class="simple">
<li>Clone the traffic_control repository using Git into a location accessible by your $GOPATH</li>
<li>Navigate to the traffic_ops/client directory of your cloned repository. (This is the directory containing Traffic Ops client code used by Traffic Stats)</li>
-<li>From the traffic_ops/client directory run <code class="docutils literal"><span class="pre">go</span> <span class="pre">test</span></code> to test the client code. This will run all unit tests for the client and return the results. If there are missing dependencies you will need to run <code class="docutils literal"><span class="pre">go</span> <span class="pre">get</span> <span class="pre"><dependency</span> <span class="pre">name></span></code> to get the dependency</li>
-<li>Once the tests pass, run <code class="docutils literal"><span class="pre">go</span> <span class="pre">install</span></code> to build and install the Traffic Ops client package. This makes it accessible to Traffic Stats.</li>
+<li>From the traffic_ops/client directory run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">test</span></code> to test the client code. This will run all unit tests for the client and return the results. If there are missing dependencies you will need to run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">get</span> <span class="pre"><dependency</span> <span class="pre">name></span></code> to get the dependency</li>
+<li>Once the tests pass, run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">install</span></code> to build and install the Traffic Ops client package. This makes it accessible to Traffic Stats.</li>
<li>Navigate to your cloned repo under Traffic Stats</li>
-<li>Run <code class="docutils literal"><span class="pre">go</span> <span class="pre">build</span> <span class="pre">traffic_stats.go</span></code> to build traffic_stats. You will need to run <code class="docutils literal"><span class="pre">go</span> <span class="pre">get</span></code> for any missing dependencies.</li>
+<li>Run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">build</span> <span class="pre">traffic_stats.go</span></code> to build traffic_stats. You will need to run <code class="docutils literal notranslate"><span class="pre">go</span> <span class="pre">get</span></code> for any missing dependencies.</li>
</ul>
</div></blockquote>
</div>
@@ -248,10 +262,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="traffic_server.html" class="btn btn-neutral float-right" title="Traffic Server">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="../api/index.html" class="btn btn-neutral float-right" title="APIs">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_monitor_golang.html" class="btn btn-neutral" title="Traffic Monitor Golang"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="traffic_monitor/traffic_monitor_api.html" class="btn btn-neutral" title="Traffic Monitor APIs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -275,16 +289,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/faq/administration.html b/docs/latest/faq/administration.html
index 7cbe777..d40fd20 100644
--- a/docs/latest/faq/administration.html
+++ b/docs/latest/faq/administration.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Running a Traffic Control CDN — Traffic Control 2.1-dev documentation </title>
+ <title>Running a Traffic Control CDN — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="FAQ" href="index.html"/>
<link rel="next" title="Glossary" href="../glossary.html"/>
<link rel="prev" title="Development" href="development.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">FAQ</a> »</li>
<li>Running a Traffic Control CDN</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/faq/administration.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/faq/administration.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -191,91 +205,98 @@
<div class="section" id="running-a-traffic-control-cdn">
<h1>Running a Traffic Control CDN<a class="headerlink" href="#running-a-traffic-control-cdn" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="why-is-my-crconfig-json-rejected">
-<h2>Why is my CRConfig.json rejected?<a class="headerlink" href="#why-is-my-crconfig-json-rejected" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="cache-group">
+<span id="rl-cachegroup"></span><h2>Cache Group<a class="headerlink" href="#cache-group" title="Permalink to this headline">¶</a></h2>
<blockquote>
-<div><p>Especially in version 1.1.0, there’s a number of manual steps that need to be done after the initial install. Make sure that after the initial install, you perform these steps in order:</p>
+<div><p>A cache group is a logical group of caches that Traffic Router tries to use as a combined cache. Traffic Router treats all servers in a cache group as though they are in the same physical location, though they are in fact only in the same region (network). A cache group has one single set of geographical coordinates even if the caches that make up the cache group are in different physical locations. The caches in a cache group are not aware of the other caches in the group - there is no clustering software or communications between caches in a cache group.</p>
+<p>There are two types of cache groups: EDGE and MID. Traffic Control is a two tier system, where the clients get directed to the EDGE cache group. On cache miss, the cache in the EDGE cache group obtains content from a MID cache group, rather than the origin, which is shared with multiple EDGEs. EDGE cache groups are configured to have one single parent cache group.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Often the EDGE to MID relationship is based on network distance, and does not necessarily match the geographic distance.</p>
+</div>
+<p>A cache group serves a particular part of the network as defined in the coverage zone file. See <a class="reference internal" href="../admin/traffic_ops/using.html#rl-asn-czf"><span class="std std-ref">The Coverage Zone File and ASN Table</span></a>.</p>
+<p>Consider the example CDN below:</p>
+<img alt="../_images/cache_groups_1.png" class="align-center" src="../_images/cache_groups_1.png" />
+<p>There are two MID tier cache groups, each assigned with three EDGEs. The lax, den and chi EDGE locations are configured with the West MID as their parent, and the nyc, phl, and hou EDGEs, are configured with the East MID as their parent. On a cache miss, the EDGEs use their assigned parent.</p>
+</div></blockquote>
+<p>All caches (and other servers) are assigned a Profile in Traffic Ops.</p>
+</div>
+<div class="section" id="profile">
+<span id="rl-profile"></span><h2>Profile<a class="headerlink" href="#profile" title="Permalink to this headline">¶</a></h2>
+<blockquote>
+<div>A Profile is a set of configuration settings and parameters, applied to a server or deliveryservice. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings, and bundled into groups using Profiles. Traffic Ops allows for duplication, comparison, import and export of Profiles.</div></blockquote>
+<div class="section" id="why-is-my-crconfig-json-rejected">
+<h3>Why is my CRConfig.json rejected?<a class="headerlink" href="#why-is-my-crconfig-json-rejected" title="Permalink to this headline">¶</a></h3>
+<blockquote>
+<div><p>Especially in version 1.1.0, there’s a number of manual steps that need to be done after the initial install. Make sure that after the initial install, you perform these steps in order:</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Even though Traffic Ops allows you to enter the servers with no IPv6 address information, the CRConfig will not be accepted by Traffic Router without IPv6 address information for at least Traffic Router and Traffic Monitor. Traffic Control assumes in a lot of places that all servers have at least an IPv4 and an IPv6 address. If you are not using IPv6, it is best to enter dummy addresses for all server types, and turn IPv6 off in all delivery services. (<a class="reference external" href="https://github.com/Comcast/traffic_control/issues/44">https://github.com/Comcast/traffic_control/issues/44</a>).</p>
</div>
-<ul>
+<ul class="simple">
<li><dl class="first docutils">
<dt>Add users</dt>
-<dd><p class="first last">Not necessarily needed for getting your CRConfig accepted, but always a good idea.</p>
-</dd>
+<dd>Not necessarily needed for getting your CRConfig accepted, but always a good idea.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add Divisions</dt>
-<dd><p class="first last">You will need at least one.</p>
-</dd>
+<dd>You will need at least one.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add Regions</dt>
-<dd><p class="first last">You will need at least one.</p>
-</dd>
+<dd>You will need at least one.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add Physical Locations</dt>
-<dd><p class="first last">You will need at least one.</p>
-</dd>
+<dd>You will need at least one.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add Mid tier Cache Groups</dt>
-<dd><p class="first last">You will need at least one.</p>
-</dd>
+<dd>You will need at least one.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add Edge tier Cache Groups</dt>
-<dd><p class="first last">You will need at least one.</p>
-</dd>
+<dd>You will need at least one.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add Traffic Monitors</dt>
-<dd><p class="first last">You will need to enter at least one Traffic Monitor - make sure to change the server status to <em>ONLINE</em>.</p>
-</dd>
+<dd>You will need to enter at least one Traffic Monitor - make sure to change the server status to <em>ONLINE</em>.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add Traffic Routers</dt>
-<dd><p class="first last">You will need to enter at least one Traffic Router - make sure to change the server status to <em>ONLINE</em>.</p>
-</dd>
+<dd>You will need to enter at least one Traffic Router - make sure to change the server status to <em>ONLINE</em>.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add Edges</dt>
-<dd><p class="first last">You will need at least one edge cache to make Traffic Router accept the CRConfig.</p>
-</dd>
+<dd>You will need at least one edge cache to make Traffic Router accept the CRConfig.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add Mid</dt>
-<dd><p class="first last">Technically you don’t need a mid tier, but if you have one, best to enter the info before continuing.</p>
-</dd>
+<dd>Technically you don’t need a mid tier, but if you have one, best to enter the info before continuing.</dd>
</dl>
</li>
<li><dl class="first docutils">
-<dt>Change the <code class="docutils literal"><span class="pre">polling.url</span></code> parameters to reflect your CDN</dt>
-<dd><p class="first last">Set where to get the coverage zone map, and the geo IP database.</p>
-</dd>
+<dt>Change the <code class="docutils literal notranslate"><span class="pre">polling.url</span></code> parameters to reflect your CDN</dt>
+<dd>Set where to get the coverage zone map, and the geo IP database.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Create at least one delivery service, and assign at least one edge cache in REPORTED state to it.</dt>
-<dd><p class="first last">Even if it is a dummy DS, without a single DS, the CRConfig will not be accepted by Traffic Router.</p>
-</dd>
+<dd>Even if it is a dummy DS, without a single DS, the CRConfig will not be accepted by Traffic Router.</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Snapshot CRConfig</dt>
-<dd><p class="first last"><strong>Tools > Snapshot CRConfig</strong> diff, and write.</p>
-</dd>
+<dd><strong>Tools > Snapshot CRConfig</strong> diff, and write.</dd>
</dl>
</li>
</ul>
@@ -283,6 +304,7 @@
</div></blockquote>
</div>
</div>
+</div>
</div>
@@ -317,16 +339,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/faq/development.html b/docs/latest/faq/development.html
index 2d54dc9..079f584 100644
--- a/docs/latest/faq/development.html
+++ b/docs/latest/faq/development.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Development — Traffic Control 2.1-dev documentation </title>
+ <title>Development — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="FAQ" href="index.html"/>
<link rel="next" title="Running a Traffic Control CDN" href="administration.html"/>
<link rel="prev" title="General" href="general.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">FAQ</a> »</li>
<li>Development</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/faq/development.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/faq/development.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -231,16 +245,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/faq/general.html b/docs/latest/faq/general.html
index bc0e183..a11c711 100644
--- a/docs/latest/faq/general.html
+++ b/docs/latest/faq/general.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>General — Traffic Control 2.1-dev documentation </title>
+ <title>General — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="FAQ" href="index.html"/>
<link rel="next" title="Development" href="development.html"/>
<link rel="prev" title="FAQ" href="index.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">FAQ</a> »</li>
<li>General</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/faq/general.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/faq/general.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -196,7 +210,7 @@
<blockquote>
<div><dl class="docutils">
<dt><a class="reference external" href="http://www.comcast.com/">Comcast Cable</a></dt>
-<dd>Comcast is the original developer of Traffic Control and is using it for all it’s IP video delivery, delivering images and software to it’s X1 platform, and for <a class="reference external" href="https://www.comcastwholesale.com/products-services/content-delivery-network">delivering third party content</a> to it’s footprint.</dd>
+<dd>Comcast is the original developer of Traffic Control and is using it for all it’s IP video delivery, delivering images and software to it’s X1 platform, and for <a class="reference external" href="https://www.comcastwholesale.com/products-services/content-delivery-network">delivering third party content</a> to it’s footprint.</dd>
</dl>
<p><a class="reference external" href="http://www.cox.com/">Cox Communications</a></p>
<dl class="docutils">
@@ -206,6 +220,10 @@
<dd>Concurrent has a product that uses Traffic Control, see their <a class="reference external" href="https://github.com/concurrentlabs/laguna">github page</a> for more info.</dd>
</dl>
<p><a class="reference external" href="http://www.qubee.com.pk">Augere Pakistan / QUBEE</a></p>
+<dl class="docutils">
+<dt><a class="reference external" href="https://www.qwilt.com/">Qwilt</a></dt>
+<dd>Qwilt has a product called <a class="reference external" href="https://qwilt.com/solutions/edge-cloud-cdn/">Open Edge CDN</a> that is based on Traffic Control.</dd>
+</dl>
</div></blockquote>
</div>
<div class="section" id="how-do-i-get-help-with-traffic-control">
@@ -226,7 +244,7 @@
<div class="section" id="what-is-twelve-monkeys">
<h2>What is Twelve Monkeys?<a class="headerlink" href="#what-is-twelve-monkeys" title="Permalink to this headline">¶</a></h2>
<blockquote>
-<div>Twelve Monkeys was the the original internal name for Traffic Ops. You will sometimes still see this name in the source, or in older documents. It’s also a good movie.</div></blockquote>
+<div>Twelve Monkeys was the the original internal name for Traffic Ops. You will sometimes still see this name in the source, or in older documents. It’s also a good movie.</div></blockquote>
</div>
<div class="section" id="what-license-is-traffic-control-released-under">
<h2>What license is Traffic Control released under?<a class="headerlink" href="#what-license-is-traffic-control-released-under" title="Permalink to this headline">¶</a></h2>
@@ -268,16 +286,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/faq/index.html b/docs/latest/faq/index.html
index b075434..9ed2ce9 100644
--- a/docs/latest/faq/index.html
+++ b/docs/latest/faq/index.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>FAQ — Traffic Control 2.1-dev documentation </title>
+ <title>FAQ — Traffic Control 2.2-dev documentation </title>
@@ -33,9 +35,12 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="next" title="General" href="general.html"/>
- <link rel="prev" title="Traffic Server" href="../development/traffic_server.html"/>
+ <link rel="prev" title="Origin" href="../api/v13/origin.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -94,21 +99,22 @@
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -119,15 +125,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -163,12 +177,12 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li>FAQ</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/faq/index.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/faq/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -180,7 +194,7 @@
<a href="general.html" class="btn btn-neutral float-right" title="General">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../development/traffic_server.html" class="btn btn-neutral" title="Traffic Server"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="../api/v13/origin.html" class="btn btn-neutral" title="Origin"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -205,7 +219,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="administration.html">Running a Traffic Control CDN</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="administration.html#why-is-my-crconfig-json-rejected">Why is my CRConfig.json rejected?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="administration.html#cache-group">Cache Group</a></li>
+<li class="toctree-l2"><a class="reference internal" href="administration.html#profile">Profile</a></li>
</ul>
</li>
</ul>
@@ -221,7 +236,7 @@
<a href="general.html" class="btn btn-neutral float-right" title="General">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="../development/traffic_server.html" class="btn btn-neutral" title="Traffic Server"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="../api/v13/origin.html" class="btn btn-neutral" title="Origin"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -245,16 +260,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/genindex.html b/docs/latest/genindex.html
index 01d091c..5388bb2 100644
--- a/docs/latest/genindex.html
+++ b/docs/latest/genindex.html
@@ -1,6 +1,8 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -8,7 +10,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Index — Traffic Control 2.1-dev documentation </title>
+ <title>Index — Traffic Control 2.2-dev documentation </title>
@@ -34,7 +36,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="index.html"/>
+ <link rel="index" title="Index"
+ href="#"/>
+ <link rel="search" title="Search" href="search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="index.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -93,21 +98,22 @@
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -118,15 +124,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -162,9 +176,9 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="index.html">Traffic Control 2.2-dev</a> »</li>
- <li></li>
+ <li>Index</li>
<li class="wy-breadcrumbs-aside">
</li>
@@ -200,380 +214,258 @@
</div>
<h2 id="Symbols">Symbols</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-traffic-ops-extension"><strong>(traffic ops) extension</strong></a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-302-content-routing"><strong>302 content routing</strong></a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-traffic-ops-extension"><strong>(traffic ops) extension</strong></a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-302-content-routing"><strong>302 content routing</strong></a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-astats-stats-over-http"><strong>astats (stats_over_http)</strong></a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-astats-stats-over-http"><strong>astats (stats_over_http)</strong></a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-3">Bulk Upload Server</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-3">Bulk Upload Server</a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-cache"><strong>cache</strong></a>
- </dt>
-
-
- <dt><a href="basics/cache_revalidation.html#index-0">Cache Control Header</a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/using.html#index-12">Cache Updates</a>
- </dt>
-
-
- <dt><a href="glossary.html#term-cachegroup"><strong>cachegroup</strong></a>
- </dt>
-
-
- <dt><a href="basics/content_delivery_networks.html#index-0">CDN</a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/using.html#index-1">Change Log</a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-consistent-hashing"><strong>consistent hashing</strong></a>
- </dt>
-
-
- <dt><a href="basics/content_delivery_networks.html#index-0">Content Delivery Network</a>
- </dt>
-
-
- <dt><a href="overview/traffic_router.html#index-1">Content Routing</a>
- </dt>
-
-
- <dt><a href="glossary.html#term-content-routing"><strong>content routing</strong></a>
- </dt>
-
-
- <dt><a href="glossary.html#term-coverage-zone-map"><strong>coverage zone map</strong></a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-cache"><strong>cache</strong></a>
+</li>
+ <li><a href="basics/cache_revalidation.html#index-0">Cache Control Header</a>
+</li>
+ <li><a href="admin/traffic_ops/using.html#index-12">Cache Updates</a>
+</li>
+ <li><a href="glossary.html#term-cachegroup"><strong>cachegroup</strong></a>
+</li>
+ <li><a href="basics/content_delivery_networks.html#index-0">CDN</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-1">Change Log</a>
+</li>
+ <li><a href="glossary.html#term-consistent-hashing"><strong>consistent hashing</strong></a>
+</li>
+ <li><a href="basics/content_delivery_networks.html#index-0">Content Delivery Network</a>
+</li>
+ <li><a href="overview/traffic_router.html#index-1">Content Routing</a>
+</li>
+ <li><a href="glossary.html#term-content-routing"><strong>content routing</strong></a>
+</li>
+ <li><a href="glossary.html#term-coverage-zone-map"><strong>coverage zone map</strong></a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-delivery-service"><strong>delivery service</strong></a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/using.html#index-8">Delivery Service regexp</a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-4">Delivery Service Type</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-delivery-service"><strong>delivery service</strong></a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-8">Delivery Service regexp</a>
+</li>
+ <li><a href="admin/traffic_ops/using.html#index-4">Delivery Service Type</a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-edge-tier-or-cache"><strong>edge (tier or cache)</strong></a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-2">Edge Health</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-edge-tier-or-cache"><strong>edge (tier or cache)</strong></a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-2">Edge Health</a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="basics/caching_proxies.html#index-1">Forward Proxy</a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-forward-proxy"><strong>forward proxy</strong></a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="basics/caching_proxies.html#index-1">Forward Proxy</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-forward-proxy"><strong>forward proxy</strong></a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-11">Generate ISO</a>
- </dt>
-
-
- <dt><a href="glossary.html#term-geo-localization-or-geo-routing"><strong>geo localization or geo routing</strong></a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/configuration.html#index-0">Global Profile</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-11">Generate ISO</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-geo-localization-or-geo-routing"><strong>geo localization or geo routing</strong></a>
+</li>
+ <li><a href="admin/traffic_ops/configuration.html#index-0">Global Profile</a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-5">Header Rewrite</a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/using.html#index-8">HEADER_REGEXP</a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/using.html#index-2">Health</a>
- </dt>
-
-
- <dt><a href="glossary.html#term-health-protocol"><strong>health protocol</strong></a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/using.html#index-0">Health Tab</a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-8">HOST_REGEXP</a>
- </dt>
-
-
- <dt><a href="basics/http_11.html#index-0">HTTP</a>
- </dt>
-
-
- <dt><a href="basics/cache_revalidation.html#index-0">HTTP 304</a>
- </dt>
-
-
- <dt><a href="basics/http_11.html#index-0">http/1.1</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-5">Header Rewrite</a>
+</li>
+ <li><a href="admin/traffic_ops/using.html#index-8">HEADER_REGEXP</a>
+</li>
+ <li><a href="admin/traffic_ops/using.html#index-2">Health</a>
+</li>
+ <li><a href="glossary.html#term-health-protocol"><strong>health protocol</strong></a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-0">Health Tab</a>
+</li>
+ <li><a href="admin/traffic_ops/using.html#index-8">HOST_REGEXP</a>
+</li>
+ <li><a href="basics/http_11.html#index-0">HTTP</a>
+</li>
+ <li><a href="basics/cache_revalidation.html#index-0">HTTP 304</a>
+</li>
+ <li><a href="basics/http_11.html#index-0">http/1.1</a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-14">Invalidate Content</a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-11">ISO</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-14">Invalidate Content</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-11">ISO</a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-localization"><strong>localization</strong></a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="basics/content_delivery_networks.html#index-0">Log File Analysis</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-localization"><strong>localization</strong></a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="basics/content_delivery_networks.html#index-0">Log File Analysis</a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-mid-tier-or-cache"><strong>mid (tier or cache)</strong></a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-mid-tier-or-cache"><strong>mid (tier or cache)</strong></a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-origin"><strong>origin</strong></a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-origin"><strong>origin</strong></a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-parent-cache-or-cachegroup"><strong>parent (cache or cachegroup)</strong></a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/using.html#index-8">PATH_REGEXP</a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="glossary.html#term-profile"><strong>profile</strong></a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/using.html#index-14">Purge</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-parent-cache-or-cachegroup"><strong>parent (cache or cachegroup)</strong></a>
+</li>
+ <li><a href="admin/traffic_ops/using.html#index-8">PATH_REGEXP</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="glossary.html#term-profile"><strong>profile</strong></a>
+</li>
+ <li><a href="admin/traffic_ops/using.html#index-14">Purge</a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-12">Queue Updates</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-12">Queue Updates</a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-7">Regex Remap Expression</a>
- </dt>
-
-
- <dt><a href="basics/cache_revalidation.html#index-0">Revalidation</a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="basics/caching_proxies.html#index-0">Reverse Proxy</a>
- </dt>
-
-
- <dt><a href="glossary.html#term-reverse-proxy"><strong>reverse proxy</strong></a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-7">Regex Remap Expression</a>
+</li>
+ <li><a href="basics/cache_revalidation.html#index-0">Revalidation</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="basics/caching_proxies.html#index-0">Reverse Proxy</a>
+</li>
+ <li><a href="glossary.html#term-reverse-proxy"><strong>reverse proxy</strong></a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-10">Server Assignments</a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/using.html#index-6">Signed URLs</a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-13">Snapshot CRConfig</a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/using.html#index-9">Static DNS Entries</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-10">Server Assignments</a>
+</li>
+ <li><a href="admin/traffic_ops/using.html#index-6">Signed URLs</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-13">Snapshot CRConfig</a>
+</li>
+ <li><a href="admin/traffic_ops/using.html#index-9">Static DNS Entries</a>
+</li>
+ </ul></td>
</tr></table>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/using.html#index-6">Token Based Authentication</a>
- </dt>
-
-
- <dt><a href="overview/traffic_monitor.html#index-0">Traffic Monitor - Overview</a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/default_profiles.html#index-0">Traffic Ops - Default Profiles</a>
- </dt>
-
-
- <dt><a href="admin/traffic_ops/installation.html#index-0">Traffic Ops - Installing</a>
- </dt>
-
- </dl></td>
- <td style="width: 33%" valign="top"><dl>
-
- <dt><a href="admin/traffic_ops/migration_from_10_to_20.html#index-0">Traffic Ops - Migrating from Traffic Ops 1.x to Traffic Ops 2.x</a>
- </dt>
-
-
- <dt><a href="overview/traffic_portal.html#index-0">Traffic Portal - Overview</a>
- </dt>
-
-
- <dt><a href="overview/traffic_router.html#index-0">Traffic Router - Overview</a>
- </dt>
-
-
- <dt><a href="basics/caching_proxies.html#index-2">Transparent Proxy</a>
- </dt>
-
- </dl></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/using.html#index-6">Token Based Authentication</a>
+</li>
+ <li><a href="overview/traffic_monitor.html#index-0">Traffic Monitor - Overview</a>
+</li>
+ <li><a href="admin/traffic_ops/default_profiles.html#index-0">Traffic Ops - Default Profiles</a>
+</li>
+ <li><a href="admin/traffic_ops/installation.html#index-0">Traffic Ops - Installing</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="admin/traffic_ops/migration_from_10_to_20.html#index-0">Traffic Ops - Migrating from Traffic Ops 1.x to Traffic Ops 2.x</a>
+</li>
+ <li><a href="overview/traffic_portal.html#index-0">Traffic Portal - Overview</a>
+</li>
+ <li><a href="overview/traffic_router.html#index-0">Traffic Router - Overview</a>
+</li>
+ <li><a href="basics/caching_proxies.html#index-2">Transparent Proxy</a>
+</li>
+ </ul></td>
</tr></table>
@@ -601,16 +493,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
diff --git a/docs/latest/glossary.html b/docs/latest/glossary.html
index e3ffd02..704e8dd 100644
--- a/docs/latest/glossary.html
+++ b/docs/latest/glossary.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Glossary — Traffic Control 2.1-dev documentation </title>
+ <title>Glossary — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="index.html"/>
+ <link rel="index" title="Index"
+ href="genindex.html"/>
+ <link rel="search" title="Search" href="search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="index.html"/>
<link rel="prev" title="Running a Traffic Control CDN" href="faq/administration.html"/>
@@ -93,21 +98,22 @@
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -118,15 +124,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -162,12 +176,12 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="index.html">Traffic Control 2.2-dev</a> »</li>
<li>Glossary</li>
<li class="wy-breadcrumbs-aside">
- <a href="_sources/glossary.txt" rel="nofollow"> View page source</a>
+ <a href="_sources/glossary.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -193,7 +207,7 @@
<dt id="term-cache">cache</dt>
<dd>A caching proxy server. See <a class="reference internal" href="basics/caching_proxies.html#rl-caching-proxy"><span class="std std-ref">Caching Proxies</span></a>.</dd>
<dt id="term-cachegroup">cachegroup</dt>
-<dd>A group of caches that together create a combined larger cache using consistent hashing. See <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><span class="std std-ref"> Cache Group</span></a>.</dd>
+<dd>A group of caches that together create a combined larger cache using consistent hashing. See <a class="reference internal" href="faq/administration.html#rl-cachegroup"><span class="std std-ref">Cache Group</span></a>.</dd>
<dt id="term-consistent-hashing">consistent hashing</dt>
<dd>See <a class="reference external" href="http://en.wikipedia.org/wiki/Consistent_hashing">the Wikipedia article</a>; Traffic Control uses consistent hashing when using <a class="reference internal" href="overview/traffic_router.html#rl-http-cr"><span class="std std-ref"> HTTP Content Routing</span></a> for the edge tier and when selecting parents in the mid tier.</dd>
<dt id="term-content-routing">content routing</dt>
@@ -203,7 +217,7 @@
<dt id="term-delivery-service">delivery service</dt>
<dd>A grouping of content in the CDN, usually a determined by the URL hostname. See <a class="reference internal" href="overview/traffic_router.html#rl-ds"><span class="std std-ref"> Delivery Service</span></a>.</dd>
<dt id="term-edge-tier-or-cache">edge (tier or cache)</dt>
-<dd>Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a <a class="reference internal" href="basics/caching_proxies.html#rl-rev-proxy"><span class="std std-ref"> Reverse Proxy</span></a>. See also <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><span class="std std-ref"> Cache Group</span></a>.</dd>
+<dd>Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a <a class="reference internal" href="basics/caching_proxies.html#rl-rev-proxy"><span class="std std-ref"> Reverse Proxy</span></a>. See also <a class="reference internal" href="faq/administration.html#rl-cachegroup"><span class="std std-ref">Cache Group</span></a>.</dd>
<dt id="term-traffic-ops-extension">(traffic ops) extension</dt>
<dd>Using <em>extensions</em>, Traffic Ops be extended to use proprietary checks or monitoring sources. See <a class="reference internal" href="overview/traffic_ops.html#rl-trops-ext"><span class="std std-ref"> Traffic Ops Extension</span></a>.</dd>
<dt id="term-forward-proxy">forward proxy</dt>
@@ -215,13 +229,13 @@
<dt id="term-localization">localization</dt>
<dd>Finding location on the network, or on planet earth. See <a class="reference internal" href="overview/traffic_router.html#rl-localization"><span class="std std-ref"> Localization</span></a>.</dd>
<dt id="term-mid-tier-or-cache">mid (tier or cache)</dt>
-<dd>The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a <a class="reference internal" href="basics/caching_proxies.html#rl-fwd-proxy"><span class="std std-ref"> Forward Proxy</span></a>. See also <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><span class="std std-ref"> Cache Group</span></a>.</dd>
+<dd>The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a <a class="reference internal" href="basics/caching_proxies.html#rl-fwd-proxy"><span class="std std-ref"> Forward Proxy</span></a>. See also <a class="reference internal" href="faq/administration.html#rl-cachegroup"><span class="std std-ref">Cache Group</span></a>.</dd>
<dt id="term-origin">origin</dt>
<dd>The source of content for the CDN. Usually a redundant HTTP/1.1 webserver.</dd>
<dt id="term-parent-cache-or-cachegroup">parent (cache or cachegroup)</dt>
-<dd>The (group of) cache(s) in the higher tier. See <a class="reference internal" href="overview/traffic_server.html#rl-cachegroup"><span class="std std-ref"> Cache Group</span></a>.</dd>
+<dd>The (group of) cache(s) in the higher tier. See <a class="reference internal" href="faq/administration.html#rl-cachegroup"><span class="std std-ref">Cache Group</span></a>.</dd>
<dt id="term-profile">profile</dt>
-<dd>A group of settings (parameters) that will be applied to a server. See <a class="reference internal" href="overview/traffic_server.html#rl-profile"><span class="std std-ref"> Profile</span></a>.</dd>
+<dd>A group of settings (parameters) that will be applied to a server. See <a class="reference internal" href="faq/administration.html#rl-profile"><span class="std std-ref">Profile</span></a>.</dd>
<dt id="term-reverse-proxy">reverse proxy</dt>
<dd>A proxy that acts like it is the origin to the client. See <a class="reference internal" href="basics/caching_proxies.html#rl-rev-proxy"><span class="std std-ref"> Reverse Proxy</span></a>.</dd>
</dl>
@@ -258,16 +272,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
diff --git a/docs/latest/index.html b/docs/latest/index.html
index 04e7927..0501f5a 100644
--- a/docs/latest/index.html
+++ b/docs/latest/index.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Control — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Control — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="#"/>
+ <link rel="index" title="Index"
+ href="genindex.html"/>
+ <link rel="search" title="Search" href="search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="#"/>
<link rel="next" title="CDN Basics" href="basics/index.html"/>
@@ -93,21 +98,22 @@
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -118,15 +124,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -162,12 +176,12 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="#">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="#">Traffic Control 2.2-dev</a> »</li>
<li>Traffic Control</li>
<li class="wy-breadcrumbs-aside">
- <a href="_sources/index.txt" rel="nofollow"> View page source</a>
+ <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -185,7 +199,7 @@
<div class="section" id="traffic-control">
<h1>Traffic Control<a class="headerlink" href="#traffic-control" title="Permalink to this headline">¶</a></h1>
-<p>The vast majority of today’s Internet traffic is media files being sent from a single source to many thousands or even millions of destinations. Content Delivery Networks make that one-to-many distribution possible in an economical way.</p>
+<p>The vast majority of today’s Internet traffic is media files being sent from a single source to many thousands or even millions of destinations. Content Delivery Networks make that one-to-many distribution possible in an economical way.</p>
<p>Traffic Control is an Open Source implementation of a Content Delivery Network.</p>
<p>The following documentation sections are available:</p>
<div class="section" id="cdn-basics">
@@ -228,11 +242,6 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="overview/traffic_server.html">Traffic Server</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="overview/traffic_server.html#arrow-cache-group"> Cache Group</a></li>
-<li class="toctree-l3"><a class="reference internal" href="overview/traffic_server.html#arrow-profile"> Profile</a></li>
-</ul>
-</li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
@@ -240,11 +249,11 @@
</div>
</div>
<div class="section" id="administrator-s-guide">
-<h2>Administrator’s Guide<a class="headerlink" href="#administrator-s-guide" title="Permalink to this headline">¶</a></h2>
+<h2>Administrator’s Guide<a class="headerlink" href="#administrator-s-guide" title="Permalink to this headline">¶</a></h2>
<p>How to deploy and manage a Traffic Control CDN.</p>
<div class="toctree-wrapper compound">
<ul>
-<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/installation.html">Traffic Ops - Installing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/installation.html#system-requirements">System Requirements</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/installation.html#navigating-the-install">Navigating the Install</a></li>
@@ -262,12 +271,19 @@
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html#navigating-the-database-migration">Navigating the Database Migration</a></li>
</ul>
</li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html#per-deliveryservice-routing-names">Per-DeliveryService Routing Names</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html#apache-traffic-server-7-x-cachekey-plugin">Apache Traffic Server 7.x (Cachekey Plugin)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html#apache-traffic-server-7-x-logging">Apache Traffic Server 7.x (Logging)</a></li>
+</ul>
+</li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a><ul>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#installing-the-ssl-cert">Installing the SSL Cert</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#content-delivery-networks">Content Delivery Networks</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#profile-parameters">Profile Parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#regions-locations-and-cache-groups">Regions, Locations and Cache Groups</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#configuring-content-purge">Configuring Content Purge</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/configuration.html#configuring-the-go-application">Configuring the Go Application</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/using.html">Traffic Ops - Using</a><ul>
@@ -285,8 +301,27 @@
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_ops/extensions.html#example-cron-file">Example Cron File</a></li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#dashboard">Dashboard</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#cdns">CDNs</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#monitor">Monitor</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#services">Services</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#configure">Configure</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#topology">Topology</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#tools">Tools</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#user-admin">User Admin</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#other">Other</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id1">Monitor</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id2">Services</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id3">Configure</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id4">Topology</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id5">Tools</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id6">User Admin</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html#id7">Other</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_monitor.html#installing-traffic-monitor">Installing Traffic Monitor</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_monitor.html#configuring-traffic-monitor">Configuring Traffic Monitor</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_monitor.html#troubleshooting-and-log-files">Troubleshooting and log files</a></li>
@@ -305,6 +340,7 @@
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#troubleshooting-and-log-files">Troubleshooting and log files</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#event-log-file-format">Event Log File Format</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#geolimit-failure-redirect-feature">GeoLimit Failure Redirect feature</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#deep-caching-deep-coverage-zone-topology">Deep Caching - Deep Coverage Zone Topology</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#steering-feature">Steering feature</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#https-for-http-type-delivery-services">HTTPS for Http Type Delivery Services</a></li>
<li class="toctree-l3"><a class="reference internal" href="admin/traffic_router.html#tuning-recommendations">Tuning Recommendations</a></li>
@@ -328,12 +364,8 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="admin/quick_howto/index.html">Quick How To Guides</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="admin/quick_howto/multi_site.html">Configure Multi Site Origin</a></li>
-<li class="toctree-l3"><a class="reference internal" href="admin/quick_howto/multi_site_ats5.html">Configure Multi Site Origin (5.x)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="admin/quick_howto/dnssec.html">Configure DNSSEC</a></li>
-<li class="toctree-l3"><a class="reference internal" href="admin/quick_howto/federations.html">Configure Federations</a></li>
-<li class="toctree-l3"><a class="reference internal" href="admin/quick_howto/regionalgeo.html">Configure Regional Geo-blocking (RGB)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="admin/quick_howto/steering.html">Configure Delivery Service Steering</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/quick_howto/index.html#traffic-ops">Traffic Ops</a></li>
+<li class="toctree-l3"><a class="reference internal" href="admin/quick_howto/index.html#traffic-portal">Traffic Portal</a></li>
</ul>
</li>
</ul>
@@ -342,11 +374,11 @@
</div>
</div>
<div class="section" id="developer-s-guide">
-<h2>Developer’s Guide<a class="headerlink" href="#developer-s-guide" title="Permalink to this headline">¶</a></h2>
+<h2>Developer’s Guide<a class="headerlink" href="#developer-s-guide" title="Permalink to this headline">¶</a></h2>
<p>A guide to the various internal and external APIs, and an introduction for the Traffic Control developer.</p>
<div class="toctree-wrapper compound">
<ul>
-<li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development/building.html">Building Traffic Control</a><ul>
<li class="toctree-l3"><a class="reference internal" href="development/building.html#build-using-pkg">Build using pkg</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/building.html#build-using-docker-compose">Build using docker-compose</a></li>
@@ -361,7 +393,6 @@
<li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#installing-the-developer-environment">Installing The Developer Environment</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#test-cases">Test Cases</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#extensions">Extensions</a></li>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_ops.html#api">API</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_portal.html">Traffic Portal</a><ul>
@@ -378,32 +409,23 @@
<li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#traffic-router-project-tree-overview">Traffic Router Project Tree Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#java-formatting-conventions">Java Formatting Conventions</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#installing-the-developer-environment">Installing The Developer Environment</a></li>
+<li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#manual-testing">Manual Testing</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#test-cases">Test Cases</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#rpm-packaging">RPM Packaging</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_router.html#api">API</a></li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor Golang</a><ul>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#introduction">Introduction</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#software-requirements">Software Requirements</a></li>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#traffic-monitor-project-tree-overview">Traffic Monitor Project Tree Overview</a></li>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#java-formatting-conventions">Java Formatting Conventions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#project-tree-overview">Project Tree Overview</a></li>
+<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#architecture">Architecture</a></li>
+<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#formatting-conventions">Formatting Conventions</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#installing-the-developer-environment">Installing The Developer Environment</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#test-cases">Test Cases</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor.html#api">API</a></li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor_golang.html">Traffic Monitor Golang</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor_golang.html#introduction">Introduction</a></li>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor_golang.html#software-requirements">Software Requirements</a></li>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor_golang.html#project-tree-overview">Project Tree Overview</a></li>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor_golang.html#architecture">Architecture</a></li>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor_golang.html#formatting-conventions">Formatting Conventions</a></li>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor_golang.html#installing-the-developer-environment">Installing The Developer Environment</a></li>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor_golang.html#test-cases">Test Cases</a></li>
-<li class="toctree-l3"><a class="reference internal" href="development/traffic_monitor_golang.html#api">API</a></li>
-</ul>
-</li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_stats.html">Traffic Stats</a><ul>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_stats.html#introduction">Introduction</a></li>
<li class="toctree-l3"><a class="reference internal" href="development/traffic_stats.html#software-requirements">Software Requirements</a></li>
@@ -413,7 +435,94 @@
<li class="toctree-l3"><a class="reference internal" href="development/traffic_stats.html#test-cases">Test Cases</a></li>
</ul>
</li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="apis">
+<h2>APIs<a class="headerlink" href="#apis" title="Permalink to this headline">¶</a></h2>
+<p>A guide to external RESTful APIs for Traffic Ops</p>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/traffic_ops_api.html">API Overview</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#response-structure">Response Structure</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#using-api-endpoints">Using API Endpoints</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#api-errors">API Errors</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/traffic_ops_api.html#trafficops-native-client-libraries">TrafficOps Native Client Libraries</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v11/index.html">API 1.1 Reference</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/asn.html">ASN</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/cachegroup.html">Cache Group</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/cdn.html">CDN</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/changelog.html">Change Logs</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/deliveryservice.html">Delivery Service</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/hwinfo.html">Hardware Info</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/parameter.html">Parameter</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/phys_location.html">Physical Location</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/profile.html">Profiles</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/region.html">Regions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/role.html">Roles</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/server.html">Server</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/static_dns.html">Static DNS Entries</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/status.html">Status</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/system.html">System</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/to_extension.html">TO Extensions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/type.html">Types</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v11/user.html">Users</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="api/v12/index.html">API 1.2 Reference</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/api_capability.html">API-Capabilities</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/asn.html">ASN</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/cache.html">Cache</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/cachegroup.html">Cache Group</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/cachegroup_parameter.html">Cache Group parameters</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/cachegroup_fallbacks.html">Cache Group Fallback</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/cache_stats.html">Cache Statistics</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/capability.html">Capabilities</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/cdn.html">CDN</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/changelog.html">Change Logs</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/configfiles_ats.html">Config Files and Config File Metadata</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/deliveryservice.html">Delivery Service</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/deliveryservice_regex.html">Delivery Service Regexes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/deliveryservice_stats.html">Delivery Service Statistics</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/division.html">Divisions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/federation.html">Federation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/federation_deliveryservice.html">Federation Delivery Service</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/federation_federationresolver.html">Federation Federation Resolver</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/federation_resolver.html">Federation Resolver</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/federation_user.html">Federation User</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/hwinfo.html">Hardware Info</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/iso.html">ISO</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/job.html">Jobs</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/parameter.html">Parameter</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/phys_location.html">Physical Location</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/profile.html">Profiles</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/profile_parameter.html">Profile parameters</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/influxdb.html">InfluxDB</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/region.html">Regions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/role.html">Roles</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/server.html">Server</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/static_dns.html">Static DNS Entries</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/status.html">Status</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/steering_target.html">Steering Targets</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/system.html">System</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/tenant.html">Tenants</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/to_extension.html">TO Extensions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/type.html">Types</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/user.html">Users</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v12/topology.html">Snapshot CRConfig</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="api/v13/coordinate.html">Coordinate</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api/v13/origin.html">Origin</a></li>
+</ul>
+</li>
</ul>
</li>
</ul>
@@ -438,7 +547,8 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="faq/administration.html">Running a Traffic Control CDN</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="faq/administration.html#why-is-my-crconfig-json-rejected">Why is my CRConfig.json rejected?</a></li>
+<li class="toctree-l3"><a class="reference internal" href="faq/administration.html#cache-group">Cache Group</a></li>
+<li class="toctree-l3"><a class="reference internal" href="faq/administration.html#profile">Profile</a></li>
</ul>
</li>
</ul>
@@ -487,16 +597,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
diff --git a/docs/latest/objects.inv b/docs/latest/objects.inv
index 5369f11..efeed11 100644
--- a/docs/latest/objects.inv
+++ b/docs/latest/objects.inv
Binary files differ
diff --git a/docs/latest/overview/index.html b/docs/latest/overview/index.html
index 0cf1526..cec8459 100644
--- a/docs/latest/overview/index.html
+++ b/docs/latest/overview/index.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Control Overview — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Control Overview — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="next" title="Introduction" href="introduction.html"/>
<link rel="prev" title="Cache Control Headers and Revalidation" href="../basics/cache_revalidation.html"/>
@@ -94,21 +99,22 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -119,15 +125,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -163,12 +177,12 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li>Traffic Control Overview</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/overview/index.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/overview/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -210,11 +224,6 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l1"><a class="reference internal" href="traffic_server.html">Traffic Server</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html#arrow-cache-group"> Cache Group</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html#arrow-profile"> Profile</a></li>
-</ul>
-</li>
<li class="toctree-l1"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
</ul>
</div>
@@ -253,16 +262,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/overview/introduction.html b/docs/latest/overview/introduction.html
index ce42bcc..be6831c 100644
--- a/docs/latest/overview/introduction.html
+++ b/docs/latest/overview/introduction.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Introduction — Traffic Control 2.1-dev documentation </title>
+ <title>Introduction — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Traffic Control Overview" href="index.html"/>
<link rel="next" title="Traffic Ops" href="traffic_ops.html"/>
<link rel="prev" title="Traffic Control Overview" href="index.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">Traffic Control Overview</a> »</li>
<li>Introduction</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/overview/introduction.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/overview/introduction.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -263,16 +277,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/overview/traffic_monitor.html b/docs/latest/overview/traffic_monitor.html
index 02c64fd..c965676 100644
--- a/docs/latest/overview/traffic_monitor.html
+++ b/docs/latest/overview/traffic_monitor.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Monitor — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Monitor — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Traffic Control Overview" href="index.html"/>
<link rel="next" title="Traffic Stats" href="traffic_stats.html"/>
<link rel="prev" title="Traffic Router" href="traffic_router.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">Traffic Control Overview</a> »</li>
<li>Traffic Monitor</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/overview/traffic_monitor.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/overview/traffic_monitor.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -197,7 +211,7 @@
<div class="section" id="arrow-cache-monitoring">
<span id="rl-astats"></span><h2><img alt="arrow" src="../_images/fwda1.png" /> Cache Monitoring<a class="headerlink" href="#arrow-cache-monitoring" title="Permalink to this headline">¶</a></h2>
<blockquote>
-<div><p>Traffic Monitor polls all caches configured with a status of <code class="docutils literal"><span class="pre">REPORTED</span></code> or <code class="docutils literal"><span class="pre">ADMIN_DOWN</span></code> at an interval specified as a configuration parameter in Traffic Ops. If the cache is set to <code class="docutils literal"><span class="pre">ADMIN_DOWN</span></code> it is marked as unavailable but still polled for availability and statistics. If the cache is explicitly configured with a status of <code class="docutils literal"><span class="pre">ONLINE</span></code> or <code class="docutils literal"><span class="pre">OFFLINE</span></code>, it is not polled by Traffic Monitor and presented to Traffic Router as configured, regardless of actual availability.</p>
+<div><p>Traffic Monitor polls all caches configured with a status of <code class="docutils literal notranslate"><span class="pre">REPORTED</span></code> or <code class="docutils literal notranslate"><span class="pre">ADMIN_DOWN</span></code> at an interval specified as a configuration parameter in Traffic Ops. If the cache is set to <code class="docutils literal notranslate"><span class="pre">ADMIN_DOWN</span></code> it is marked as unavailable but still polled for availability and statistics. If the cache is explicitly configured with a status of <code class="docutils literal notranslate"><span class="pre">ONLINE</span></code> or <code class="docutils literal notranslate"><span class="pre">OFFLINE</span></code>, it is not polled by Traffic Monitor and presented to Traffic Router as configured, regardless of actual availability.</p>
<p>Traffic Monitor makes HTTP requests at regular intervals to a special URL on each EDGE cache and consumes the JSON output. The special URL is a plugin running on the Apache Traffic Server (ATS) caches called astats, which is restricted to Traffic Monitor only. The astats plugin provides insight into application and system performance, such as:</p>
<ul class="simple">
<li>Throughput (e.g. bytes in, bytes out, etc).</li>
@@ -219,10 +233,10 @@
<span id="rl-health-proto"></span><h2><img alt="arrow" src="../_images/fwda1.png" /> Health Protocol<a class="headerlink" href="#arrow-health-protocol" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p>Redundant Traffic Monitor servers operate independently from each other but take the state of other Traffic Monitors into account when asked for health state information. In the above overview of cache monitoring, the behavior of Traffic Monitor pertains only to how an individual instance detects and handles failures. The Health Protocol adds another dimension to the health state of the CDN by merging the states of all Traffic Monitors into one, and then taking the <em>optimistic</em> approach when dealing with a cache or Delivery Service that might have been marked as unavailable by this particular instance or a peer instance of Traffic Monitor.</p>
-<p>Upon startup or configuration change in Traffic Ops, in addition to caches, Traffic Monitor begins polling its peer Traffic Monitors whose state is set to <code class="docutils literal"><span class="pre">ONLINE</span></code>. Each <code class="docutils literal"><span class="pre">ONLINE</span></code> Traffic Monitor polls all of its peers at a configurable interval and saves the peer’s state for later use. When polling its peers, Traffic Monitor asks for the raw health state from each respective peer, which is strictly that instance’s view of the CDN’s health. When any <code class="docutils literal"><span class="pre">ONLINE</span></code> Traffic Monitor is asked for CDN health by an upstream component, such as Traffic Router, the component gets the health protocol influenced version of CDN health (non-raw view).</p>
-<p>In operation of the health protocol, Traffic Monitor takes all health states from all peers, including the locally known health state, and serves an optimistic outlook to the requesting client. This means that, for example, if three of the four Traffic Monitors see a given cache or Delivery Service as exceeding its thresholds and unavailable, it is still considered available. Only if all Traffic Monitors agree that the given object is unavailable is that state propagated to upstream components. This optimistic approach to the Health Protocol is counter to the “fail fast” philosophy, but serves well for large networks with complicated geography and or routing. The optimistic Health Protocol allows network failures or latency to occur without affecting overall traffic routing, as Traffic Monitors can and do have a different view of the network when deployed in geographically diverse locations. Short polling intervals of both the caches and Traffic Monitor peers help to reduce customer impact of outages.</p>
+<p>Upon startup or configuration change in Traffic Ops, in addition to caches, Traffic Monitor begins polling its peer Traffic Monitors whose state is set to <code class="docutils literal notranslate"><span class="pre">ONLINE</span></code>. Each <code class="docutils literal notranslate"><span class="pre">ONLINE</span></code> Traffic Monitor polls all of its peers at a configurable interval and saves the peer’s state for later use. When polling its peers, Traffic Monitor asks for the raw health state from each respective peer, which is strictly that instance’s view of the CDN’s health. When any <code class="docutils literal notranslate"><span class="pre">ONLINE</span></code> Traffic Monitor is asked for CDN health by an upstream component, such as Traffic Router, the component gets the health protocol influenced version of CDN health (non-raw view).</p>
+<p>In operation of the health protocol, Traffic Monitor takes all health states from all peers, including the locally known health state, and serves an optimistic outlook to the requesting client. This means that, for example, if three of the four Traffic Monitors see a given cache or Delivery Service as exceeding its thresholds and unavailable, it is still considered available. Only if all Traffic Monitors agree that the given object is unavailable is that state propagated to upstream components. This optimistic approach to the Health Protocol is counter to the “fail fast” philosophy, but serves well for large networks with complicated geography and or routing. The optimistic Health Protocol allows network failures or latency to occur without affecting overall traffic routing, as Traffic Monitors can and do have a different view of the network when deployed in geographically diverse locations. Short polling intervals of both the caches and Traffic Monitor peers help to reduce customer impact of outages.</p>
</div></blockquote>
-<p>It is not uncommon for a cache to be marked unavailable by Traffic Monitor - in fact, it is business as usual for many CDNs. A hot video asset may cause a single cache (say cache-03) to get close to it’s interface capacity, the health protocol “kicks in”, and Traffic Monitor marks cache-03 as unavailable. New clients want to see the same asset, and now, Traffic Router will send these customers to another cache (say cache-01) in the same cachegroup. The load is now shared between cache-01 and cache-03. As clients finish watching the asset on cache-03, it will drop below the threshold and gets marked available again, and new clients will now go back to cache-03 again.</p>
+<p>It is not uncommon for a cache to be marked unavailable by Traffic Monitor - in fact, it is business as usual for many CDNs. A hot video asset may cause a single cache (say cache-03) to get close to it’s interface capacity, the health protocol “kicks in”, and Traffic Monitor marks cache-03 as unavailable. New clients want to see the same asset, and now, Traffic Router will send these customers to another cache (say cache-01) in the same cachegroup. The load is now shared between cache-01 and cache-03. As clients finish watching the asset on cache-03, it will drop below the threshold and gets marked available again, and new clients will now go back to cache-03 again.</p>
<p>It is less common for a delivery service to be marked unavailable by Traffic Monitor, the delivery service thresholds are usually used for overflow situations at extreme peaks to protect other delivery services in the CDN from getting impacted.</p>
</div>
</div>
@@ -260,16 +274,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/overview/traffic_ops.html b/docs/latest/overview/traffic_ops.html
index 3f52d34..0488695 100644
--- a/docs/latest/overview/traffic_ops.html
+++ b/docs/latest/overview/traffic_ops.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Ops — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Ops — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Traffic Control Overview" href="index.html"/>
<link rel="next" title="Traffic Portal" href="traffic_portal.html"/>
<link rel="prev" title="Introduction" href="introduction.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">Traffic Control Overview</a> »</li>
<li>Traffic Ops</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/overview/traffic_ops.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/overview/traffic_ops.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -192,9 +206,10 @@
<div class="section" id="traffic-ops">
<h1>Traffic Ops<a class="headerlink" href="#traffic-ops" title="Permalink to this headline">¶</a></h1>
<p>Traffic Ops is the tool for administration (configuration and monitoring) of all components in a Traffic Control CDN. The CDN administrator uses Traffic Ops to manage servers, cache groups, delivery services, etc. In many cases, a configuration change requires propagation to several, or even all, caches and only explicitly after or before the same change propagates to Traffic Router. Traffic Ops takes care of this required consistency between the different components and their configuration. Traffic Ops exposes its data through a series of HTTP APIs and has a user interface that is interactive and viewable using a standard web browser.</p>
-<p>Traffic Ops uses a MySQL or PostgreSQL database to store the configuration information, and the <a class="reference external" href="http://mojolicio.us/">Mojolicious framework</a> to generate the user interface and APIs. Not all configuration data is in this database however; for sensitive data, like SSL private keys or token based authentication shared secrets, a separate key-value store is used, allowing the operator to harden the server that runs this key-value store better from a security perspective (i.e only allow Traffic Ops access it with a cert). The Traffic Ops server, by design, needs to be accessible from all the other servers in the Traffic Control CDN.</p>
+<p>Traffic Ops uses a PostgreSQL database to store the configuration information, and the <a class="reference external" href="http://mojolicio.us/">Mojolicious framework</a> and <a class="reference external" href="https://golang.org/">Go</a> to generate APIs used by the Traffic Portal. Not all configuration data is in this database however; for sensitive data like SSL private keys or token based authentication shared secrets, a separate key-value store is used, allowing the operator to harden the server that runs this key-value store better from a security perspective (i.e only allow Traffic Ops access it with a cert). The Traffic Ops server, by design, needs to be accessible from all the other servers in the Traffic Control CDN.</p>
<p>Traffic Ops generates all the application specific configuration files for the caches and other servers. The caches and other servers check in with Traffic Ops at a regular interval (default 15 minutes) to see if updated configuration files require application.</p>
<p>Traffic Ops also runs a collection of periodic checks to determine the operational readiness of the caches. These periodic checks are customizable by the Traffic Ops admin using extensions.</p>
+<p>Traffic Ops is in the process of migrating from Perl to Go, and currently runs as two applications. The Go application serves all endpoints which have been rewritten in the Go language, and transparently proxies all other requests to the old Perl application. Both applications are installed by the RPM, and both run as a single service. When the project has fully migrated to Go, the Perl application will be removed, and the RPM and service will consist solely of the Go application.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
@@ -203,7 +218,7 @@
<blockquote>
<div><p>Traffic Ops Extensions are a way to enhance the basic functionality of Traffic Ops in a custom manner. There are three types of extensions:</p>
<ul class="simple">
-<li>Check Extensions - Allows you to add custom checks to the “Health->Server Checks” view.</li>
+<li>Check Extensions - Allows you to add custom checks to the “Health->Server Checks” view.</li>
<li>Configuration Extension - Allows you to add custom configuration file generators.</li>
<li>Data source Extensions - Allows you to add data sources for the graph views and usage APIs.</li>
</ul>
@@ -244,16 +259,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/overview/traffic_portal.html b/docs/latest/overview/traffic_portal.html
index 8014fc9..5041cac 100644
--- a/docs/latest/overview/traffic_portal.html
+++ b/docs/latest/overview/traffic_portal.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Portal — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Portal — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Traffic Control Overview" href="index.html"/>
<link rel="next" title="Traffic Router" href="traffic_router.html"/>
<link rel="prev" title="Traffic Ops" href="traffic_ops.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">Traffic Control Overview</a> »</li>
<li>Traffic Portal</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/overview/traffic_portal.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/overview/traffic_portal.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -191,30 +205,17 @@
<div class="section" id="traffic-portal">
<span id="index-0"></span><h1>Traffic Portal<a class="headerlink" href="#traffic-portal" title="Permalink to this headline">¶</a></h1>
-<p>Traffic Portal is an <a class="reference external" href="https://angularjs.org/">AngularJS 1.x</a> client served from a <a class="reference external" href="https://nodejs.org/en/">Node.js</a> web server designed to consume the Traffic Ops 1.x API. Traffic Portal provides a set of functionality restricted to the delivery service(s) of the authenticated user. Functionality primarily includes a set of charts / graphs designed to provide insight into the performance of a user’s delivery service(s).</p>
-<p>Charts / Graphs include:</p>
+<p>Traffic Portal is an <a class="reference external" href="https://angularjs.org/">AngularJS 1.x</a> client served from a <a class="reference external" href="https://nodejs.org/en/">Node.js</a> web server designed to consume the Traffic Ops API. It is the official replacement for the legacy Traffic Ops UI.</p>
+<p>Features include:</p>
<blockquote>
<div><ul class="simple">
-<li>Overall Cache Group Status</li>
-<li>Delivery Service Bandwidth Per Second</li>
-<li>Delivery Service Transactions Per Second</li>
-<li>Delivery Service HTTP Status By Class</li>
-<li>Delivery Service Capacity</li>
-<li>Delivery Service Routing Methods</li>
-<li>Delivery Service Cache Group Status</li>
+<li>CDN Monitoring</li>
+<li>CDN Administration</li>
+<li>Delivery Service Configuration</li>
+<li>Cache Maintenance</li>
</ul>
</div></blockquote>
-<p>Other features:</p>
-<blockquote>
-<div><ul class="simple">
-<li>Ability to manager user profile</li>
-<li>Ability to reset user password</li>
-<li>Ability to view delivery service configuration</li>
-<li>Ability to invalidate content for a delivery service</li>
-<li>Ability to retrieve all caches associated with a delivery service</li>
-<li>Ability to request a new delivery service</li>
-</ul>
-</div></blockquote>
+<p>See <a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html#usingtrafficportal"><span class="std std-ref">Traffic Portal - Using</span></a></p>
</div>
@@ -250,16 +251,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/overview/traffic_router.html b/docs/latest/overview/traffic_router.html
index 8ced312..06e039e 100644
--- a/docs/latest/overview/traffic_router.html
+++ b/docs/latest/overview/traffic_router.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Router — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Router — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Traffic Control Overview" href="index.html"/>
<link rel="next" title="Traffic Monitor" href="traffic_monitor.html"/>
<link rel="prev" title="Traffic Portal" href="traffic_portal.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">Traffic Control Overview</a> »</li>
<li>Traffic Router</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/overview/traffic_router.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/overview/traffic_router.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -191,7 +205,7 @@
<span class="target" id="reference-label-tc-tr"></span><div class="section" id="traffic-router">
<span id="index-0"></span><h1>Traffic Router<a class="headerlink" href="#traffic-router" title="Permalink to this headline">¶</a></h1>
-<p>Traffic Router’s function is to send clients to the most optimal cache. Optimal in this case is based on a number of factors:</p>
+<p>Traffic Router’s function is to send clients to the most optimal cache. Optimal in this case is based on a number of factors:</p>
<ul class="simple">
<li>Distance between the cache and the client (not necessarily measured in meters, but quite often in layer 3 network hops). Less network distance between the client and cache yields better performance, and lower network load. Traffic Router helps clients connect to the best performing cache for their location at the lowest network cost.</li>
<li>Availability of caches and health / load on the caches. A common issue in Internet and television distribution scenarios is having many clients attempting to retrieve the same content at the same time. Traffic Router helps clients route around overloaded or down caches.</li>
@@ -213,7 +227,7 @@
<li>Token based authentication settings.</li>
<li>Header rewrite rules.</li>
</ul>
-<p>Since Traffic Control version 2.1 deliveryservices can optionally be linked to a <a class="reference internal" href="traffic_server.html#rl-profile"><span class="std std-ref"> Profile</span></a>, and have parameters associated with them. The first feature that uses deliveryservice parameters is the <a class="reference internal" href="../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a> configuration.
+<p>Since Traffic Control version 2.1 deliveryservices can optionally be linked to a <a class="reference internal" href="../faq/administration.html#rl-profile"><span class="std std-ref">Profile</span></a>, and have parameters associated with them. The first feature that uses deliveryservice parameters is the <a class="reference internal" href="../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a> configuration.
Delivery Services are also for use in allowing multi-tenants to coexist in the Traffic Control CDN without interfering with each other, and to keep information about their content separated.</p>
</div></blockquote>
<div class="line-block">
@@ -223,11 +237,11 @@
<div class="section" id="arrow-localization">
<span id="rl-localization"></span><h2><img alt="arrow" src="../_images/fwda1.png" /> Localization<a class="headerlink" href="#arrow-localization" title="Permalink to this headline">¶</a></h2>
<blockquote>
-<div>Traffic Router uses a JSON input file called the <em>coverage zone map</em> to determine what <em>cachegroup</em> is closest to the client. If the client IP address is not in this coverage zone map, it falls back to <em>geo</em>, using the maxmind database to find the client’s location, and the geo coordinates from Traffic Ops for the cachegroup.</div></blockquote>
+<div>Traffic Router uses a JSON input file called the <em>coverage zone map</em> to determine what <em>cachegroup</em> is closest to the client. If the client IP address is not in this coverage zone map, it falls back to <em>geo</em>, using the maxmind database to find the client’s location, and the geo coordinates from Traffic Ops for the cachegroup.</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
-<p>Traffic Router is inserted into the HTTP retrieval process by making it DNS authoritative for the domain of the CDN delivery service. In the example of the reverse proxy, the client was given the <code class="docutils literal"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> url. In a Traffic Control CDN, URLs start with either <code class="docutils literal"><span class="pre">tr.</span></code> or <code class="docutils literal"><span class="pre">edge.</span></code>, for HTTP or DNS content routing respectively. These names are configurable via properties files within the Traffic Router installation.</p>
+<p>Traffic Router is inserted into the HTTP retrieval process by making it DNS authoritative for the domain of the CDN delivery service. In the example of the reverse proxy, the client was given the <code class="docutils literal notranslate"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> url. In a Traffic Control CDN, URLs start with a routing name, which is configurable per-Delivery Service, e.g. <code class="docutils literal notranslate"><span class="pre">http://foo.mydeliveryservice.cdn.com/fun/example.html</span></code> with the chosen routing name <code class="docutils literal notranslate"><span class="pre">foo</span></code>.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
@@ -235,7 +249,7 @@
<div class="section" id="arrow-dns-content-routing">
<span id="rl-dns-cr"></span><span id="index-1"></span><h2><img alt="arrow" src="../_images/fwda1.png" /> DNS Content Routing<a class="headerlink" href="#arrow-dns-content-routing" title="Permalink to this headline">¶</a></h2>
<blockquote>
-<div>For a DNS delivery service the client receives a URL with a hostname beginning with <code class="docutils literal"><span class="pre">edge.</span></code> (e.g. <a class="reference external" href="http://edge.dsname.cdn.com/foo/bar/fun.html">http://edge.dsname.cdn.com/foo/bar/fun.html</a>). When the LDNS server is resolving this <code class="docutils literal"><span class="pre">edge.dsname.cdn.com</span></code> hostname to an IP address, it ends at Traffic Router because it is the authoritative DNS server for <code class="docutils literal"><span class="pre">cdn.com</span></code> and the domains below it, and subsequently responds with a list of IP addresses from the eligible caches based on the location of the LDNS server. When responding, Traffic Router does not know the actual client IP address or the path that the client is going to request. The decision on what cache IP address (or list of cache IP addresses) to return is solely based on the location of the LDNS server and the health of the caches. The client then connects to port 80 on the cache, and sends the <code class="docutils literal"><span class="pre">Host:</span> <span class="pre">edge.dsname.cdn.com</span></code> header. The configuration of the cache includes the remap rule <code class="docutils literal"><span class="pre">http://edge.dsname.cdn.com</span> <span class="pre">http://origin.dsname.com</span></code> to map that edge name to an origin hostname.</div></blockquote>
+<div>For a DNS delivery service the client might receive a URL such as <code class="docutils literal notranslate"><span class="pre">http://foo.dsname.cdn.com/fun/example.html</span></code>. When the LDNS server is resolving this <code class="docutils literal notranslate"><span class="pre">foo.dsname.cdn.com</span></code> hostname to an IP address, it ends at Traffic Router because it is the authoritative DNS server for <code class="docutils literal notranslate"><span class="pre">cdn.com</span></code> and the domains below it, and subsequently responds with a list of IP addresses from the eligible caches based on the location of the LDNS server. When responding, Traffic Router does not know the actual client IP address or the path that the client is going to request. The decision on what cache IP address (or list of cache IP addresses) to return is solely based on the location of the LDNS server and the health of the caches. The client then connects to port 80 on the cache, and sends the <code class="docutils literal notranslate"><span class="pre">Host:</span> <span class="pre">foo.dsname.cdn.com</span></code> header. The configuration of the cache includes the remap rule <code class="docutils literal notranslate"><span class="pre">http://foo.dsname.cdn.com</span> <span class="pre">http://origin.dsname.com</span></code> to map the routed name to an origin hostname.</div></blockquote>
<div class="line-block">
<div class="line"><br /></div>
</div>
@@ -243,26 +257,26 @@
<div class="section" id="arrow-http-content-routing">
<span id="rl-http-cr"></span><h2><img alt="arrow" src="../_images/fwda1.png" /> HTTP Content Routing<a class="headerlink" href="#arrow-http-content-routing" title="Permalink to this headline">¶</a></h2>
<blockquote>
-<div><p>For an HTTP delivery service the client receives a URL with a hostname beginning with <code class="docutils literal"><span class="pre">tr.</span></code> (e.g. <a class="reference external" href="http://tr.dsname.cdn.com/foo/bar/fun.html">http://tr.dsname.cdn.com/foo/bar/fun.html</a>), the LDNS server resolves this <code class="docutils literal"><span class="pre">tr.dsname.cdn.com</span></code> to an IP address, but in this case Traffic Router returns its own IP address. The client opens a connection to port 80 on the Traffic Router’s IP address, and sends:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
-<span class="n">Host</span><span class="p">:</span> <span class="n">tr</span><span class="o">.</span><span class="n">dsname</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span>
+<div><p>For an HTTP delivery service the client might receive a URL such as <code class="docutils literal notranslate"><span class="pre">http://bar.dsname.cdn.com/fun/example.html</span></code>. The LDNS server resolves this <code class="docutils literal notranslate"><span class="pre">bar.dsname.cdn.com</span></code> to an IP address, but in this case Traffic Router returns its own IP address. The client opens a connection to port 80 on the Traffic Router’s IP address, and sends:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">fun</span><span class="o">/</span><span class="n">example</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<span class="n">Host</span><span class="p">:</span> <span class="n">bar</span><span class="o">.</span><span class="n">dsname</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span>
</pre></div>
</div>
<p>Traffic Router uses an HTTP 302 to redirect the client to the best cache. For example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">302</span> <span class="n">Moved</span> <span class="n">Temporarily</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">302</span> <span class="n">Moved</span> <span class="n">Temporarily</span>
<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">-</span><span class="n">Coyote</span><span class="o">/</span><span class="mf">1.1</span>
-<span class="n">Location</span><span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">atsec</span><span class="o">-</span><span class="n">nyc</span><span class="o">-</span><span class="mf">02.</span><span class="n">dsname</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span>
+<span class="n">Location</span><span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">atsec</span><span class="o">-</span><span class="n">nyc</span><span class="o">-</span><span class="mf">02.</span><span class="n">dsname</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">fun</span><span class="o">/</span><span class="n">example</span><span class="o">.</span><span class="n">html</span>
<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">0</span>
<span class="n">Date</span><span class="p">:</span> <span class="n">Tue</span><span class="p">,</span> <span class="mi">13</span> <span class="n">Jan</span> <span class="mi">2015</span> <span class="mi">20</span><span class="p">:</span><span class="mi">01</span><span class="p">:</span><span class="mi">41</span> <span class="n">GMT</span>
</pre></div>
</div>
<p>The information Traffic Router can consider when selecting a cache in this case is much better:</p>
<ul class="simple">
-<li>The client’s IP address (the other side of the socket).</li>
+<li>The client’s IP address (the other side of the socket).</li>
<li>The URL path the client is requesting, excluding query string.</li>
<li>All HTTP 1.1 headers.</li>
</ul>
-<p>The client follows the redirect and performs a DNS request for the IP address for <code class="docutils literal"><span class="pre">atsec-nyc-02.dsname.cdn.com</span></code>, and normal HTTP steps follow, except the sending of the Host: header when connected to the cache is <code class="docutils literal"><span class="pre">Host:</span> <span class="pre">atsec-nyc-02.dsname.cdn</span></code>, and the configuration of the cache includes the remap rule (e.g.``http://atsec-nyc-02.dsname.cdn <a class="reference external" href="http://origin.dsname">http://origin.dsname</a>.com``).</p>
+<p>The client follows the redirect and performs a DNS request for the IP address for <code class="docutils literal notranslate"><span class="pre">atsec-nyc-02.dsname.cdn.com</span></code>, and normal HTTP steps follow, except the sending of the Host: header when connected to the cache is <code class="docutils literal notranslate"><span class="pre">Host:</span> <span class="pre">atsec-nyc-02.dsname.cdn</span></code>, and the configuration of the cache includes the remap rule (e.g.``http://atsec-nyc-02.dsname.cdn <a class="reference external" href="http://origin.dsname">http://origin.dsname</a>.com``).</p>
<p>Traffic Router sends all requests for the same path in a delivery service to the same cache in a cache group using consistent hashing, in this case all caches in a cache group are not carrying the same content, and there is a much larger combined cache in the cache group.</p>
</div></blockquote>
<p>In many cases DNS content routing is the best possible option, especially in cases where the client is receiving small objects from the CDN like images and web pages.</p>
@@ -303,16 +317,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/overview/traffic_stats.html b/docs/latest/overview/traffic_stats.html
index 13df407..f7e4e19 100644
--- a/docs/latest/overview/traffic_stats.html
+++ b/docs/latest/overview/traffic_stats.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Stats — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Stats — Traffic Control 2.2-dev documentation </title>
@@ -33,9 +35,12 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Traffic Control Overview" href="index.html"/>
- <link rel="next" title="Traffic Server" href="traffic_server.html"/>
+ <link rel="next" title="Traffic Vault" href="traffic_vault.html"/>
<link rel="prev" title="Traffic Monitor" href="traffic_monitor.html"/>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">Traffic Control Overview</a> »</li>
<li>Traffic Stats</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/overview/traffic_stats.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/overview/traffic_stats.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -180,7 +194,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="traffic_server.html" class="btn btn-neutral float-right" title="Traffic Server">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="traffic_vault.html" class="btn btn-neutral float-right" title="Traffic Vault">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -191,7 +205,7 @@
<span class="target" id="reference-label-tc-ts"></span><div class="section" id="traffic-stats">
<h1>Traffic Stats<a class="headerlink" href="#traffic-stats" title="Permalink to this headline">¶</a></h1>
-<p>Traffic Stats is a program written in <a class="reference external" href="http://golang.org">Golang</a> that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor’s JSON APIs and stores the data in <a class="reference external" href="http://influxdb.com">InfluxDb</a>. Data is typically stored in InfluxDb on a short-term basis (30 days or less). The data from InfluxDb is then used to drive graphs created by <a class="reference external" href="http://grafana.org">Grafana</a> - which are linked to from Traffic Ops - as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API’s and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.</p>
+<p>Traffic Stats is a program written in <a class="reference external" href="http://golang.org">Golang</a> that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor’s JSON APIs and stores the data in <a class="reference external" href="http://influxdb.com">InfluxDb</a>. Data is typically stored in InfluxDb on a short-term basis (30 days or less). The data from InfluxDb is then used to drive graphs created by <a class="reference external" href="http://grafana.org">Grafana</a> - which are linked to from Traffic Ops - as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API’s and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.</p>
<p>Stat data is stored in three different databases:</p>
<blockquote>
<div><ul class="simple">
@@ -210,7 +224,7 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="traffic_server.html" class="btn btn-neutral float-right" title="Traffic Server">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="traffic_vault.html" class="btn btn-neutral float-right" title="Traffic Vault">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor"><span class="fa fa-arrow-circle-left"></span> Previous</a>
@@ -237,16 +251,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/overview/traffic_vault.html b/docs/latest/overview/traffic_vault.html
index 113074d..3a48ab5 100644
--- a/docs/latest/overview/traffic_vault.html
+++ b/docs/latest/overview/traffic_vault.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Vault — Traffic Control 2.1-dev documentation </title>
+ <title>Traffic Vault — Traffic Control 2.2-dev documentation </title>
@@ -33,10 +35,13 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/>
+ <link rel="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/>
<link rel="up" title="Traffic Control Overview" href="index.html"/>
<link rel="next" title="Administrator’s Guide" href="../admin/index.html"/>
- <link rel="prev" title="Traffic Server" href="traffic_server.html"/>
+ <link rel="prev" title="Traffic Stats" href="traffic_stats.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -95,21 +100,22 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -120,15 +126,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -164,14 +178,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="../index.html">Traffic Control 2.2-dev</a> »</li>
<li><a href="index.html">Traffic Control Overview</a> »</li>
<li>Traffic Vault</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/overview/traffic_vault.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/overview/traffic_vault.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -183,7 +197,7 @@
<a href="../admin/index.html" class="btn btn-neutral float-right" title="Administrator’s Guide">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_server.html" class="btn btn-neutral" title="Traffic Server"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="traffic_stats.html" class="btn btn-neutral" title="Traffic Stats"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -192,10 +206,10 @@
<div class="section" id="traffic-vault">
<h1>Traffic Vault<a class="headerlink" href="#traffic-vault" title="Permalink to this headline">¶</a></h1>
<p>Traffic Vault is a keystore used for storing the following types of information:</p>
-<ul>
+<ul class="simple">
<li><dl class="first docutils">
<dt>SSL Certificates</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li>Private Key</li>
<li>CRT</li>
<li>CSR</li>
@@ -208,7 +222,7 @@
<dd><ul class="first last">
<li><dl class="first docutils">
<dt>Key Signing Key</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li>private key</li>
<li>public key</li>
</ul>
@@ -217,7 +231,7 @@
</li>
<li><dl class="first docutils">
<dt>Zone Signing Key</dt>
-<dd><ul class="first last simple">
+<dd><ul class="first last">
<li>private key</li>
<li>public key</li>
</ul>
@@ -228,10 +242,9 @@
</dd>
</dl>
</li>
-<li><p class="first">URL Signing Keys</p>
-</li>
+<li>URL Signing Keys</li>
</ul>
-<p>As the name suggests, Traffic Vault is meant to be a “vault” of private keys that only certain users are allowed to access. In order to create, add, and retrieve keys a user must have admin privileges. Keys can be created via the Traffic Ops UI, but they can only be retrieved via the Traffic Ops API. The keystore used by Traffic Vault is <a class="reference external" href="http://basho.com/riak/">Riak</a>. Traffic ops accesses Riak via https on port 8088. Traffic ops uses Riak’s rest API with username/password authentication. Information on the API can be found <a class="reference external" href="http://docs.basho.com/riak/latest/dev/references/http/">here</a>.</p>
+<p>As the name suggests, Traffic Vault is meant to be a “vault” of private keys that only certain users are allowed to access. In order to create, add, and retrieve keys a user must have admin privileges. Keys can be created via the Traffic Ops UI, but they can only be retrieved via the Traffic Ops API. The keystore used by Traffic Vault is <a class="reference external" href="http://basho.com/riak/">Riak</a>. Traffic ops accesses Riak via https on port 8088. Traffic ops uses Riak’s rest API with username/password authentication. Information on the API can be found <a class="reference external" href="http://docs.basho.com/riak/latest/dev/references/http/">here</a>.</p>
</div>
@@ -243,7 +256,7 @@
<a href="../admin/index.html" class="btn btn-neutral float-right" title="Administrator’s Guide">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_server.html" class="btn btn-neutral" title="Traffic Server"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="traffic_stats.html" class="btn btn-neutral" title="Traffic Stats"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -267,16 +280,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/docs/latest/search.html b/docs/latest/search.html
index ec9f3fd..b3c0a5b 100644
--- a/docs/latest/search.html
+++ b/docs/latest/search.html
@@ -1,5 +1,7 @@
+
+
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
@@ -7,7 +9,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Search — Traffic Control 2.1-dev documentation </title>
+ <title>Search — Traffic Control 2.2-dev documentation </title>
@@ -33,7 +35,10 @@
- <link rel="top" title="Traffic Control 2.1-dev documentation" href="index.html"/>
+ <link rel="index" title="Index"
+ href="genindex.html"/>
+ <link rel="search" title="Search" href="#"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation" href="index.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -92,21 +97,22 @@
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_monitor.html">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="overview/traffic_server.html">Traffic Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview/traffic_vault.html">Traffic Vault</a></li>
</ul>
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="admin/index.html">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops - Migrating from 2.0 to 2.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/installation.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_portal/usingtrafficportal.html">Traffic Portal - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor.html">Traffic Monitor Administration (Legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="admin/traffic_stats.html">Traffic Stats Administration</a></li>
@@ -117,15 +123,23 @@
</li>
</ul>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="development/index.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development/building.html">Building Traffic Control</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="development/traffic_monitor.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/traffic_stats.html">Traffic Stats</a></li>
-<li class="toctree-l2"><a class="reference internal" href="development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="api/index.html">APIs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api/traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/routes.html">API Routes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v11/index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v12/index.html">API 1.2 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/v13/index.html">API 1.3 Reference</a></li>
</ul>
</li>
</ul>
@@ -161,9 +175,9 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="index.html">Traffic Control 2.1-dev</a> »</li>
+ <li><a href="index.html">Traffic Control 2.2-dev</a> »</li>
- <li></li>
+ <li>Search</li>
<li class="wy-breadcrumbs-aside">
</li>
@@ -210,16 +224,36 @@
+ <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
- VERSION:'2.1-dev',
+ VERSION:'2.2-dev',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
- SOURCELINK_SUFFIX: ''
+ SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
diff --git a/docs/latest/searchindex.js b/docs/latest/searchindex.js
index 5d7405a..93b8af1 100644
--- a/docs/latest/searchindex.js
+++ b/docs/latest/searchindex.js
@@ -1 +1 @@
-Search.setIndex({envversion:48,filenames:["admin/index","admin/quick_howto/dnssec","admin/quick_howto/federations","admin/quick_howto/index","admin/quick_howto/multi_site","admin/quick_howto/multi_site_ats5","admin/quick_howto/regionalgeo","admin/quick_howto/steering","admin/traffic_monitor","admin/traffic_monitor_golang","admin/traffic_ops/configuration","admin/traffic_ops/default_profiles","admin/traffic_ops/extensions","admin/traffic_ops/installation","admin/traffic_ops/migration_from_10_to_20","admin/traffic_ops/using","admin/traffic_portal","admin/traffic_router","admin/traffic_server","admin/traffic_stats","admin/traffic_vault","basics/cache_revalidation","basics/caching_proxies","basics/content_delivery_networks","basics/http_11","basics/index","development/building","development/index","development/traffic_monitor","development/traffic_monitor/traffic_monitor_api","development/traffic_monitor_golang","development/traffic_ops","development/traffic_ops_api/routes","development/traffic_ops_api/v11/asn","development/traffic_ops_api/v11/cachegroup","development/traffic_ops_api/v11/cdn","development/traffic_ops_api/v11/changelog","development/traffic_ops_api/v11/deliveryservice","development/traffic_ops_api/v11/hwinfo","development/traffic_ops_api/v11/parameter","development/traffic_ops_api/v11/phys_location","development/traffic_ops_api/v11/profile","development/traffic_ops_api/v11/region","development/traffic_ops_api/v11/role","development/traffic_ops_api/v11/server","development/traffic_ops_api/v11/static_dns","development/traffic_ops_api/v11/status","development/traffic_ops_api/v11/system","development/traffic_ops_api/v11/to_extension","development/traffic_ops_api/v11/type","development/traffic_ops_api/v11/user","development/traffic_ops_api/v12/api_capability","development/traffic_ops_api/v12/asn","development/traffic_ops_api/v12/cache_stats","development/traffic_ops_api/v12/cachegroup","development/traffic_ops_api/v12/cachegroup_parameter","development/traffic_ops_api/v12/capability","development/traffic_ops_api/v12/cdn","development/traffic_ops_api/v12/changelog","development/traffic_ops_api/v12/configfiles_ats","development/traffic_ops_api/v12/deliveryservice","development/traffic_ops_api/v12/deliveryservice_regex","development/traffic_ops_api/v12/deliveryservice_stats","development/traffic_ops_api/v12/division","development/traffic_ops_api/v12/federation","development/traffic_ops_api/v12/hwinfo","development/traffic_ops_api/v12/influxdb","development/traffic_ops_api/v12/job","development/traffic_ops_api/v12/parameter","development/traffic_ops_api/v12/phys_location","development/traffic_ops_api/v12/profile","development/traffic_ops_api/v12/profile_parameter","development/traffic_ops_api/v12/region","development/traffic_ops_api/v12/role","development/traffic_ops_api/v12/server","development/traffic_ops_api/v12/static_dns","development/traffic_ops_api/v12/status","development/traffic_ops_api/v12/steering_target","development/traffic_ops_api/v12/system","development/traffic_ops_api/v12/tenant","development/traffic_ops_api/v12/to_extension","development/traffic_ops_api/v12/topology","development/traffic_ops_api/v12/type","development/traffic_ops_api/v12/user","development/traffic_portal","development/traffic_router","development/traffic_router/traffic_router_api","development/traffic_server","development/traffic_stats","faq/administration","faq/development","faq/general","faq/index","glossary","index","overview/index","overview/introduction","overview/traffic_monitor","overview/traffic_ops","overview/traffic_portal","overview/traffic_router","overview/traffic_server","overview/traffic_stats","overview/traffic_vault"],objects:{},objnames:{},objtypes:{},terms:{"00z":[53,62],"03m":[],"06b4f870d809d82a91433e92eae8320875c3e8b0":2,"07033d6d":26,"0x00":10,"0x10001":[],"10g":[12,15,31,44,48,74,80],"10g6":[12,15,31],"10g_ping":[48,80],"10gbp":10,"10t22":53,"11t11":62,"11t12":[53,62],"12m":[46,76],"12t12":[53,62],"16gb":9,"17m":[],"1aa008f":[21,22],"1b08977e91f8f68b0ff5d5e5f6481c76ddfd0853":31,"1gb":10,"1min":19,"200mb":17,"20141222103718_extens":31,"20150108100000_add_job_deliveryservic":31,"20150205100000_cg_locat":31,"20150209100000_cran_to_asn":31,"20150210100000_ds_keyinfo":31,"20150304100000_add_ip6_ds_rout":[],"20150310100000_add_bg_fetch":[],"20150316100000_move_hdr_rw":[],"24h":19,"252f":13,"262f":13,"2gb":17,"2xx":97,"32gb":[],"3rd":[35,37,40,57,60,69],"3xx":97,"4217a5":[44,74],"48h":67,"4gb":13,"4xx":97,"50a3559482cc0":[21,22],"50aa00feadd":21,"567a":15,"567b":15,"56h":[50,83],"5b77f60f":8,"5gbp":10,"5thpercentil":[35,37,57],"72h":67,"73be":[],"8a5a61b91473bc785d4073fe711de8d2c63f02dd":31,"8d65":[],"8gb":[8,17],"95thpercentil":[35,37,57],"98thpercentil":[35,37,57],"9rd":[40,69],"____":30,"__cache_ipv4__":15,"__hostname__":[39,54,68],"__return__":[4,5,15],"_before_":15,"_osvers":15,"_profile":11,"boolean":[29,31,35,37,39,50,54,57,60,68,83],"byte":[15,31,97,102],"case":[],"class":[17,31,85,99],"default":[],"delete":[2,31,51,54,55,56,57,60,61,64,68,70,71,74,77],"enum":[30,51],"export":[10,15,17,19,31,101],"final":[10,17],"float":[53,60,62],"function":[11,15,17,22,24,30,31,84,93,94,98,99,100,102],"import":[],"int":[15,29,35,36,37,40,42,44,50,51,52,53,54,56,57,59,60,62,63,64,67,69,70,72,74,77,79,83],"long":[10,15,17,21,24,50,83],"new":[1,4,5,6,10,13,14,15,17,19,20,21,30,35,42,50,64,70,72,81,83,97,99],"null":[12,34,35,36,37,44,48,50,54,57,58,60,62,74,79,80,83],"public":[10,16,17,19,31,35,47,57,78,103],"return":[15,17,20,29,30,31,35,37,53,57,58,59,71,88,100],"short":[15,17,40,46,54,59,69,74,76,88,96,97,102],"static":[],"super":[13,20],"switch":[14,15],"true":[1,2,8,15,19,31,35,37,39,50,54,57,60,66,68,74,79,83],"try":[10,15,17,31,50,83],"var":[8,9,12,13,17,28,85],"while":[4,5,7,13,15,17,19,23,24,30,31,85],a00:[44,74],a_record:[49,82],aaaa:[15,17,35,37,49,57,60,74,82,83,85],aaaa_record:[49,82],aadata:66,abbreviat:[34,54],abc123def456:57,abil:[2,17,31],abiliti:99,abl:[6,13,15,17],about:[10,13,15,17,19,22,29,36,37,38,47,53,58,60,65,74,78,83,88,100,102],abov:[1,10,11,13,16,17,19,21,84,85,88,93,97],absolut:19,accept:[2,17,31,55,68,71,89],access:[2,6,8,9,10,13,15,17,19,20,31,37,39,44,54,60,68,71,74,83,84,85,88,96,98,103],accesscontrolalloworigin:8,accomplish:15,accord:[14,15,50,83],accordingli:[4,5],account:[31,97],accur:[8,9,16,17],achiev:19,ack:15,acl:[37,60],acquir:[88,102],acronym:17,across:[4,5,10,15,17,23,35,37,57,60],act:[15,22,93],action:[2,15,22,37,54,57,60,74,83],activ:[1,10,15,17,37,47,50,60,74,78,79,83,102],activat:15,active:[15,79],active_directory:[49,82],actor:30,actual:[10,15,17,18,22,97,100],adapter:[44,74],add:[1,2,6,8,10,13,15,17,18,19,20,21,28,31,37,60,64,74,83,85,89,97,98,103],adding:[],addional:31,addit:[13,15,17,24,31,60,93,97],addition:[15,37,60,74,83,85],additional:2,additional_config_json:[48,80],address:[4,5,8,9,10,12,14,15,17,18,22,24,31,37,40,44,45,50,59,60,64,69,74,75,83,85,86,89,100],addressline1:[50,83],addressline2:[50,83],adher:[46,76],adjust:[12,17],admin123:18,admin:[],admin_down:[44,46,60,74,76,97],administ:17,adminpassword:20,adminstr:10,adn:[],advanc:15,aes128:10,affect:[18,97],affili:31,after:[2,10,14,15,17,18,22,24,28,31,85,89,98],afterward:[4,5],again:[21,31,97],against:[6,14,15,17,20,31,97],age:22,agent:[31,50,83],aggreg:[23,30,35,57,96,97],agre:97,aid:15,albuquerqu:[40,69],alert:[2,31,37,40,42,44,48,50,51,52,54,55,56,57,59,60,61,63,68,69,70,71,72,74,77,79,80,83],algorithm:[4,5,15,57],alia:30,alias1:[37,60],alias2:[37,60],alias:[37,60],aliv:[2,31],all:[2,4,5,6,8,10,13,15,17,18,19,20,22,23,26,29,30,31,35,37,47,50,51,54,56,57,60,61,63,64,66,67,68,70,74,77,78,79,83,88,89,91,93,97,98,99,100,101,102],all_graph_url:19,allow:[1,2,6,8,10,13,15,17,18,19,21,23,29,31,37,52,57,60,64,70,74,83,85,88,89,93,97,98,100,101,103],allow_ip6:[8,10],allow_ip:[8,10],almost:15,along:[19,20,30,31],alongsid:[4,5],alreadi:[15,18,20,22,37,60,71,74,83,100],also:[0,10,15,17,18,20,21,30,31,37,60,62,74,83,88,91,93,96,97,98,100],alter:[37,60],altern:[6,60],although:96,alwai:[],amd64:13,among:8,amount:[8,10,15,17,30,50,83],anaconda:[10,15],analysi:23,analyz:96,angularjs:[84,99],ani:[4,5,6,7,10,13,14,15,17,19,20,26,28,30,31,36,47,58,68,70,78,88,97],anonym:19,anoth:[15,17,19,28,85,88,97],another:[17,18],answer:[2,10,13,15,17],anull:10,any:[2,7,15,17,37,60],any_map:[15,60],anyth:[15,38,65],anywai:15,anywher:[15,17],apach:[0,11,14,15,18,20,21,22,30,87,96,97,100,101],apachetrafficserv:22,api:[],apichange:[36,58],apiport:[35,57],apiuri:59,apnic:[33,52],app:[10,12,13,20,31,47,78,84],appear:[15,18,22],appli:[4,5,10,15,28,31,37,49,60,74,82,83,93,101],applic:[2,6,9,10,15,17,18,20,27,28,30,31,44,50,60,74,83,84,85,96,97,98],applicat:[17,30],applicationcontext:85,applicationproperti:85,approach:[1,31,97],appropri:[4,5,10,13,15,17,30],approri:13,approv:10,apr:31,april:96,architectur:[],archive:13,area:[6,23,31],aren:35,argument:31,around:[17,30,100,102],arrai:[19,31,33,34,35,37,41,44,48,50,51,52,53,54,55,56,57,60,61,62,64,66,68,70,71,74,80,83],articl:93,artifact:[26,85],asap:[15,50,83],ascii:10,asdasdasdasfasg:17,ashburn:[40,69],ask:[10,13,18,21,31,97],asn:[],asnsjj:31,aspect:85,assess:96,asset:[16,17,67,97],assettyp:[50,83],asseturl:[50,67,83],assgin:[],assign:[2,4,5,6,7,10,15,17,19,31,37,44,54,55,57,59,60,68,70,71,74,83,89,101],assignment:[],assist:10,associ:[15,35,37,54,55,57,60,64,67,68,71,74,81,83,99,100],associat:[17,20,71],assum:[13,15,19,84,89],assume:[18,22],assumpt:8,assumption:20,astat:[8,10,18,31,93,97],astats_over_http:[10,18],ater:[],atl:66,atlanta:[42,54,66,72],ats:[10,15,17,22,30,31,50,59,83,93,96,97,101],ats_profile:70,atsec:[17,36,44,47,54,58,60,66,74,78,100],atsmid:[38,65],attempt:[15,18,22,100],attribut:[6,10],audio:23,auger:91,august:96,auth:[8,15,31,37,60,74,83],authent:[],author:[],authorit:[13,17,24,100],authority:2,auto:[17,85],autoconf:[],autofil:15,autom:[17,88],automak:[],automat:[8,12,15,18,26],autonom:[15,33,52],avail:[2,8,9,10,15,17,19,23,26,28,30,31,32,34,35,37,46,50,54,57,60,74,76,83,85,94,96,97],availabilti:19,availabl:[],availablebandwidthinkbp:[10,35,57],availableperc:[35,37,57,60],avali:[],averag:[10,53,62,97],avoid:[1,6,17,30],awai:15,await:[],awar:[15,22,101],b3ff:64,b42be0749415cefd1d14e1a91bb214845b4de556:2,back:[4,5,21,31,50,83,97,100],background_fetch:[15,37,60,74,83],backlog:17,backplane:[44,74],backup:[4,5,15],backward:17,bad:[10,74],badass:18,balanc:[17,96],ball:26,bandwidth:[10,15,19,37,53,60,74,83,99,100,102],bar:[19,21,22,24,35,37,39,45,48,57,60,61,67,68,74,75,80,83,100],base64:[37,57,60],base64encodedcrt1:57,base64encodedcrt2:57,base64encodedkey1:57,base64encodedkey2:57,base:[],base_url:[12,31],bash:[12,15,16],basi:[17,88,100,102],basic:[],baz:[37,45,60,74,75,83],bbt:31,bcm5720:[44,74],becaus:[6,10,18,30,100],becom:[],been:[1,2,9,10,13,14,15,17,18,19,20,28,30,85,97],befor:[1,8,10,15,18,35,83,89,98],begin:[8,9,13,14,18,53,62,97,100],behalf:22,behav:15,behavior:[17,97],bell:67,belong:[37,40,42,44,52,60,69,72,74,83],below:[10,12,15,17,18,19,22,24,25,29,31,85,96,97,100,101],best:[13,15,17,19,89,100],beta:[8,9,15,30,31],better:[98,100],between:[4,5,8,12,14,15,17,18,19,30,31,88,93,97,98,100,101],bin:[8,12,13,15,17,18,28,31],binari:[0,17,30],bind:85,bios:[44,74],bit:[10,15],bitbucket:13,blacked_out:6,blacklist:31,blank:[10,15,19],block:[],blue:13,blurb:[],bodi:[7,21,22,24],bond0:[15,44,60,74],bond:15,boo:[37,60,74,83],bool:[35,37,44,54,57,60,74,79,83],boot:10,bootabl:15,bootproto:15,bootstrap:[8,17,31,85],bot:15,both:[4,5,7,8,15,17,22,23,30,31,37,60,68,71,74,83,85,97],bottom:[11,15,18,19,20],bower:84,box:[4,5,17],bp12g:[44,74],bracket:[15,17],brave:15,breach:15,brief:19,broadcom:[44,74],brought:19,brows:[18,28,85],browser:[2,8,9,28,31,98],bucket:20,bug:[30,36,58],build:[],built:[13,26,85],bulk:[],bunch:15,bundl:[17,20,101],busi:[37,60,97],businessunit:[37,60],button:[1,2,7,11,15,19],bypass:[15,17,37,60,74,83],bypassdestin:[35,57],c0a8:17,cabl:91,cacertfil:20,cach:[],cache01:22,cache_group_edg:[54,74],cache_group_mid:54,cache_range_request:[15,37,60,74,83],cache_stat:[],cachegroup:[],cachegroup_graph_url:19,cachegroup_id:55,cachegroupid:[44,52,54,55,60,74],cachegroupnam:54,cachegroupparamet:[],cacheretentionpolici:19,cachestat:29,cacheurl:[15,37,60,74,83],cahc:18,calcavail:30,calcul:[8,15,30,88],call:[8,10,12,14,15,17,19,30,31,91,97,100],callahan:[50,83],can:[],canadian:6,cannot:[37,60,74,83],capabl:[],capac:[15,35,37,57,60,96,97,99],captur:[15,74],care:[15,17,19,50,83,98],carri:100,carton:31,catalina:17,catalina_base:8,catalina_home:8,catalina_opts:17,catalina_pid:8,catalina_tmpdir:8,categori:[36,58],caus:[15,50,83,97],caution:15,cb00:13,ccp:64,ccr1:[70,71],ccr:[],ccr_cdn1:[],ccr_cdn:[],ccr_copy:70,ccr_ignore:[46,74,76],ccr_top:[41,68],ccr_update:[],ccrdnsttl:[37,60,74,83],ccsi:22,cdn1:[13,15,35,57,70],cdn2:[35,57],cdn3:57,cdn:[],cdn_1:59,cdn_eng:[37,60],cdn_id:59,cdn_name:[],cdn_number_1:[54,74],cdn_test2:57,cdn_test:57,cdnid:[37,44,54,57,59,60,74,83],cdnlab:[17,47,78],cdnname:[8,15,28,35,37,44,53,57,59,60,70,74,83],cdu:[12,15,31],cen:[38,65],cent6:6,cento:[13,14,15],centos65:10,centos96:13,centos:[],central:[23,63],cert:[],certain:[29,31,85,103],certainli:15,certfil:20,certif:[],cfg:[9,10,15,19,30],cfg_:15,cg_edg:54,cgw:54,chain:[],challeng:10,chang:[],changeabl:[],changelog:15,channel:[30,91],charact:[6,17],charset:[21,22,24],chart:[84,99,102],check:[],check_extension_bool:[31,48,80],check_extension_num:31,check_nam:12,checkpath:[37,60,74,83],chi:[6,17,44,54,60,74,101],chicago:[34,44,54,60,74],child:[4,5,15,54,74],chkconfig:[8,18],chmod:[14,18],choic:[14,17],choos:[1,2,11,15,19],chosen:[1,6,15,96],chown:[10,14],chr:[12,15,31],cidr:[6,10],cipher:10,circular:30,cisco:91,citi:[10,13,17,37,40,50,60,69,83],clarif:[17,24],classless:6,classpath:8,clean:[28,85],cleaner:18,clear:[10,31],cli:84,click:[1,2,4,5,6,7,8,11,15,17,18,19],clickabl:15,client:[2,6,15,17,21,22,24,30,35,37,46,57,60,74,76,83,84,85,88,93,96,97,99,100,101],client_connect:102,client_steering:60,clone:[20,28,30,31,84,85,88],cloog:[],close:[2,15,21,22,30,97],closest:[85,93,96,100],closur:30,cluster:[19,20,101],cmc:[34,54],cmd:[2,13],cms_interfac:12,cname:[2,15,17,60,64],cname_record:[45,75],cnames:15,coalesc:10,coalesce_masklen_v4:10,coalesce_masklen_v6:10,coalesce_number_v4:10,code:[6,10,13,15,17,28,30,31,37,46,60,74,76,83,85,88],codebas:[28,85],codepoint:31,coexist:100,collect:[10,17,19,28,30,31,33,34,35,37,44,47,48,50,51,52,54,55,56,57,60,61,68,70,71,74,78,80,83,96,98],collector:17,collis:31,colorado:[37,60],column:[12,15,31,53,62],com:[6,13,15,16,17,18,21,22,24,26,28,30,31,35,37,40,48,50,57,59,60,61,69,74,80,83,85,89,100],combin:[],combinedst:30,combinest:30,comcast:[17,28,85,89,91,96],come:[15,21,30,31,37,60],comma:[10,15,29],comman:[],command:[1,8,13,17,18,19,20,26,31],comment:[10,16,40,47,69,78],common:[0,10,13,24,30,31,60,97,100],commonli:[21,28,30,31,84,85,88],commun:[17,22,31,85,91,101],compani:[10,13,18,50,83],compar:15,comparison:[10,101],compass:84,compat:[15,50,83],compil:[30,31],complet:[0,8,13,15,17,18,24,30,31,60,85],complianc:22,complic:[3,97],compon:[11,15,17,19,26,94,95,96,97,98],comprehens:[13,24],compris:85,comput:[19,30],computation:17,concaten:[15,31],concept:[11,25,100],concurr:[17,91],cond:[4,5],condit:[15,17,50,83],conf:[8,9,10,13,15,16,17,19,20,28,31,84,85],config:[],config_fil:[15,35,39,54,57,68,71],configdoc:29,configfil:[],configfile1:[68,71],configfile2:[68,71],configur:[],confirm:[10,15],confirmlocalpassword:83,conjunct:[15,97],connect:[2,8,9,13,14,15,17,18,19,21,22,23,24,31,35,57,97,100],connect_attempts_max_retri:[4,5],connect_attempts_max_retries_dead_serv:[4,5],connect_attempts_timeout:[4,5,15],connector:85,consequ:85,consid:[4,5,10,15,30,37,60,97,100,101],consist:[4,5,15,17,19,23,85,93,97,98,100],consisten_hash:15,consistent_hash:15,consol:[14,28,85],construct:[15,30,96],consult:19,consum:[15,23,27,29,31,84,97,99],contact:[31,40,69],contain:[8,9,10,15,17,24,26,28,30,84,85,88,96,101,102],content:[],contentrout:81,contentserv:81,contenttyp:[37,60],context:22,continu:[11,19,24,30,88,89],contribut:31,contributing:[30,90],control:[],conveni:85,convent:[],convers:[14,15],convert:[10,17],cooki:[2,7,20,31,50,83],cookie:20,cool:[37,60,74,83],coordin:[10,35,57,100,101],copi:[15,16,17,19,26,70],copyright:31,core:[15,17,85],corpor:[31,37,60],correct:[9,15,17,19,20,30,31,59],correctli:[15,17,19],cost:[30,100],could:[10,15,17,30],count:[8,15,29,35,37,44,53,57,62,74],counter:97,countri:[10,13,37,50,60,83],coupl:[17,20],cover:56,coverag:[],coveragezon:[15,35,57],coveragezonejsonurl:15,coveragezoneonli:[35,57],cox:91,coyot:100,cpan:[10,13,31],cpanfil:31,cpld:[44,74],cpp:[],cpu:17,cqhm:[6,17],cqhv:[6,17],cr_bar:[35,57],cr_foo:[35,57],cran:32,crconfig:[],creat:[],create:13,create_network_lin:15,create_ts_databas:19,createdb:13,createdbi:67,createstat:30,creation:[51,56,57,61,77,83],credenti:[2,17,18,31,85],critic:[17,97],cron:[],cronjob:31,crontab:[12,18],cross:[36,58],crossdomain:[15,37,60],crstate:[8,29,30],crt:[10,17,20,37,57,60,103],crypt:18,cryptograph:[17,57],csp:30,csr:[10,37,60,103],css:[16,31],csv:15,cti:31,curl:[2,7,8,16,17,20,31],current:[1,6,8,12,15,17,20,29,30,31,36,50,58,67,81,83,86,88,96,102],current_client_connect:[15,53,102],currentgbp:[35,57],custom:[15,16,18,19,31,37,60,74,83,88,97,98],customiz:98,cycl:[8,17],czf:[15,17,37,60,74,83],czm:93,czmap:17,d0d0:[44,60,74],d1s2:[44,74],d1s4:[38,65],d6xpdv1:[44,74],d903:[44,74],dai:[1,10,15,19,24,35,36,57,58,83,88,102],daili:[],daily_bw_url:[15,19],daily_served_url:[15,19],daily_stat:[19,102],dailysummarypollinginterv:19,dailysummaryretentionpolici:19,danc:17,dash:[6,17],dashboard:[19,88],data:[],databas:[],datacran:32,datadeliveryservic:32,datadeliveryserviceserv:32,datadomain:32,datahwinfo:32,datalink:32,dataloc:32,datalocationparamet:32,datalog:32,dataparamet:32,dataphys_loc:32,dataprofil:32,dataregion:32,datareq:30,datarol:32,dataserv:[32,35,57],dataserverdetail:32,datastaticdnsentri:32,datastatu:32,datatyp:32,dataus:32,date:[1,2,15,17,18,21,22,31,33,34,35,38,39,41,44,46,50,52,53,54,57,60,62,65,68,70,74,76,83,100],dbconf:[13,31],dbix:31,dcchi:[34,54],deactiv:15,dead:[],dead_server_retri:15,dead_server_retry_en:[4,5],dead_server_retry_response_cod:[4,5],deal:97,debug:[2,8,18],dec:[2,21,22],decim:[17,60],decis:[85,100],decod:30,decreas:17,deem:30,defin:[4,5,6,8,10,15,17,31,85,101],degre:[17,60],del:[37,60,74,83],delai:[8,85],deleg:[13,17],delet:[2,10,15,20,21,31,35,37,48,51,54,55,56,57,60,61,64,68,70,71,74,77,80],delimit:[15,85],deliv:[15,18,23,91,100],deliveri:[],deliveryprotocol:[37,60],deliveryservic:[],deliveryservice_graph_url:19,deliveryservice_serv:60,deliveryservice_stat:[],deliveryservice_us:60,deliveryservicedata:30,deliveryserviceid:[6,77],deliveryservicenam:62,deliveryserviceserv:[32,37,60],dell:[44,74],demand:[17,37,60],demo:[],den:101,deni:[6,60],denial:17,denorm:30,denver:[10,13,35,37,42,45,57,60,72,75],depend:[1,13,15,17,30,31,77,84,88],dependeci:13,deploi:[10,18,23,47,74,78,85,94,97,101],deploy:[17,30,85],deprec:[44,74],depth:10,dequeu:[54,57,74],deriv:[15,17],des3:10,descend:67,describ:[15,17,22,37,47,56,60,64,74,78,83],descript:[4,5,8,10,13,15,17,19,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83],deserli:30,design:[30,84,98,99],desir:[7,15,17,37,60,62,100],destin:[15,17,23,37,60,74,83,94,97],detail:[0,8,9,10,15,17,24,31,32,36,37,44,51,52,54,56,57,58,60,74],detect:97,deteremin:15,determin:[15,17,30,31,85,93,97,98,100],dev:[10,12],devel:[],develop:[],devic:[10,15,93],dhcp:15,diag:[],diagnost:[44,74],diagram:96,dialog:15,did:[17,21],diff:[6,15,89],differ:[4,5,10,15,17,18,19,20,22,24,30,97,98,101,102],differenti:[37,60,74,83],diffserv:31,dig:[1,2,17],digest:57,digesttyp:57,dilig:17,dimens:97,dir:[14,17],direct:[22,93,101],directli:[15,17,20,22,26,93],directori:[],disabl:[17,57,60],disallow:6,disclaim:[],discuss:100,disk:[8,10,13,15,31,38,44,65,74,100],dispatch:30,dispers:[10,18,60],displai:[2,8,12,15,19,28,29,37,44,60,74,83,85,102],displaynam:[37,60,74,83],disregard:8,dist:[13,14,26,84],distanc:[96,100,101],distinguish:[4,5,10],distribut:[0,10,17,18,23,30,85,91,94,100],divers:97,divert:15,divis:[],division_nam:[42,72],divisionid:[42,72],divisionnam:[42,72],divsionid:[42,72],dns:[],dns_live:15,dns_live_national:[],dns_live_natnl:15,dnsbypasscnam:[37,60,74,83],dnsbypassip6:[37,60,74,83],dnsbypassip:[37,60,74,83],dnsbypassttl:[37,60,74,83],dnskey:[15,17,57],dnssec:[],dnssecenabl:[35,52,57],dnsseckei:[15,35,57],doc:[15,26,30],docker:[],document:[3,13,15,17,19,20,22,31,66,87,91,94,97,101],doe:[4,5,8,10,15,17,22,24,30,31,37,40,60,69,71,74,83,93,96,100,101,102],doesn:[15,17,21,30,31,81],doesssss:[40,69],domain:[],domain_nam:[15,31,35,39,57,68],domainnam:[12,35,44,57,60,74],don:[10,15,31,35,89],done:[2,15,17,20,28,30,84,89],doubl:17,down:[4,5,8,15,18,26,31,37,46,60,76,100],download:[8,9,11,13,14,15,16,18,19,20,26,28,59,85],downsampl:[19,88],downstream:[15,21,37,60,74,83],drill:15,drive:[15,74,88,102],drive_config:15,drive_lett:[10,39,54,68],drive_prefix:10,driver:[44,74],drop:[4,5,15,31,37,60,74,83,97],dropdown:19,ds1:57,ds2:57,ds_1:[],ds_bypass:17,ds_client_geo_unsupported:17,ds_cz_only:17,ds_miss:17,ds_no_bypass:17,ds_not_found:17,ds_redirect:17,dscp:[],dsid:[44,50,60,61,67,74,77,83],dsname:[61,100],dsr:[35,37,57,60],dsrecord:57,dsretentionpolici:19,dsstat:[29,30],dsxmlid:[50,83],due:[15,37,60,74,83,97],dummi:89,dummyxmpp:[44,74],dump:15,duplic:[10,101],durat:15,dure:[8,10,15,17,18,28,31,85],dynam:15,each:[0,4,5,8,10,11,12,13,15,17,19,20,26,29,30,31,35,36,37,54,57,58,60,81,96,97,100,101],earth:93,easi:15,easier:[10,31,85],easiest:26,easili:[19,30],east:[40,69,101],echo:15,eclips:[28,85],econom:[23,94],edg:[1,2,8,15,17,18,35,37,46,54,57,60,74,76,83,85,89,93,100,102],edge1:10,edge1_cdn1_421:74,edge1_cdn1_421_ssl:[44,60,74],edge1_top_421_pspp:66,edge:[0,4,5,8,10,15,18,22,31,37,44,46,48,60,74,76,80,83,89,97,100,101,102],edge_27_profile:70,edge_28_profile:70,edge_ats_:11,edge_cdn_1_example:59,edge_loc:54,edgeheaderrewrit:[37,60,74,83],edgeloc:81,edh:10,edit:[2,8,10,12,13,15,17,19,28,31,47,51,52,54,56,57,60,68,70,74,78],editor:10,ee14bb:18,effect:[1,6,15,17,20],effectiv:[1,15],effici:[30,37,60],either:[7,15,17,20,100],el6:[2,8,18],el7:[13,14,26],element:[6,96],elig:[60,100],els:[17,19],email1:[50,83],email:[10,15,37,40,50,60,69,83],emailto:[37,60],embed:[28,31,85],emit:18,empti:[6,17,70],enabl:[1,4,5,6,10,13,15,17,18,20,35,37,52,57,60,74,83],enclos:17,encod:[35,37,57,60],encompass:23,encourag:30,encrypted:13,end:[15,17,22,23,29,30,31,35,37,53,57,62,93,100],end_dat:[35,37,57],enddat:[53,62],endpoint:[],endtim:29,enform:[],engin:[14,26],engineer:[37,60],enhanc:[31,98],ensur:[8,9,10,15,16,17,23,97],ensure:[17,28,85],enter:[1,9,10,13,15,17,19,31,37,44,60,74,89],entere:[15,50,83],enteredtim:[50,83],enterpris:[10,19,44,74],entir:[17,22,30],entri:[],entry:[15,37,60],enumer:30,env:[14,31],enviro:31,environ:[],epel:13,epoch:[15,17,29,35,57],equal:[6,17,68,71],equival:[30,31,46,76],err:[35,37,57,60],error:[],errorcount:30,especi:100,especial:89,essenti:24,establish:17,etag:[21,22],etc:[10,12,15,16,17,20,28,30,31,59,85,88,97,98],eth0:[12,74],eth4:15,ethernet:[15,44,74],evalu:[15,61,97],even:[23,31,89,94,98,101],event:[],eventlog:29,eventu:[28,85],everi:[9,10,15,17,18,23],everyth:[0,15,20],examp:71,exampl:[],exampleurl:[37,60,74,83],exce:97,exceed:[15,37,60,74,83,97],except:[4,5,15,17,100],exclud:[6,15,74,100],excludepostalcod:6,exclus:6,execut:[10,28,30,31,85],exist:[6,8,15,17,28,29,30,31,35,60,68,70,71,85],exit:[8,13,18],exp:[44,74],expand:[28,85],expat:[],expect:[13,15,17,18],expens:[15,50,83],experi:17,experienc:15,experiment:[15,17],expir:[1,2,15,17,21,31,35,57],expirat:[1,15,35,57],expirationd:[35,57],expire:[15,21,50,83],explain:[20,96],explainat:15,explainatori:15,explanat:13,explicit:22,explicitli:[21,97,98],explor:[28,85],expos:[98,102],expres:15,express:[10,15,17,50,83,84],expression:[],extend:[6,93],extens:[12,15,17,27,31,48,80,93,98],extension:[],extensioncheck:12,extensionnam:31,extern:94,extra:10,extract:14,extrem:[17,97],eyjhdxrox2rhdgeioijhzg1pbiisimv4cglyzxmioje0mjk0mdqzmdz9:31,eyjlehbpcmvzijoxndi5ndaymjaxlcjhdxrox2rhdgeioijhzg1pbij9:31,eyjlehbpcmvzijoxndi5ndazodyzlcjhdxrox2rhdgeioijhzg1pbij9:31,eyjlehbpcmvzijoxndq5mta1mti2lcjhdxrox2rhdgeioijmzwrlcmf0aw9ux3vzzxixin0:2,eyjlehbpcmvzijoxndq5mta1otqylcjhdxrox2rhdgeioijmzwrlcmf0aw9ux3vzzxixin0:2,f990d03b7180b1ece97c3bb5ca69803cd6a79862:31,fact:[10,15,97,101],factor:[4,5,100],fail:[4,5,6,15,17,26,31,71,97],fail_threshold:15,failov:[4,5,15,37,60],failur:[],fairli:15,fall:100,fallback:6,fals:[8,15,17,35,37,39,44,50,54,57,60,68,74,79,83,97],familiar:25,fast:97,faster:30,fatal:18,fe1e:64,fe80:64,featur:[],fed:[17,60],fedeat:2,feder:[],federation_user1:2,feedback:17,fetch:[6,15,17,18,30,68],fetchcount:30,fetcher:30,few:10,ffff:17,field:[],fifthpercentil:[53,62],file:[],filenam:[15,59],filepol:30,fill:[6,10,15,91],filter:[7,17,44,49,52,54,60,67,69,70,72,74,82],find:[15,17,22,28,85,93,100],finish:[28,85,97],firmware:[44,74],first:[4,5,6,7,10,13,15,17,18,84,96,100,102],fix:[18,88],fixtur:31,flag:[2,6,10,15,18,19,30,37,68,71],flow:30,flush:9,fmt:88,fnameondisk:59,folder:10,foll:15,follow:[1,2,4,5,6,8,9,10,12,13,14,15,16,17,18,19,20,22,23,24,28,30,31,37,84,85,88,94,100,103],foo:[7,15,19,21,22,24,35,37,39,45,48,54,57,60,61,67,68,70,74,75,80,83,100],foobar:[41,68],foober:[37,60],fooconfig:[39,68],footprint:91,forc:[10,13,15,50,83],forcesystemexit:8,form:[0,8,15,17,30,31,59,91],format:[],former:10,forum:[],forward:[],found:[2,8,17,19,20,22,24,30,31,37,60,74,83,103],four:[4,5,85,97],fqdn:[8,9,10,12,13,15,17,28,31,35,37,44,57,60,74,83,85,100],frag:97,framework:[31,98],fred:15,free:[30,31],freeform:[38,65],frequenc:[8,17],frequent:[17,30],fri:[47,78],from:[],fsa:6,fulfil:[24,31],full:[4,5,10,13,15,17],fulli:[17,31],fullnam:[50,83],fullscreen:19,fun:[21,22,24,100],further:[2,4,5,6,15,30,31,96],futur:[10,14,17,30,96],gain:100,garbag:17,gatewai:[15,44,60,74],gateway:15,gather:[29,31,85,102],gbp:[15,37,60,102],gcc:[],gcm:10,gener:[],genisoimag:[],genrsa:10,geo2:6,geo:[],geo_no_cache_found:17,geoblock:[17,60],geoenabl:[35,57],geograph:[23,97,101],geographi:[15,97],geoip2:17,geoip:13,geolimit:[],geolimitcountri:[37,60,74,83],geolimitredirecturl:[37,60,74,83],geolit:13,geolite2:13,geolitec:10,geoloc:[6,10,15,17,35,57,60,85,86],geolocation6:[10,35,57],geoprovid:[37,60,74,83],get:[],gettext:[],gid:[50,83],gigabit:[37,44,74],git:[13,15,28,30,31,85,88],github:[18,20,30,31,89,91],githubusercont:18,give:[15,18],given:[2,8,10,15,17,22,30,31,35,50,57,83,97,100],global:[2,10,15,19,37,47,60,74,78,83,97],globalmaxmbp:[37,60,74,83],globalmaxtp:[37,60,74,83],gmt:[2,15,21,22,31,100],go1:13,goal:23,goe:[4,5,15,17,37,60],gofmt:30,golang:[],good:[15,18,31,89,91],googl:[],googleapi:13,goos:[13,31],gopath:[19,30,88],goroutin:30,got:[2,15],gototarget1:7,govern:97,grafana:[15,19,88,102],grafana_url:19,grafanahost:19,grant:[20,31],graph:[],graphic:15,greater:[10,17,20,30,88],green:[19,96],grei:15,group:[],grow:17,grunt:84,guarante:10,gui:30,h710p:[44,74],hack:[8,15,35,57],had:21,hand:15,handl:[],handler:30,handlerfunc:30,handshak:[15,17],happen:17,hard:[10,15],hardcod:31,harden:98,hardwar:[],hardwareinfo:[44,74],hash:[4,5,15,17,35,37,44,47,50,51,52,53,54,56,57,60,62,74,78,81,83,85,93,100],hashid:[35,57],hasnegativecachingcustom:[37,60],hasoriginaclwhitelist:[37,60],hasorigindynamicremap:[37,60],hassignedurl:[37,60],hat:[10,15,21,22],have:[2,4,5,7,10,13,14,15,17,19,20,21,22,24,31,68,85,88,89,97,100,101,103],hdr_rewrit:[4,5],hdr_rw_:15,hds:15,head:15,header:[],header_regexp:15,header_rewrit:15,headerrewriteedg:[37,60],headerrewritemid:[37,60],headerrewriteredirectrout:[37,60],health:[],healthhistori:30,healthi:[15,96],healthiter:30,healthparam:[8,35,57],heap:17,heart:15,heartbeat:30,heath:8,help:[],helper:31,here:[3,10,11,15,19,20,31,37,47,50,60,78,83,91,103],hierarchi:100,high:[10,19,31,35,40,57,69],higher:[4,5,10,15,19,93],highest:[10,13,30],hint:15,hire:[],histor:8,histori:[15,29,35,57],hit:[10,15,21,31,37,60,74,83,97,100],hls:15,hmac_md5:15,hmac_sha1:15,hold:[30,85],home:[19,31],homebrew:31,honor:[17,21,85],hook:31,hop:[91,100],horizont:[17,100],host:[8,9,10,13,15,17,18,19,20,21,22,24,31,37,44,45,60,74,75,83,85,100],host_id:59,host_nam:[15,31,44,74],host_regexp:[15,37,60,61,74,83],hostnam:[],hostname:15,hot:97,hou:101,hour:[15,17,50,83],hover:15,how:[],howev:[12,15,17,30,98],html:[6,21,22,24,30,48,67,80,84,100],http11protocol:85,http:[],http_live:15,http_live_natl:[],http_live_natnl:15,http_no_cache:15,httpbypassfqdn:[37,60,74,83],httpd:[],httpfetcher:30,httpmethod:51,httponly:[2,31],httppoller:30,https:[],httpsport:[44,60,74],human:[13,15,44,60,74],hundr:[10,23,101],hurt:13,hwinfo:[],hypertext:24,hypnotoad:10,icon:15,idb:19,idcopyfrom:70,ide:[28,85],idea:89,ident:15,identifi:[10,15,21,31,33,34,35,36,38,44,52,54,57,58,60,65,67,74],idiomat:30,ifconfig:13,ignor:[15,17,37,60,74,83],ignore:15,illustr:[24,96],ilo:[12,15,31,48,80],ilo_ip_address:[31,48,80],ilo_ping:[48,80],iloipaddress:[12,44,60,74],iloipgatewai:[44,60,74],iloipnetmask:[44,60,74],ilopassword:[44,60,74],ilousernam:[44,60,74],imag:[2,4,5,15,26,31,47,78,91,100],image:31,img:[2,50],immedi:15,impact:[15,97],imper:17,implement:[15,32,94,96],improv:[15,17],inaccess:[10,15,50,83],inact:[37,60,74,79,83],inc:[13,44,74],incept:17,inceptiond:[35,57],includ:[6,8,10,15,22,28,30,31,37,46,60,74,76,83,84,85,97,99,100],includepostalcod:6,incom:17,incorpor:[10,31],incorrect:59,incub:[14,18,26,30],incubat:96,independ:[30,97],index:[15,20,68,71,96],indic:[6,15,21,24,31,44,60,74],individu:[15,17,19,97],inf:85,influenc:[15,17,21,97,102],influx:19,influxdata:[],influxdb:[],influxdb_tool:[19,88],influxpassword:19,influxurl:19,influxus:19,info:[],info_url:[48,80],inform:[1,9,10,13,15,17,18,19,20,22,28,29,30,31,35,37,47,57,60,74,78,83,85,86,89,97,98,100,101,103],informat:[15,19,103],infourl:[10,37,47,60,74,78,83],infrastructur:26,infuxdb:19,init:[17,20,85],initdb:13,initi:[9,15,18,31,50,67,74,83,89],initial:60,initialdispers:[37,60,74,83],initiatingheapoccupancyperc:17,inlin:[15,16],input:[15,31,100],insecur:31,insert:[22,24,30,100],insight:[84,97,99],inspection:17,instal:[0,8,9,10,12,13,14,15,16,17,18,19,20,26,28,30,31,47,78,84,85,88,89,100],install:[],installat:[],instanc:[9,10,13,14,15,28,31,37,44,47,60,74,78,83,84,85,88,97,100],instance_nam:[10,47,78],instead:17,instruct:[8,9,10,13,14,19,20,37,60,85],intact:[14,31],inted:15,integ:[7,54,57,68,71,74],integr:[11,19,31,85,94,95],integrat:[31,44,74,85],intel:[44,74],intend:[6,15,96],intent:15,inter:6,interact:[18,98],interest:[17,22],interf:100,interfac:[10,15,18,31,44,60,74,85,96,97,98],interfacemtu:[44,60,74],interfacenam:[35,44,57,60,74],intermedi:17,intern:[7,15,17,20,30,46,76,91,94,96],internal:31,internet:[17,22,23,94,100],interv:[6,8,9,15,17,19,30,31,35,57,96,97,98,102],intervent:15,introduc:95,introduct:[],intruct:19,invalid:[],invoc:8,invok:[],involv:[],ip6:[35,57],ip6_address:31,ip6address:[12,44,60,74],ip6gatewai:[44,60,74],ip_address:[31,48,80],ip_allow:[10,15],ipaddr:15,ipaddress:[12,44,60,74,86],ipaddrr:15,ipgatewai:[44,60,74],ipnetmask:[44,60,74],ipv4:[2,6,10,12,15,17,22,24,31,37,44,60,64,74,83,85,86,89],ipv6:[2,10,12,15,17,31,37,44,60,64,74,83,85,86,89],ipv6addr:15,ipv6gatewai:15,ipv6routingen:[37,60,74,83],ipwhitelist:6,isact:[48,80],isn:30,iso8601:[53,62],iso:[],isolinux:10,isp:15,issu:[15,18,85,89,97,100],item:[10,17,29,37],iter:31,itself:[17,27,30,31],ivh:19,jan:100,jane:[40,69],jar:[8,85],java:[],javascript:[30,31,84,88],jdk:[20,28,85],jdog24:67,jeff:[],jenkin:17,jetti:[28,85],jmx:85,job:[],joe:19,jpg:[50,83],jre_home:8,json:[],junit:[28,85],just:[13,15,29,37,60,74,83],jvd:[10,31],jvm:17,kabletown:[],kabletown_cdn:[8,13],kbaletown:[36,58],kbp:[30,37,62,102],keep:[2,10,13,15,18,31,71,96,100],kei:[],kepler:[28,85],kept:[8,17,31,96],keyfil:20,keypair:[35,57],keystor:[15,17,103],keysus:20,keyword:[10,50,67,83],kick:97,kickstart:[],kickstart_create_network_lin:15,kickstart_drive_config:15,kill:17,kind:[15,17],kl0tevax:8,know:[10,15,100],knowledg:17,known:[15,97],ks_script:15,ksk:[1,15,17,35,57],kskexpirationdai:[35,57],l4s:6,l9v:6,l9w:6,label:[17,35,37,57],lacp:15,lai:17,laika:31,lambda:30,land:15,larg:[10,17,23,30,97,100],larger:[93,100],last:[8,15,17,21,22,31,33,34,38,39,41,44,46,52,54,60,65,68,70,74,76],last_upd:[34,39,54,68],lastest:19,lasthealthdur:30,lasthealthdurationsthreadsaf:30,lasthealthendtim:30,lastkbpsstat:30,lastupdat:[31,33,34,35,36,37,38,40,41,42,44,46,49,50,51,52,54,56,57,58,60,63,65,68,69,70,72,74,76,79,82,83],lat:15,latch:15,latenc:[17,22,97],later:[6,15,19,28,31,97],latest:[6,10,20],latitud:[15,17,34,35,37,54,57,60,74,83],latter:10,launch:15,lax:[47,78,101],layer:[15,37,60,93,100],ldap:13,ldns:[22,24,100],learn:22,least:[1,13,15,89],leav:[10,15,19],left:[10,15,31],length:[2,17,21,22,24,31,100],lenienc:8,less:[10,15,19,37,60,88,97,100,102],letter:[10,13,15],level:[1,2,12,15,17,26,30,31,35,36,37,40,42,44,48,50,51,52,54,55,56,57,58,59,60,61,63,68,69,70,71,72,74,77,79,80,83,97,100],leverag:96,liamstask:13,lib:[12,13,31],libcurl:[],libgomp:[],libidn:[],libpcap:[],librari:[],libtool:[],license:91,life:10,lifecycl:[44,74],lifetim:10,light:[31,44,60,74],lighten:[10,47,78],like:[10,13,15,17,18,19,21,30,31,93,98,100],limit:[10,15,37,54,58,60,67,74,83,100],line:[10,15,18,19,20,26,31,37,60,74,83],linear:15,link:[15,88,100,102],lint:88,linux:[10,13,15,28,30,31,84,85,88],list:[2,4,5,6,10,12,15,18,22,26,29,30,31,35,37,46,48,50,57,60,64,76,80,81,83,85,86,91,100],list_bucket:20,list_kei:20,listen:[10,15,20,30,31,44,60,74,85],listen_address:13,live4:6,live51:6,live5:6,live5_low_bitr:6,live:[6,15,17,24,30,31,35,50,57,64,83],load:[10,15,17,20,26,31,47,48,78,80,96,97,100],load_schema:31,loadavg:[10,35,57],loadbalanc:15,loader:[],local0:12,local:[],localcachestatu:30,localhost:[2,10,12,13,19,28,31,84,85],localpassword:83,localst:30,localus:[50,83],locat:[],location1:[40,69],lock:30,log4j:[15,17],log4perl:[],log:[],log_level:[12,18],logic:[6,10,101],login:[2,7,8,13,15,19,20,31,50,83],login_dispers:18,logo:[10,47,78],logourl:[10,47,78],logout:[15,50,83],logsenabl:[37,60,74,83],longdesc1:[37,60,74,83],longdesc2:[37,60,74,83],longdesc:[37,60,74,83],longer:[10,15,24,30,50,74,83,85],longest:10,longitud:[15,17,34,35,37,54,57,60,74,83],look:[20,22,24,30,31,100],lookup:[12,15,17,37,60,74,83],loop:6,lot:[15,18,30,89],low:17,low_bitr:6,lower:[4,5,10,17,100],lowest:100,ltd:10,m3u8:[6,17],machin:[17,85],macos:[28,30,31,84,85,88],made:[2,4,5,15,17,18,19,31,36,50,58,83],mai:[1,4,5,12,13,14,15,17,18,30,31,50,83,85,96,97],mail:[10,91],main:[15,22,28,31,44,60,74,85],maintain:10,mainten:[15,37,60,74],maintenanceperc:[35,37,57,60],major:[18,23,30,94],make:[6,8,9,10,13,14,15,17,18,19,23,31,35,37,50,60,74,83,85,88,89,94,97,100,101],makedispatchmap:30,manag:[],mangement:31,mani:[10,15,17,18,23,30,31,50,83,94,97,98,100],manipul:15,manner:[31,98],manual:[],manufactur:[44,74],map:[2,15,22,24,30,35,37,51,57,60,64,86,89,93,100],mar:[47,78],mark:[15,30,31,37,60,74,83,97],masklen:10,master:31,match:[6,8,10,12,13,15,17,21,22,24,31,48,50,74,80,83,101],matchlist:[35,37,57,60,74,83],matchset:[35,57],matchtyp:[35,57],matter:[15,17],matur:[],maven:[28,85],max:[2,12,15,17,21,31,35,37,50,53,57,62,83,102],max_simple_retri:15,max_unavailable_server_retri:15,maxdnsanswer:[37,60,74,83],maxdnsipsforloc:[35,57],maxgbp:[35,57],maximum:[10,15,17,21,31,37,44,60,74,83],maxkbp:[53,102],maxlibrarysizeestim:[37,60],maxmind:[13,17,60,93,100],maxrevaldurationdai:10,mayb:22,mbp:15,md5:[10,13,15],mean:[4,5,10,15,17,18,21,35,37,57,60,74,83,97],meant:[19,103],measur:[37,60,100,102],mechan:[15,17],media:[10,23,91,94],median:37,mega:2,member:9,memori:[15,17,30],mention:19,menu:[],merg:97,messag:[],met:[37,60],metadata:59,meter:100,method:[2,10,15,17,31,37,50,60,83,99],metric_typ:[35,37,57],metrictyp:[53,62],mgmtipaddress:[44,60,74],mgmtipgatewai:[44,60,74],mgmtipnetmask:[44,60,74],microthread:30,mid1:10,mid:[0,4,5,8,10,15,18,22,37,44,46,47,60,74,76,78,83,89,93,101],mid_ats_:11,mid_loc:[34,54],middl:22,midheaderrewrit:[37,60,74,83],midnight:102,might:[15,17,18,31,97],migrat:[],miker:10,mile:[10,40,69],million:[23,94],millisecond:[15,17,29],min:[10,17,35,37,53,57,62],mind:31,mine:[88,102],mini:[44,74],minim:[10,13,14,22,23,85],minimum:[],minut:[10,13,15,18,24,31,85,98],misc:[2,10,15,20,31],miscellan:[15,28,31],miss:[15,17,35,37,57,60,88,97,101],misscoordin:[35,57],misslat:[37,60,74,83],misslong:[37,60,74,83],mix:10,mkdir:[10,18],mkisof:15,mmdb:[13,17],mnt:15,mod:[],mod_ssl:[],mode:[8,10,18,26,31],model:[44,74],modif:15,modifi:[14,15,17,21,22,50,83,84,85],modul:[8,13,18,85],modulu:10,mojo:31,mojo_mode:31,mojolic:[],mojolici:[2,7,31,98],mojoplugin:31,monitor:[],monitorconfig:30,monitorconfigpol:30,monthli:19,morbo:31,more:[1,3,10,15,17,19,20,22,24,30,31,37,44,47,50,60,74,78,83,91,97,100,101],most:[10,12,15,17,21,28,30,31,44,60,74,84,85,88,100],mostli:[15,17,22,30,31],mount:15,move:[15,30,96,100],movi:[15,91],mp4:17,mpfr:[],msec:2,msg:2,mso:[4,5,15],mtu:[12,15,31,44,60,74],much:[13,17,19,31,100],multi:[],multipl:[4,5,10,15,17,23,30,37,47,60,78,88,101],multipli:15,multisiteorigin:[37,60,74,83],multisiteoriginalgor:[37,74,83],multisiteoriginalgorithm:[37,74,83],must:[2,6,7,8,10,12,13,14,15,17,22,30,31,37,60,70,74,103],mutex:30,mutual:6,mvn:[28,85],my_ds_1:60,my_ds_2:[],my_ds_displayname_1:60,my_ds_displayname_2:[],my_vod1:[],mycdn:20,mydeliveryservic:17,mydivision1:[42,63,72],myhead:17,myorigin:[37,60],myphylocati:[40,69],myphylocation1:[40,69],myregion1:[40,42,69,72],mysecret:19,mysql:[14,31,98],mysqld:[],n0h:6,n6g:6,name:[],nameserv:15,nameserver:15,namespac:31,narrow:[8,15],nation:17,nativ:26,natur:31,navig:[],nearest:[15,85,93],necessari:[1,2,10,15,17,19,20,50,83,85],necessarili:[81,89,100,101],necessit:30,need:[],neg:[37,60],negativecachingcustomizationnot:[37,60],neither:22,net:[1,2,7,8,13,15,17,18,19,20,22,35,36,37,39,41,44,47,54,57,58,60,67,68,74,78,83,85],netaddr:10,netmask:[15,44,60,74],network6:15,network:[],network_lin:15,neustar:60,never:[46,76],newcastl:[35,37,57,60],newcount:[36,58],newdir:10,newli:10,newlin:15,newlogcount:[36,58],newuser:[50,83],next:[13,28,30,85,96],ngb:17,ninetyeighthpercentil:[53,62],ninetyfifthpercentil:[53,62],nix:[28,30,31,84,85,88],no_dns_just_forward_to_par:15,noarch:[13,14],nodata:17,node:[16,17,19,84,99],nodej:16,nodenam:20,nodesourc:16,noerror:[2,17],nolq:31,non:[6,8,15,17,18,31,37,60,74,83,97],none:[15,18,21,28,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,56,57,58,60,61,62,63,65,66,68,69,70,72,73,74,75,76,77,78,79,80,82,83,85],nor:22,normal:[15,17,18,100],notabl:10,note:[],notic:[2,26],notifi:30,notimp:17,now:[1,2,7,13,14,15,18,19,20,30,35,46,57,76,83,85,89,97],npm:84,nsec3:17,nsec:17,nsf:31,number:[1,8,10,13,15,17,18,19,29,31,33,35,36,37,44,52,57,58,60,74,83,89,97,100],numer:31,nxdomain:17,nyc:[36,58,100,101],object:[10,15,21,30,31,50,83,97,100],objectnam:[50,83],objecttyp:[50,83],obtain:[2,17,22,31,101],occur:[4,5,15,17,22,31,36,58,97],octet:[],odol:[17,36,38,58,65,66],off:[17,19,20,31,89],offer:100,offlin:[35,37,57,60,74],offline:[19,44,46,60,74,76,97],offlinereason:[44,60,74],ofqdn:[4,5],often:[15,23,24,100,101],old:[9,15],older:[15,17,91],omg:64,omit:15,onc:[19,102],once:[0,1,8,9,10,15,17,19,20,31,81,88],one:[15,17,20,37,51],onli:[1,2,4,5,6,13,15,17,18,20,21,22,26,29,30,31,37,39,43,50,54,68,71,73,83,86,96,97,98,101,103],onlin:[17,19,35,37,57,60],online:[8,17,18,19,44,46,60,74,76,89,97],only:[15,17,19,37,60,74,83,84,97],onward:17,ooff:[35,57],opcod:2,open:[14,15,22,24,28,31,85,91,94,96,100],openssl:[10,17],openssl_configur:13,oper:[0,15,17,18,23,24,30,36,40,42,50,51,52,54,56,57,58,60,61,63,68,69,70,71,72,74,79,83,97,98,102],operat:[],oppos:22,opposit:31,opsconfig:30,opsconfigfilehandl:30,opt:[8,9,10,12,13,14,16,17,18,19,20,28,31,59,85],optim:[23,85,93,100],optimal:100,optimist:[30,31,97],option:[],optional:[4,5,15,16,31,36,58],options:[2,31],oracl:31,order:[0,1,4,5,7,12,15,17,19,20,28,31,61,77,89,102,103],orderbi:[32,37,60],ordere:[],org:[4,5,10,13,14,15,30,37,60],org_loc:54,organ:[10,15,37,60],organiz:[10,13],orgserverfqdn:[37,60,74,83],orig:[],origin:[],origin_tp:[35,57],originhead:[37,60],originshield:[37,60,74,83],origintestfil:[37,60],originurl:[37,54,60],orm:31,orphan:15,orphane:15,ort:[],osvers:10,other:[0,4,5,6,8,10,13,15,17,18,22,24,30,31,37,60,96,97,98,99,100,101],otheroriginsecur:[37,60],otherwis:[1,6,15,26,46,76],otr:31,ott:[35,37,57,60],our:[15,19,20,90,91],out:[10,15,17,22,31,44,50,60,74,83,88,91,97],out_byt:62,outag:[15,97],outbyt:30,outlook:97,output:[10,13,14,15,26,97],outsid:[15,17,100],outweigh:30,over:[15,17,23,30,31,35,37,53,60,74,83],overal:[15,17,97,99,102],overflow:[35,37,57,60,97],overflowcdn:[37,60],overflowservic:[37,60],overload:[15,50,83,96,100],overrid:[15,17,31,85],overridden:85,overview:[],overwrit:[10,30,31],own:[13,14,15,18,19,30,85,97,100],owner:[13,22,31],owning:[60,74,83],pack:[44,74],packag:[],packet:[15,31],page:[1,10,12,13,15,16,18,19,37,47,60,78,90,91,100],pagin:[37,60],pair:[15,17],pakistan:91,panel:19,panelid:19,panic:18,paradigm:30,param1:[68,71],param2:[68,71],param:[8,15,70],paramet:[],parameter_id:[34,54,55,71],parameterid:[35,55,57,71],paramt:[68,71],parent:[],parent_origin:[4,5],parent_pend:18,parent_proxi:15,parent_proxy_rout:[4,5],parent_proxy_routing_en:15,parent_retri:15,parentcachegroup:54,parentcachegroupid:[34,54],parentcachegroupnam:[34,54],parentid:79,parentnam:79,pars:[6,96],part1:15,part:[6,7,10,15,17,18,44,57,60,74,101],parti:[6,35,37,57,60,91],partial:29,particular:[22,93,97,100,101],parts0:15,parts1:15,pass:[10,15,19,20,30,31,37,60,74,83,88],passin:10,passout:10,passphras:13,password:[2,8,9,10,13,15,17,18,19,20,28,31,44,50,60,74,83,99,103],past:[17,19],patch:51,path:[2,10,12,13,15,17,19,22,24,31,37,48,50,59,60,74,80,83,100],path_regexp:15,pattern:[7,37,60,61,74,83],pcre:[15,50,83],peak:[15,97],peakbpsestim:[37,60],peaktpsestim:[37,60],peer:[],peeroptimist:8,peerstat:[29,30],peewe:[50,83],pem:10,pend:15,pending:[50,81,83],per:[15,17,24,28,29,33,37,52,60,74,83,85,99,100],per_parent_connect_attempt:15,perc:[44,74],perceiv:31,percent:[15,60],percentag:[15,35,37,57,60],perform:[0,2,4,5,6,15,17,18,19,20,22,30,31,37,60,74,81,83,84,85,89,97,99,100,102],period:[12,15,17,18,31,98],perl5:[12,31],perl5lib:[12,31],perl:[],perltidyrc:31,permiss:[13,14],permut:15,persist:17,perspect:98,pertain:97,pessimist:[30,31],pg_hba:13,pgdg:13,pgloader:14,pgsql:13,phase:13,philosophi:97,phl:101,phone:[40,69],phonenumb:[50,83],phrase:[],phy:74,phys_loc:[],physic:[],physloc:[44,60,74],physlocationid:[44,60,74],pick:[10,30],pictur:3,pid:8,pin:[17,31],ping:[12,15,20,31,48,80],pingabl:31,pipe:15,pittsburgh:[33,52],pki:[10,20],place:[15,17,19,22,30,89],plai:31,plan:[17,37,60],plane:[25,96],planet:93,platform:[11,91],pleas:[10,13,15,17,31,50,59,83],plocat:[44,60,74],plugin:[8,10,15,31,37,50,60,74,83,93,97],png:[47,78],poc:[40,69],point:[8,9,13,15,17,20,24,37,40,60,69,74,83],polici:[19,60,88],poll:[6,8,9,10,15,17,19,30,31,35,57,85,89,96,97],poller:30,pollinginterv:19,pool:8,pop:15,popul:[15,30,50,83],popular:15,populateddimmslot:[44,74],port:[8,9,13,14,15,17,19,20,22,24,31,35,44,57,59,60,74,85,100,103],portal:[],portion:[17,22,37,60,74,83,85],posit:[7,31,97],possibl:[4,5,15,19,23,30,85,94,100],post:[2,17,31,35,37,40,42,44,48,50,51,54,55,56,57,60,61,63,64,68,69,70,71,72,74,77,79,80,83],post_instal:[],postal:6,postalcod:[50,83],postgr:[13,14,31],postgresql96:13,postgresql:[13,98],postinstal:[10,13,31],power:[44,74],powercap:[44,74],poweredg:[44,74],powerst:[44,74],ppl:[],practic:17,pre:[10,13,15,17,19,20,35,37,57,60,85],pre_prod:74,preced:[4,5],precis:17,preclud:15,precomput:30,preconfigur:31,prefer:[15,22],prefix:[15,93],prepar:[],prepend:74,preprocess:30,prerequisit:15,presenc:10,present:[],prevent:[10,15,17,31,37,60,74,83,96,97],previou:[13,15,22],previous:[13,17,22],primari:[4,5,15,17,41,68,70],primarili:[30,84,99],prime:15,primer:15,print:[18,31],prior:[17,85],pristin:[37,60],priv:20,privat:[10,17,20,31,35,37,57,60,98,103],priveleg:2,privileg:[13,17,103],privlevel:[43,73],probabl:15,problem:[15,88,97],proce:[13,15,31],procedur:[10,17],proceed:[],process:[6,9,10,15,17,18,19,28,30,53,54,57,74,85,100,102],product:[],profil:[],profile_copy_from:70,profile_id:[59,71],profile_nam:[],profilecopyfrom:70,profiledesc:[44,60,74],profiledescript:[35,37,57,60,74,83],profileid:[35,37,44,57,59,60,71,74,83],profilenam:[35,37,57,59,60,71,74,83],program:[10,102],programmat:31,project:[],prompt:[8,13],prop:20,propag:[15,97,98],proper:17,properli:[1,15],properti:[10,15,17,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,85,100],propos:8,proprietari:93,protect:97,protobuf:20,protocol:[],prove:31,provid:[13,15,17,22,23,26,28,30,31,33,35,37,52,60,84,85,97,99,102],provinc:[10,13],provis:[22,31,37,60],proxi:[],proxy_auth_to_par:15,proxy_nam:[39,54,68],psel:15,psql:13,pssc:[6,17],pub:13,publicli:31,publicsshkei:[50,83],publish:[8,17,29],publishdsst:8,pull:[10,15,18,28,47,78,85,88],puppet:18,pure:15,purg:[],purge:[10,50,67,83],purge_allow_ip:10,purpos:[10,31,47,78],push:[10,15],put:[2,6,15,17,19,20,22,31,37,40,42,46,51,52,54,56,57,60,61,63,64,68,69,70,72,74,76,77,79,81,83],python:15,qclass:17,qname:17,qrp:31,qstring:[],qstring_handl:15,qstringignor:[37,60,74,83],qtype:[6,17],qualifi:[17,31],qubee:91,queri:[2,8,15,17,19,20,29,30,37,44,49,50,51,52,53,54,58,59,60,62,67,69,70,74,82,83,88,100,102],query:2,querystringhandl:[37,60],querytim:[35,57],question:[2,13,18,91],queu:74,queue:[],queue_upd:[54,57,74],queueu:15,quick:[],quickli:[15,19,30],quiet:26,quit:[10,24,100],quot:[15,17],r720xd:[44,74],rack:[44,60,74],ram:[8,9,13,15,17,100],random:[15,18,22,24],rang:[10,15,37,60,74,83],rangerequesthandl:[37,60,74,83],rank:[4,5],rapid:18,rascal:[],rascal_cdn:8,rate:[37,60],ratelimitinggbps:[37,60],ratelimitingtps:[37,60],rather:[15,50,83,101],ratio:[15,31],raw:[8,15,18,19,29,30,37,60,74,83,97],rc4:10,rcode:17,rcvd:2,rdtl:[6,17],reachabl:30,read:[13,15,16,30,31,43,51,56,73,85,97],readabl:[13,15,30,44,60,74],readi:[12,15,31,89,98],readme:[15,85],real:[15,96],realist:22,realli:15,reason:[15,30,44,60,74],receiv:[10,15,17,22,24,30,31,100],recent:[15,17,29,31],reciev:17,recommend:[],recor:57,record:[1,15,17,20,37,39,54,57,60,68,85,100],recreat:[15,30],recurs:2,red:[10,15,21,22],redefin:[],redhat:[2,13],redirect:[],redirecturl:6,redo:31,reduc:[17,22,97],redund:[10,15,93,97,100],ref:[37,60,74,83],refer:[],referenc:[10,57],reflect:[10,20,89],refresh:[15,17,35,57,97],refus:[17,31],refused:17,regard:100,regardless:[4,5,17,97],regener:[1,15],regex:[],regex_remap:15,regex_revalid:[10,15,50,83],regexp:[],regexremap:[37,60,74,83],region:[],region_id:[40,69],region_nam:[40,69],regional_geoblock:6,regionalaltern:60,regionaldeni:60,regionalgeoblock:[37,60,74,83],regionid:[40,69],regionnam:[40,69],regist:[12,30,31],registrations:[50,83],regular:[10,15,17,50,83,97,98],reject:[],rel:[10,15,17,47,78,96],relai:19,relat:[10,15,17,31,33,52,97],relationship:[4,5,17,101],releas:[],release:[8,18],reli:15,reliabl:17,reload:17,remain:[17,97],remap:[],remap_pseudo_hook:[4,5],remap_requir:15,remap_stat:10,remaptext:[37,60,74,83],rememb:13,remot:[15,44,74],remov:[10,14,15,17,30,50,60,74,83],repeat:[15,35,57],replac:[14,15,60],replic:19,replica:15,repo:[13,14,15,28,85,88],report:[8,15,18,31],reported:[36,46,58,66,74,76,89,97],repositori:[13,28,30,31,84,85,88],repres:[6,17,35,57,81],req:10,request:[],requir:[],requisit:19,rerr:[6,17],reserv:31,reset:[21,31,50,83,99],reset_password:[50,83],resid:[30,85],resign:15,resolut:[12,17],resolv:[2,8,9,13,15,17,22,24,85,100],resolve4:[2,64],resolve6:[2,64],resourc:[16,17,28,31,85],respect:[4,5,30,31,97,100],respond:[6,15,17,21,22,24,100],respons:[],rest:[15,31,103],restart:[13,17,18,20,30],restful:[8,9,97],restor:17,restrict:[37,60,84,97,99],result:[15,17,22,23,30,31,37,44,60,74,88],retent:[19,88],retri:[15,18,35,57],retriev:[],retry_tim:15,reus:[22,23,100],rev_proxi:10,reval_pend:10,revalid:[],reveal:17,revers:[],review:[13,66,94],rewrit:[],rewritten:30,rfc:[17,24],rgalt:6,rgb:[],rgdeny:6,rhel:13,riak:[],riak_all:10,riak_cor:20,riak_kv:20,riak_search:20,riakserv:20,riakus:20,riakuserpassword:20,right:[15,31],ring:[15,17],rloc:[6,17],robin:[4,5,15],role:[],rolenam:[50,83],roll:[],rollup:102,root:[10,12,13,15,17,20,28,30,60,74,79,83,85],rotat:96,round:[4,5,15],rout:[],router:[],router_top:[37,60,74,83],routerhostnam:[44,60,74],routerportnam:[44,60,74],routingtyp:[37,60],row:[15,37,44,58,60,74,83],rpm:[],rsa:[10,13],rtr:[12,15,31,44,60,74],rtype:[6,17],rubi:84,rule:[4,5,6,15,22,37,50,60,74,83,97,100],run:[],rurl:[6,17],safer:15,sai:[3,15,19,97],salt:15,same:[4,5,6,7,10,15,17,19,21,22,30,37,50,60,70,83,97,98,100,101],sampl:[],sanjos:[34,54],sass:84,sat:31,satisfi:[37,60],save:[10,13,15,17,18,19,97],sbt:31,scalabl:100,scale:[15,17],scaleabl:10,scenario:[17,22,100],schedul:[15,18,50,83],schema:[20,31],scheme:15,scope:[10,59],scratch:[0,10],screen:[1,3,4,5,7,10,15,19,47,78],screenshot:1,script:[],script_fil:[48,80],scroll:18,sda:[10,15],sdf:10,search:[],search_index:20,sec:[15,20],second:[1,4,5,10,15,17,18,19,21,24,37,60,74,83,99,100,102],secondari:[4,5,34,35,54,57],secondaryparentcachegroup:54,secondaryparentcachegroupid:[34,54],secondaryparentcachegroupnam:[34,54],secret:[13,15,98],secret_passwd:31,section:[2,8,10,13,15,17,18,19,24,59,94,96,100],secur:[15,17,20,37,39,50,54,60,68,71,74,83,98],see:[1,4,5,8,9,10,12,13,15,17,18,19,20,22,24,25,30,31,37,44,60,62,74,83,87,90,91,93,97,98,100,101],seed:[12,20,31],seelogconfig:19,seelong:19,seen:30,select:[],self:[],selinux:14,semicolon:[17,85],send:[2,10,15,17,21,22,24,30,31,37,46,50,60,74,76,83,91,97,100],sens:[15,50,83],sensit:98,sent:[10,15,17,23,31,35,37,50,57,60,74,83,94],separ:[8,10,12,15,17,18,29,30,85,98,100],seper:19,seri:[17,53,62,98],serv:[0,4,5,6,10,15,17,22,29,30,37,44,60,74,83,84,93,97,99,101,102],server1:60,server2:60,server:[],server_graph_url:19,server_typ:37,servercheck:[31,44,74],servercheck_short_nam:[44,48,74,80],serverhostnam:[20,38,65],serverid:[38,59,60,65,74],serveripv4:59,servernam:[54,59,60],servertcpport:59,servic:[],servicealias:[37,60],servicedesc:[37,60],servicetag:[44,74],session:[8,15,18,50,83],set:[],set_bucket:20,setenv:17,setnumb:[37,60,61,74,83],setup:[],setup_6:16,setup_kabletown:31,sever:[4,5,15,17,19,24,85,97,98],sha256:10,sha:[],shall:6,shanghai:[40,69],share:[],shield:[15,60],ship:10,shortnam:[34,40,54,69],shot:3,should:[1,4,5,7,8,10,13,14,15,17,18,19,20,29,30,31,50,83,85,96],show:[1,6,15,24,31],shown:[18,22,31],shutdown:8,side:[15,84,100],sign:[],signal:[10,30],signatur:[10,15,17],signaturemanag:15,signific:30,significantli:[10,15,47,78],signkei:10,silent:16,sim:17,similar:[15,22,46,76],simpl:[10,15,17,19,20,31,50,83,85],simple_retri:15,simple_retry_en:[4,5],simple_retry_response_cod:[4,5,15],simpler:30,simpli:[0,6,15,19,30],simplifi:24,simpson:[50,83],simul:28,simultan:15,sinc:[15,17,21,22,29,30,100],singl:[15,17,23,30,31,55,68,71,89,94,97,101],site:[],situat:[15,24,97],size:[2,4,5,15,19,31,50,83],skin:16,skip:13,slack:91,slot:[44,74],slow:15,slower:[26,30],small:[30,100],smaller:[15,19],smooth:15,snapshot:[],snarf:15,soa:[15,17,35,57],socket:[85,100],softwar:[],sole:100,solo:19,solr:20,solv:15,some:[3,10,13,14,15,17,19,30,31,97,100],some_crt:[37,60],some_csr:[37,60],some_kei:[37,60],somecdn:85,someth:[15,17,50,83],sometim:[3,15,50,83,91],sort:[4,5,15,19,67],sortat:6,sourc:[],sourcepass:[],sourceurl:[],sourceus:[],space:[13,17],spec:[21,24],special:[15,17,37,60,74,83,97],specif:[],specifi:[8,9,15,17,29,35,37,57,60,97],speed:[15,50,83],split:17,splunk:15,spread:[10,15],spring:85,sql:[12,13,15,20,31],sr2:[28,85],src:[10,26,28,30,84,85],srvhttp:30,ssh:[15,31],ssh_key_edge_us:12,ssl:[],ssl_multicert:59,ssleai:18,sslkei:[20,37,57,60],sslkeyvers:[37,60,74,83],stack:15,stage2:15,stage:[30,47,78],stai:14,stale:10,standalon:20,standard:[10,15,17,28,85,88,98],start:[8,9,10,11,13,15,16,17,18,27,28,29,30,31,35,37,50,57,60,67,74,83,84,85,97,100],start_dat:[35,37,57],startdat:[53,62],starthealthresultmanag:30,startmonitorconfigmanag:30,startpeermanag:30,startstatecombin:30,startstathistorymanag:30,starttim:[29,50,67,83],startup:[17,97],startupmincycl:8,stat:[],state:[],statecombin:30,statement:31,stateorprovinc:[50,83],static_route:17,staticdnsentri:[],staticrout:[35,37,57,60],statinfohistori:30,statist:[],statisti:15,statmaxkbps:30,statresulthistori:30,stats_over_http:93,statsummari:29,statu:[],status:[],status_4xx:[62,102],status_5xx:[62,102],statusid:[44,60,74],statustomon:19,stddev:37,stead:[15,21],steer:[],steering:[7,15,17,60],steering_order:77,step:[],still:[6,12,15,17,21,26,85,91,97],stop:[10,13,15,16,17],storag:[10,13,15,39,54,68,97],store:[1,2,7,13,15,19,20,22,30,31,46,59,76,88,98,102,103],straight:15,stream:15,streamlin:10,strict:[4,5,15],strictli:[4,5,97],string:[15,17,29,31,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,100],strip:14,struct:[30,44,74],structur:[],stuff:[],stylesheet:31,sub:[13,15],subdomain:17,subject:10,submit:[10,11,15,18],submodul:85,subnet:6,subroutin:[],subscrib:30,subsequ:[22,31,100],subset:17,subtabl:15,succeed:[],success:[2,8,9,13,14,17,31,35,37,40,42,44,48,50,51,52,54,55,56,57,60,61,63,68,69,70,71,72,74,77,79,80,81,83],successfulli:[1,2,15,17,20,31,35,37,44,50,54,57,60,68,71,74,83],sudo:[8,9,10,13,14,16,17,18,19],suffic:20,suffici:15,suggest:[],suitabl:[15,17,85],sum:[15,19,35,37,57],summar:102,summari:[],sun:[21,22,31],sup:30,supercdn:13,superus:13,suppli:[22,31,44,74],support:[1,4,5,6,10,11,13,15,17,20,50,83,85,96],supress:26,sure:[8,9,13,14,15,17,18,19,35,89],syn:15,sync:[15,18,19,88],sync_ts_databas:19,syncd:[10,15,18],synchron:97,syntact:15,syntax:15,syslog_facil:12,sysmemtotals:[44,74],system:[],systemat:15,systemctl:13,t_integr:31,tab:[8,10,15,19,29],tabl:[],taco:67,tag:[15,53,62,102],taht:[15,37,60,74,83],take:[1,8,10,13,14,15,17,18,19,30,50,83,85,97,98],taken:[15,17,20],talk:0,tar:[13,14,26],tarbal:14,tarball_vers:14,target:[],targetid:77,targetpass:[],targeturl:[],targetus:[],task:10,tbd:[15,35,57],tc1_ats1:[60,74],tc1_ats2:74,tc_logo:[47,78],tcdomain:18,tcoveragezon:[35,57],tcp:[15,17,22,24,44,60,74,85],tcpport:[44,60,74],tcr0ck:13,team:[1,37,60],technic:[30,89],technolog:23,televis:100,tell:[10,21],temp:8,templat:[16,31],temporari:[31,46,76],temporarili:[84,100],tenant:[],tenantid:[60,74,83],term:[74,88,102],termin:85,test:[],testserv:85,text:[2,10,15,21,22,24,31,37,40,42,44,48,50,51,52,54,55,56,57,59,60,61,63,68,69,70,71,72,74,77,79,80,83],tgz:[],tha:31,than:[3,10,15,17,19,26,30,37,50,60,74,83,101],thei:[4,5,7,10,15,17,19,22,29,30,35,49,82,88,101,102,103],them:[15,17,19,30,35,74,88,100],themselv:10,therebi:22,therefor:15,thi:[0,1,2,4,5,6,7,8,9,10,12,13,14,15,17,18,19,20,21,22,24,26,27,28,29,30,31,33,34,37,38,39,40,41,44,46,47,50,52,54,60,65,68,69,70,71,74,76,78,81,83,85,86,88,91,96,97,98,100],thing:[8,15,19,30],third:[6,91],thorough:66,those:[15,26],though:[31,89,101],thousand:[3,15,23,94],thread:[8,17],threadpool:[8,15,35,57],threadsaf:30,three:[6,19,22,31,85,97,98,101,102],threshold:[10,35,57,97],through:[4,5,8,10,15,17,22,31,47,74,78,96,97,98,100,102],throughout:17,throughput:[17,97],thru:30,thu:[2,6,18],ticketnum:[36,58],tidi:31,tier:[0,10,15,37,47,60,74,78,83,89,93,101],time:[1,2,8,9,10,12,13,14,15,17,18,19,20,21,24,28,30,31,33,34,35,37,38,39,41,44,46,50,52,53,54,57,60,62,64,65,67,68,70,74,76,83,84,85,96,100],timefilt:19,timeout:[8,15,35,57],timepad:[8,35,57],timer:[10,21],timestamp:[35,57],tini:30,titl:19,tld:[1,15,17,35,57],tls_protocol:20,tlsv1:20,tm1:10,tmhostnam:[8,15],tmp:[7,15,18],to_develop:31,to_ext_teak:[],to_extens:[],to_home:[12,31],to_integr:31,to_pw:20,to_test:31,to_un:20,to_url:20,to_us:31,tocducheck:12,tochrcheck:12,todai:[22,23,94],todata:30,todo:13,todscpcheck:12,tofqdncheck:12,togeth:93,token:[],tom852:[],tom:[50,83],tomcat:[8,17,28,85],tommyboi:[50,83],too:10,took:17,tool:[],toolnam:[10,47,78],tools_server:15,toortcheck:12,top:[1,15,17,19,26,31,35,37,41,53,60,68,74,83],topasswd:19,topic:25,topingcheck:[12,31],torevproxyurl:59,tortrcheck:12,tosess:30,total:[15,17,31,35,37,57,60,62,74,102],total_connect_attempt:15,totalbyt:62,totalkbpsthreshold:[35,57],totalofflin:[35,37,57,60],totalonlin:[35,37,57,60],totaltpsthreshold:[35,57],totaltransact:62,tourl:[19,59],touser:19,toward:15,tps:[35,37,57,60],tps_2xx:[37,62,102],tps_3xx:[37,62,102],tps_4xx:[37,62,102],tps_5xx:[37,62,102],tps_total:[62,102],tr1:10,trace:18,track:[36,38,58,65,96],trademark:31,traffic:[],traffic_control:[28,30,31,84,85,88,89],traffic_lin:10,traffic_mon:8,traffic_mon_fwd_proxi:[10,47,78],traffic_monitor:[8,9,17,28,30,66,85],traffic_monitor_build:26,traffic_monitor_config:[8,28],traffic_monitor_golang:30,traffic_monitor_hosts:85,traffic_monitor_profile:11,traffic_op:[8,9,10,11,12,13,17,18,20,26,30,31,47,78,85,88],traffic_ops_:19,traffic_ops_build:26,traffic_ops_cachegroup:19,traffic_ops_db:[],traffic_ops_devliveryservic:19,traffic_ops_extens:31,traffic_ops_ip:12,traffic_ops_login:18,traffic_ops_ort:[18,26,31],traffic_ops_serv:19,traffic_ops_url:18,traffic_port:[16,84],traffic_portal_build:26,traffic_portal_properti:16,traffic_rout:[17,85],traffic_router_api:85,traffic_router_build:26,traffic_router_connector:85,traffic_router_cor:85,traffic_router_profile:11,traffic_rtr_fwd_proxi:[47,78],traffic_stat:[15,19,88],traffic_stats:15,traffic_stats_build:26,traffic_stats_profile:11,traffic_traffic_rout:85,trafficcontrol:[14,18,26,30],trafficmonitor:[35,57],trafficop:[10,18],trafficopsdata:30,trafficopshost:[35,57],trafficopspath:[35,57],trafficopss:10,trafficopsus:[35,57],trafficopsvers:[35,57],trafficopswrapp:30,trafficrout:[35,57],trafficrouterstart:85,trafficserv:[10,18,35,57,59],trafficstat:[31,62],traffop:[18,47,78],trafop:10,traiffic:15,tran:12,transact:[15,17,23,24,30,37,60,74,83,97,99,100],transaction_active_timeout_in:[4,5],transfer:24,translat:15,transmiss:[31,44,60,74],treat:[15,21,29,37,60,74,83,101],tree:[],tri:[4,5,15,101],trigger:[15,17,85],trim:[34,40,41,49,54,69,70,82],trivial:3,troubleshoot:[],trrequesthead:[37,60,74,83],trresponsehead:[37,60,74,83],tsimpson:[50,83],ttl:[10,15,17,24,35,37,45,50,57,60,64,67,74,75,83],ttm:[6,17],tue:100,tune:[],turn:[4,5,17,89],tutori:3,twelv:[],two:[4,5,6,7,9,15,17,19,31,55,71,77,97,101,102],txt:[8,15],type:[],typeid:[34,37,44,54,60,74,77,83],typenam:[34,54,61],typic:[10,15,19,23,24,30,50,83,88,101,102],udp:[17,85],uefi:[44,74],ugli:15,uichange:[36,58],uid:[50,83],unabl:17,unassign:60,unassigned_paramet:[54,68],unassigned_profil:68,unassigned_serv:[],unauthor:[31,50,83],unavail:[15,17,30,37,60,97],unavailab:[],unavailable_server_retry_response_cod:15,unavailableperc:[35,37,57,60],unawar:22,uncacheable_requests_bypass_par:15,uncommon:97,under:[],understand:[15,24,31],unfilt:8,unforeseen:14,unhealthi:74,uniqu:[4,5,15,21,33,34,36,37,38,44,50,52,54,58,60,64,65,67,74,83],unit:[10,12,13,28,31,37,44,60,74,85,88],unite:15,unix:[10,15,35,37,57],unknown:[8,10,74],unless:[4,5,44,60,74,84],unlimit:10,unlink:60,unlockexperimentalvmopt:17,unmarshal:30,unnecessari:[15,50,83],unquot:17,unsur:15,until:[15,17,24,30,85],unusu:[17,30],uodat:15,upd:15,updat:[8,10,13,15,17,18,20,22,30,33,34,38,39,40,41,42,44,46,50,51,52,54,56,57,60,61,63,65,68,69,70,72,74,76,77,79,83,98],update:[],update_riak_for_search:20,updpend:[44,60,74],upgrad:[13,31],upgrade:[],upload:[],upon:[1,17,31,35,97],upstream:[17,97],uri:15,url:[],url_remap:15,url_sig:15,url_sig_:15,url_sig_kei:20,urlencod:31,urlhash:15,urlregex:6,usa:[37,60,74,83],usag:[18,23,31,35,57,98],usage:[],uscsssfupsen:22,use:[10,13,15,17,20,27,31,37,60,74,83,100],use_in_t:[37,60,74,83],use_ip_address:15,use_reval_pend:[10,18],used:[10,15,17,35,37,44,47,57,60,70,74,78],useg1gc:17,useint:[49,82],user23:74,user:[],userid852:[36,58],userid853:[36,58],userid:[60,67],usernam:[8,9,13,17,18,20,28,50,67,83,103],userprofil:[50,83],using:[],usr:[8,13,19],usual:[10,13,15,18,21,24,31,50,83,93,97],usualli:[10,47,78,93],utc:[18,47,78,102],utf:[21,22,24],util:[17,20,28,31,85,88],utilizedperc:[35,37,57,60],v11:[37,60,74,83],v12:60,val:[38,65],valid:[6,15,17,20,21,26,53,62,68],valu:[4,5,6,7,8,10,15,17,19,20,28,29,30,31,35,37,38,39,44,50,53,54,57,60,62,65,68,71,74,77,83,85,97,98],value1:[68,71],value2:[68,71],variabl:[9,10,30,31,47,78,85],varieti:97,variou:[17,30,94],vast:[23,94],vault:[],vcpu:[8,9,13,17],verbatim:15,verbos:[12,26],veri:[15,96,100],verifi:[8,9,10,15,17,18,22,28,85],version:[9,10,11,13,14,15,17,19,20,21,30,31,35,37,44,48,50,55,57,60,68,70,71,74,80,83,88,89,97,100],vertic:17,via:[2,7,8,9,10,13,15,17,19,22,30,31,85,100,103],video:[23,37,60,91,97],view:[],viewabl:98,vim:[10,20],vip:[4,5,15],virtual:24,visibl:[2,10,30,39,47,54,68,78],visit:15,visual_status_panel_1:19,visual_status_panel_2:19,vital:93,vod:17,wai:[],wait:[13,15,17,18,30],wait_for_par:18,walk:31,want:[11,12,13,15,17,19,20,31,35,57,97],war:85,warm:31,warn:[8,18,31,37,44,48,50,51,52,54,55,56,57,60,61,68,70,71,74,80,83],warning:2,watch:[14,97],watcher:84,wbb:31,web:[2,10,15,18,28,30,84,85,96,98,99,100],webapp:[28,85],webbrows:15,webserv:93,websit:[19,20],wed:2,weight:[7,15,17,77],welcom:[31,88],well:[0,9,15,17,19,30,31,88,96,97,102],were:[13,15,20,22,30,35,37,55,57,60,71],west:[10,42,63,72,101],wget:[8,13,14,18],what:[],whatev:15,when:[0,1,2,6,8,10,13,15,17,18,19,20,21,22,30,31,35,37,39,47,50,54,57,60,68,71,74,78,83,93,97,100],whenev:17,where:[10,12,13,15,18,19,30,31,89,100,101],whether:[4,5,15,17,22,29,30,52,57],which:[0,1,6,9,10,11,13,15,17,18,19,20,22,24,28,30,31,35,37,44,46,47,49,50,54,57,60,61,74,76,78,81,82,83,85,88,96,97,100,101,102],white:[6,18],whitelist:[6,37,60],whitespac:13,who:[],whole:15,whose:[6,97],why:[],wikipedia:[22,93],wildcard:[17,29,60],window:[2,15,29],wish:0,within:[4,5,11,17,18,28,31,85,100],without:[6,10,15,17,24,30,89,97,100],woburn:[33,34,52,54],won:13,word:[3,30,31],work:[1,6,12,15,17,19,20,27,28,30,31,50,83,84,85,88,93],world:17,would:[21,31],wrapper:30,writabl:14,write:[6,8,10,13,15,19,30,31,51,56,89,97],writt:15,written:[10,15,17,19,30,31,88,102],wrong:[15,17],wrote:15,www:[8,17,21,22,24,31,100],x509:10,x520:[44,74],x86_64:[8,13,18,26],xml:[6,15,20,37,39,50,60,68,77,83,85],xml_id:[17,35,37,57,60,102],xmlid:[35,37,50,57,60,74,83],xmpp:[46,76],xmppid:[44,74],xmpppasswd:[44,74],xms2g:17,xmx2g:17,xpost:2,xput:[2,7,20],xxx:[50,83],xxxx:13,xxxyyi:7,xyz:[37,60],xzf:13,yesterdai:[35,57],yet:[2,15],yield:[17,100],yml:[13,26,31],you:[0,1,10,11,12,13,15,17,19,20,22,28,30,31,35,44,50,57,60,74,83,84,85,88,89,91,93,98],your:[1,8,9,10,11,12,13,14,15,16,17,18,19,20,31,35,37,57,60,79,84,88,89],yourcustomextens:31,yourself:[1,25],ys08:[44,74],yum:[8,9,13,16,17,18,20],yyyyyyi:13,zcf:93,zero:17,zip:[40,69],zone:[],zonemanag:15,zsk:[1,15,17,35,57],zskexpirationdai:[35,57],zxvf:14},titles:["Administrator’s Guide","Configure DNSSEC","Configure Federations","Quick How To Guides","Configure Multi Site Origin","Configure Multi Site Origin (5.x)","Configure Regional Geo-blocking (RGB)","Configure Delivery Service Steering","Traffic Monitor Administration","Traffic Monitor Administration","Traffic Ops - Configuring","Traffic Ops - Default Profiles","Managing Traffic Ops Extensions","Traffic Ops - Installing","Traffic Ops - Migrating from 1.x to 2.x","Traffic Ops - Using","Traffic Portal Administration","Traffic Router Administration","Traffic Server Administration","Traffic Stats Administration","Traffic Vault Administration","Cache Control Headers and Revalidation","Caching Proxies","Content Delivery Networks","HTTP 1.1","CDN Basics","Building Traffic Control","Developer’s Guide","Traffic Monitor","Traffic Monitor APIs","Traffic Monitor Golang","Traffic Ops","API Routes","ASN","Cache Group","CDN","Change Logs","Delivery Service","Hardware Info","Parameter","Physical Location","Profiles","Regions","Roles","Server","Static DNS Entries","Status","System","TO Extensions","Types","Users","API-Capabilities","ASN","Cache Statistics","Cache Group","Cache Group parameters","Capabilities","CDN","Change Logs","/api/1.2/servers/:hostname/configfiles/ats","Delivery Service","Delivery Service Regexes","Delivery Service Statistics","Divisions","Federation","Hardware Info","InfluxDB","Jobs","Parameter","Physical Location","Profiles","Profile parameters","Regions","Roles","Server","Static DNS Entries","Status","Steering Targets","System","Tenants","TO Extensions","Snapshot CRConfig","Types","Users","Traffic Portal","Traffic Router","Traffic Router API","Traffic Server","Traffic Stats","Running a Traffic Control CDN","Development","General","FAQ","Glossary","Traffic Control","Traffic Control Overview","Introduction","Traffic Monitor","Traffic Ops","Traffic Portal","Traffic Router","Traffic Server","Traffic Stats","Traffic Vault"],titleterms:{"case":[28,30,31,85,88],"default":11,"import":11,"static":[15,45,75],admin:20,administr:[0,8,9,16,17,18,19,20,94],aggregat:30,alwai:17,api:[28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,62,63,64,65,67,68,69,70,71,72,73,74,75,76,78,79,80,81,82,83,85,86],api_cap:51,architectur:30,arrow:[22,97,98,100,101],asn:[15,33,52],assignment:15,authent:15,author:10,availabl:30,base:15,basic:[25,94],becom:90,block:6,build:26,bulk:15,cach:[10,21,22,34,53,54,55,97,101],cache_stat:53,cachegroup:[34,54],cachegroupparamet:55,can:90,capabl:[51,56],ccr:91,cdn:[25,31,35,57,59,89,94],cdn_name:[59,81],centos:10,cert:10,certif:[10,17],chain:17,chang:[36,58],check:[15,31],combin:30,compos:26,config:30,configfil:59,configur:[1,2,4,5,6,7,8,9,10,17,18,19,20,31],content:[10,15,17,23,100],control:[21,26,89,91,94,95],convent:[28,30,31,85,88],coverag:15,crconfig:[15,81,89],creat:10,cron:12,daili:15,data:[30,31],databas:[14,31],deliveri:[7,10,15,17,23,37,60,61,62,100],deliveryservic:[37,60],deliveryservice_stat:62,deliveryservices_regex:[],develop:[10,27,28,30,31,84,85,88,90,94],directori:[14,31],divis:63,dns:[15,17,45,75,100],dnssec:[1,15,17,35,57],docker:26,domain:[35,57],dscp:15,endpoint:31,entri:[15,45,75],environ:[28,30,31,84,85,88],error:31,event:[17,30],exampl:[12,26,31],expression:15,extension:[12,31,48,80,98],failur:17,faq:[92,94],fart:[],featur:17,feder:[2,15,64],field:17,file:[8,9,10,12,15,17,20],format:[17,28,30,31,85,88],forward:22,from:[10,14],gener:[15,91],geo:6,geolimit:17,get:91,glossari:93,golang:30,graph:15,group:[10,34,54,55,101],guid:[0,3,27,94],handl:15,hardwar:[38,65],header:[15,21],health:[15,30,35,37,57,60,97],help:91,hostnam:59,how:[3,90,91],http:[17,24,30,100],https:17,hwinfo:[38,65],indice:94,influxdb:[19,66],info:[38,65],install:[8,9,10,13,17,18,20,28,30,31,84,85,88],installat:19,introduct:[28,30,31,84,85,88,96],invalid:15,involv:90,iso:15,java:[28,85],job:67,json:89,kabletown:31,kei:[15,17,35,37,57,60],kickstart:10,licens:91,local:100,locat:[10,40,69],log:[8,9,17,36,58],manag:[12,15,31],manual:[],menu:15,messag:17,metric:[35,37,57],migrat:14,minimum:11,monitor:[8,9,28,29,30,97],monkei:91,multi:[4,5,15],name:31,navig:[13,14],need:11,network:[10,23],note:84,operat:17,option:[15,17],ordere:17,origin:[4,5,15],ort:18,overview:[8,9,17,28,30,31,84,85,88,94,95],packag:[31,85],paramet:[10,15,39,55,68,71],parent:15,peer:30,perl:31,phys_loc:[40,69],physic:[40,69],pipelin:30,pkg:26,portal:[16,84,99],prepar:14,present:17,product:10,profil:[10,11,15,41,59,70,71,101],profile_nam:59,profileparamet:71,project:[28,30,31,84,85,88],protocol:[17,97],proxi:22,purg:10,qstring:15,queue:15,quick:3,rascal:91,recommend:17,redirect:17,refer:31,regex:[15,61],regexp:15,region:[6,10,42,72],reject:89,releas:91,remap:15,request:30,requir:[13,14,26,28,30,31,84,85,88],respons:31,retriev:17,revalid:21,revers:22,rewrit:15,rgb:6,riak:20,role:[43,73],roll:17,rout:[31,32,35,57,100],router:[15,17,85,86,100],rpm:85,run:89,runtim:31,sampl:17,script:18,search:20,select:15,self:10,server:[15,18,37,44,59,60,74,87,101],servic:[7,15,17,37,60,61,62,100],set:17,setup:14,share:30,sig:15,sign:[10,17],site:[4,5,15],snapshot:[15,81],softwar:[28,30,31,84,85,88],sourc:31,specif:17,ssl:[10,37,57,60],stat:[19,30,88,102],state:30,staticdnsentri:[45,75],statist:[53,62],statu:[46,76],status:[46,76],steer:[7,17,77],step:11,structur:31,suggest:17,summari:[15,17],system:[13,14,47,78],tabl:[15,94],target:77,tenant:79,test:[28,30,31,85,88],to_extens:[48,80],token:15,tool:[15,19],topolog:[35,57],traffic:[8,9,10,11,12,13,14,15,16,17,18,19,20,26,28,29,30,31,84,85,86,87,88,89,91,94,95,97,98,99,100,101,102,103],traffic_ops_db:14,trafficopsrout:31,transpar:22,tree:[28,30,31,84,85,88],troubleshoot:[8,9,17],tune:17,twelv:91,type:[15,17,49,82],under:91,update:15,upgrade:13,upload:15,url:15,usage:26,user:[50,60,83],using:[15,31],vault:[20,103],view:15,wai:17,what:91,who:91,why:89,zone:[15,17]}})
\ No newline at end of file
+Search.setIndex({docnames:["admin/index","admin/quick_howto/anonymous_blocking","admin/quick_howto/dnssec","admin/quick_howto/ds_requests","admin/quick_howto/federations","admin/quick_howto/index","admin/quick_howto/multi_site","admin/quick_howto/regionalgeo","admin/quick_howto/steering","admin/traffic_monitor","admin/traffic_monitor_golang","admin/traffic_ops/configuration","admin/traffic_ops/default_profiles","admin/traffic_ops/extensions","admin/traffic_ops/installation","admin/traffic_ops/migration_from_10_to_20","admin/traffic_ops/migration_from_20_to_22","admin/traffic_ops/using","admin/traffic_portal/installation","admin/traffic_portal/usingtrafficportal","admin/traffic_router","admin/traffic_server","admin/traffic_stats","admin/traffic_vault","api/index","api/routes","api/traffic_ops_api","api/v11/asn","api/v11/cachegroup","api/v11/cdn","api/v11/changelog","api/v11/deliveryservice","api/v11/hwinfo","api/v11/index","api/v11/parameter","api/v11/phys_location","api/v11/profile","api/v11/region","api/v11/role","api/v11/server","api/v11/static_dns","api/v11/status","api/v11/system","api/v11/to_extension","api/v11/type","api/v11/user","api/v12/api_capability","api/v12/asn","api/v12/cache","api/v12/cache_stats","api/v12/cachegroup","api/v12/cachegroup_fallbacks","api/v12/cachegroup_parameter","api/v12/capability","api/v12/cdn","api/v12/changelog","api/v12/configfiles_ats","api/v12/deliveryservice","api/v12/deliveryservice_regex","api/v12/deliveryservice_stats","api/v12/division","api/v12/federation","api/v12/federation_deliveryservice","api/v12/federation_federationresolver","api/v12/federation_resolver","api/v12/federation_user","api/v12/hwinfo","api/v12/index","api/v12/influxdb","api/v12/iso","api/v12/job","api/v12/parameter","api/v12/phys_location","api/v12/profile","api/v12/profile_parameter","api/v12/region","api/v12/role","api/v12/server","api/v12/static_dns","api/v12/status","api/v12/steering_target","api/v12/system","api/v12/tenant","api/v12/to_extension","api/v12/topology","api/v12/type","api/v12/user","api/v13/coordinate","api/v13/index","api/v13/origin","basics/cache_revalidation","basics/caching_proxies","basics/content_delivery_networks","basics/http_11","basics/index","development/building","development/index","development/traffic_monitor","development/traffic_monitor/traffic_monitor_api","development/traffic_ops","development/traffic_portal","development/traffic_router","development/traffic_router/traffic_router_api","development/traffic_stats","faq/administration","faq/development","faq/general","faq/index","glossary","index","overview/index","overview/introduction","overview/traffic_monitor","overview/traffic_ops","overview/traffic_portal","overview/traffic_router","overview/traffic_stats","overview/traffic_vault"],envversion:53,filenames:["admin/index.rst","admin/quick_howto/anonymous_blocking.rst","admin/quick_howto/dnssec.rst","admin/quick_howto/ds_requests.rst","admin/quick_howto/federations.rst","admin/quick_howto/index.rst","admin/quick_howto/multi_site.rst","admin/quick_howto/regionalgeo.rst","admin/quick_howto/steering.rst","admin/traffic_monitor.rst","admin/traffic_monitor_golang.rst","admin/traffic_ops/configuration.rst","admin/traffic_ops/default_profiles.rst","admin/traffic_ops/extensions.rst","admin/traffic_ops/installation.rst","admin/traffic_ops/migration_from_10_to_20.rst","admin/traffic_ops/migration_from_20_to_22.rst","admin/traffic_ops/using.rst","admin/traffic_portal/installation.rst","admin/traffic_portal/usingtrafficportal.rst","admin/traffic_router.rst","admin/traffic_server.rst","admin/traffic_stats.rst","admin/traffic_vault.rst","api/index.rst","api/routes.rst","api/traffic_ops_api.rst","api/v11/asn.rst","api/v11/cachegroup.rst","api/v11/cdn.rst","api/v11/changelog.rst","api/v11/deliveryservice.rst","api/v11/hwinfo.rst","api/v11/index.rst","api/v11/parameter.rst","api/v11/phys_location.rst","api/v11/profile.rst","api/v11/region.rst","api/v11/role.rst","api/v11/server.rst","api/v11/static_dns.rst","api/v11/status.rst","api/v11/system.rst","api/v11/to_extension.rst","api/v11/type.rst","api/v11/user.rst","api/v12/api_capability.rst","api/v12/asn.rst","api/v12/cache.rst","api/v12/cache_stats.rst","api/v12/cachegroup.rst","api/v12/cachegroup_fallbacks.rst","api/v12/cachegroup_parameter.rst","api/v12/capability.rst","api/v12/cdn.rst","api/v12/changelog.rst","api/v12/configfiles_ats.rst","api/v12/deliveryservice.rst","api/v12/deliveryservice_regex.rst","api/v12/deliveryservice_stats.rst","api/v12/division.rst","api/v12/federation.rst","api/v12/federation_deliveryservice.rst","api/v12/federation_federationresolver.rst","api/v12/federation_resolver.rst","api/v12/federation_user.rst","api/v12/hwinfo.rst","api/v12/index.rst","api/v12/influxdb.rst","api/v12/iso.rst","api/v12/job.rst","api/v12/parameter.rst","api/v12/phys_location.rst","api/v12/profile.rst","api/v12/profile_parameter.rst","api/v12/region.rst","api/v12/role.rst","api/v12/server.rst","api/v12/static_dns.rst","api/v12/status.rst","api/v12/steering_target.rst","api/v12/system.rst","api/v12/tenant.rst","api/v12/to_extension.rst","api/v12/topology.rst","api/v12/type.rst","api/v12/user.rst","api/v13/coordinate.rst","api/v13/index.rst","api/v13/origin.rst","basics/cache_revalidation.rst","basics/caching_proxies.rst","basics/content_delivery_networks.rst","basics/http_11.rst","basics/index.rst","development/building.rst","development/index.rst","development/traffic_monitor.rst","development/traffic_monitor/traffic_monitor_api.rst","development/traffic_ops.rst","development/traffic_portal.rst","development/traffic_router.rst","development/traffic_router/traffic_router_api.rst","development/traffic_stats.rst","faq/administration.rst","faq/development.rst","faq/general.rst","faq/index.rst","glossary.rst","index.rst","overview/index.rst","overview/introduction.rst","overview/traffic_monitor.rst","overview/traffic_ops.rst","overview/traffic_portal.rst","overview/traffic_router.rst","overview/traffic_stats.rst","overview/traffic_vault.rst"],objects:{},objnames:{},objtypes:{},terms:{"00z":[49,59],"06b4f870d809d82a91433e92eae8320875c3e8b0":4,"07033d6d":95,"0qgeodo7susugiqemzbwmmt0tncwb1sf":57,"0x00":11,"10g":[13,17,19,39,43,77,83,99],"10g6":[13,17,19,99],"10g_ping":[43,83],"10gbp":11,"10t22":49,"11t11":59,"11t12":[49,59],"12m":[41,79],"12t12":[49,59],"16gb":10,"1aa008f":[90,91],"1b08977e91f8f68b0ff5d5e5f6481c76ddfd0853":26,"1dcd512f":21,"1gb":11,"1min":22,"200mb":20,"20141222103718_extens":99,"20150108100000_add_job_deliveryservic":99,"20150205100000_cg_locat":99,"20150209100000_cran_to_asn":99,"20150210100000_ds_keyinfo":99,"24h":22,"252f":14,"262f":14,"2gb":20,"2xx":112,"300s":17,"3360cgaiip_layzmc_0hi2tejbazxtqh":57,"3rd":[29,31,35,54,57,72],"3xx":112,"4217a5":[39,77],"48h":70,"4gb":14,"4xx":[6,112],"50a3559482cc0":[90,91],"50aa00feadd":90,"567a":17,"567b":17,"56h":[45,86],"5b77f60f":9,"5gbp":11,"5thpercentil":[29,31,54],"5xx":6,"60s":22,"72h":70,"8a5a61b91473bc785d4073fe711de8d2c63f02dd":26,"8gb":[9,20],"90a":1,"95thpercentil":[29,31,54],"98thpercentil":[29,31,54],"9rd":[35,72],"boolean":[11,29,31,34,45,50,54,57,71,86,89,98,99],"byte":[17,26,57,112,116],"case":[7,16,17,20,22,26,39,57,77,90,91,92,93,96,109,113,115],"class":[20,99,101],"default":[0,2,6,9,10,11,14,16,17,19,20,21,22,23,34,39,50,57,71,73,74,77,82,86,90,91,93,99,100,101,109,113,116],"enum":[46,97],"export":[11,17,19,20,22,99,104],"final":[11,20],"float":[49,57,59,87],"function":[11,12,17,20,91,93,97,99,108,109,113,115,116],"import":[0,11,17,20,93,97,101,104,109,115],"int":[17,29,30,31,35,37,39,45,46,47,49,50,51,53,54,56,57,59,60,61,62,63,64,65,70,72,73,74,75,77,80,82,86,87,89,98],"long":[11,17,20,45,86,90,93],"new":[1,2,3,7,9,11,14,15,16,17,19,20,22,23,29,37,45,51,61,73,75,84,86,90,97,112],"null":[13,17,28,29,30,31,39,43,45,48,50,54,55,57,59,77,82,83,86,89],"public":[1,11,18,20,22,29,42,54,81,99,117],"return":[1,11,17,20,23,26,29,31,49,54,55,56,57,74,97,98,99,103,115],"short":[17,19,20,35,41,50,56,72,77,79,103,111,112,116],"static":[0,16,24,33,44,67,85,97,99,109],"super":[14,23],"switch":[15,17],"true":[1,2,4,6,9,11,16,17,19,22,26,29,31,34,45,48,50,54,57,62,63,65,68,71,73,74,77,82,86],"try":[11,17,20,26,45,86],"var":[9,10,13,14,20,69,101],"while":[6,8,14,16,17,19,20,22,92,93,97,99],AND:17,ATS:[6,11,16,17,20,45,56,86,91,97,99,108,111,112],Age:91,And:20,Are:[17,31,57],Bps:17,But:97,DNS:[0,2,6,9,10,13,14,16,19,24,26,29,31,33,44,54,57,62,67,77,85,86,91,93,101,108,109,110],For:[6,7,9,11,13,14,17,20,21,22,23,31,57,69,90,91,93,97,99,101,104,112,115],HDS:17,HLS:17,Has:48,IDE:101,IDs:[57,62,63,65,74],IPs:[1,6,17,31,57,77,86],Ids:50,Ips:[31,57],Its:97,L4S:7,Lvs:[8,23],NOT:[17,19,21,26,42,50,71,81,84,90],Not:[11,14,17,25,26,45,86,90,91,104,113],One:[17,20,23,31,46],Ops:[0,1,2,4,6,7,8,9,10,19,20,21,22,24,26,29,31,33,39,41,42,43,45,54,56,57,59,67,77,79,81,83,86,88,96,100,101,103,104,106,108,109,110,111,112,114,115,116,117],TMs:9,TPS:[17,29,31,54,57],That:[22,97],The:[0,1,3,4,6,7,8,9,10,11,13,14,15,16,18,19,20,21,22,23,26,27,28,29,31,32,34,35,36,37,39,41,42,45,46,47,48,49,50,51,53,54,55,56,57,58,59,60,66,68,69,71,72,73,74,75,77,79,81,82,84,86,87,89,90,91,92,93,96,98,102,104,108,109,111,112,113,115,116,117],Their:97,Then:16,There:[1,11,16,17,22,23,91,97,99,104,113],These:[6,9,10,11,17,22,42,77,81,92,97,99,112,113],Tps:17,Use:[11,14,17,19,20,23,31,57,77,86,96,99,115],Used:[11,16,17,20,29,31,39,42,54,57,73,77,81],Uses:[17,19],Using:[0,9,20,22,24,31,57,59,77,86,99,108,109,114],VMs:14,WITH:14,With:[1,4,16,17,26],Yes:[27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,89],____:97,__cache_ipv4__:17,__hostname__:[34,50,71],__return__:[6,17,57,77,86],_before_:17,_osvers:17,_profil:12,a00:[39,77],a_record:[44,85],aaaa:[17,19,20,29,31,44,54,57,77,85,86,101],aaaa_record:[44,85],aadata:68,abbrevi:[28,50],abc123def456:54,abil:[4,19,20,26,99],abl:[7,14,17,20],about:[11,14,17,19,20,22,26,30,31,32,42,49,55,57,66,77,81,86,91,98,103,115,116],abov:[2,3,11,12,14,18,19,20,22,57,90,100,101,103,108,112],absolut:22,accept:[4,20,26,52,71,74,104],access:[1,4,7,9,10,11,14,17,20,22,23,26,31,34,39,50,57,71,74,77,86,99,100,101,103,111,113,117],accesscontrolalloworigin:9,accomplish:17,accord:[15,17,45,86],account:[17,26,112],accur:[9,10,18,20],accuraci:3,achiev:22,ack:17,acl:[31,57],acquir:[103,116],acronym:20,across:[6,11,17,19,20,29,31,54,57,92],act:[17,91,108],action:[3,4,17,19,31,50,54,57,77,86,91],activ:[2,11,17,19,20,31,42,45,57,77,81,82,86,116],active_directori:[44,85],actor:97,actual:[11,17,20,21,91,112,115],adapt:[39,77],add:[1,2,4,7,9,11,14,16,17,20,21,22,23,31,57,61,77,86,90,99,101,104,112,113,117],added:[1,2,4,7,11,16,17,20,22,23,31,51,57,101],adding:[17,20,91,115],addion:99,addit:[3,4,14,17,20,31,57,77,86,93,99,101,108,112],addition:17,additional_config_json:[43,83],address:[9,10,11,13,15,17,19,20,21,31,35,39,40,45,48,56,57,61,72,77,78,86,89,91,93,99,101,102,104,115],addressline1:[45,86],addressline2:[45,86],adher:[41,79],adjust:[13,20],admin123:21,admin:[0,2,3,4,9,14,17,20,21,22,26,29,31,34,35,37,39,45,46,47,50,51,52,53,54,57,58,60,61,62,63,64,65,70,71,72,73,74,75,77,82,84,86,87,89,99,109,113,117],admin_down:[19,39,41,57,77,79,112],administ:20,administr:[11,14,17,26,113,114],adminpassword:23,adminstr:11,advanc:17,aes128:11,affect:[16,21,112],afj2gb7atmxvb8uv7t9s6oadml3ycpgf:57,after:[3,4,6,11,15,16,17,20,21,91,93,99,101,104,113],afterward:6,again:[11,90,99,112],against:[1,7,15,17,20,23,99,112],age:[4,17,26,45,86,90],agent:[26,45,86],aggreg:[29,48,54,92,111,112],agre:112,aid:17,aka:[3,61],alb:48,albuquerqu:[35,48,72],alert:[4,26,31,35,37,39,43,45,46,47,50,51,52,53,54,56,57,58,60,61,62,63,64,65,69,71,72,73,74,75,77,80,82,83,86,87,89],alg:57,algorithm:[6,17,19,54,57],alia:97,alias1:[31,57],alias2:[31,57],alias:[31,57],aliv:[4,26],all:[3,4,6,7,9,11,14,16,17,19,20,21,22,23,26,29,31,42,45,46,48,50,53,54,57,58,60,61,68,69,70,71,73,77,80,81,82,86,91,92,95,97,98,99,103,104,106,108,112,113,115,116],all_graph_url:22,allow:[1,2,3,4,7,9,11,14,17,20,21,22,26,31,47,54,57,61,73,77,86,90,92,98,99,101,103,104,108,112,113,115,117],allow_ip6:[9,11],allow_ip:[9,11],almost:17,along:[22,23,26,97],alreadi:[16,17,21,23,31,57,74,77,86,91,115],also:[0,6,11,16,17,19,20,21,23,31,48,51,57,59,77,86,90,97,99,103,106,108,111,112,113,115],alter:[17,31,57],altern:[7,57],although:111,alwai:[0,3,16,17,26,41,57,77,79,86,91,103,104],amd64:14,among:9,amount:[9,11,17,20,45,86,97],anaconda:[11,17],analysi:92,analyz:111,angularj:[100,114],ani:[1,4,6,7,8,11,14,15,16,17,19,20,22,23,26,30,31,42,55,57,71,73,81,95,97,99,103,112],anon_block:1,anonmy:1,anonym:[0,5,17,22,57],anonymousblockingen:57,anonymousip:1,anoth:[17,20,21,22,101,103,112],ans:20,answer:[4,11,14,17,20],anul:11,any_map:17,anyth:[17,32,66],anywai:17,anywher:[17,20],apach:[0,12,15,17,18,19,21,23,26,29,54,90,91,97,109,111,112,115],apachetrafficserv:91,apachetrafficserverdoc:16,api:[4,8,17,19,20,23,58,68,69,80,96,99,100,103,111,113,114,116,117],apichang:[30,55],apiport:[29,54],apiuri:56,apnic:[27,47],app:[11,13,14,23,42,81,99,100],appear:[17,21,91],appli:[3,11,17,19,21,31,44,57,77,85,86,99,104,108],applic:[0,4,7,10,17,19,20,21,23,26,39,45,57,77,86,96,97,99,100,101,109,111,112,113],applicationcontext:101,applicationproperti:101,approach:[2,99,112],appropri:[3,6,11,14,17,20,21,97],approri:14,approv:11,apr:26,april:111,arbitrari:16,architectur:[96,109,110],archiv:14,area:[7,92,99],aren:29,argument:[11,99],around:[20,97,115,116],arrai:[22,26,27,28,29,31,36,39,43,45,46,47,49,50,51,52,53,54,57,58,59,61,62,63,65,68,71,73,74,77,83,86,87,89],articl:108,artifact:[21,95,101],asap:[17,45,86],ascii:11,asdasdasdasfasg:20,ashburn:[35,72],ask:[11,14,21,26,90,99,112],asn:[0,24,25,26,33,46,67,104,109],asnsjj:26,assess:111,asset:[18,19,20,70,112],assettyp:[45,86],asseturl:[45,70,86],assign:[0,4,5,6,7,8,11,16,19,20,22,31,39,50,51,52,54,56,57,62,63,65,71,73,74,77,86,99,104],assigne:19,assist:11,associ:[3,17,19,20,23,29,31,50,51,52,54,57,61,70,71,74,77,84,86,115],assum:[14,17,21,22,69,91,100,104],assumpt:[9,23],astat:[9,11,21,99,108,112],astats_over_http:[11,21],atl:68,atlanta:[37,50,68,75],ats621:48,ats:[17,25,49,116],ats_profil:[71,73],atsec:[20,30,39,42,50,55,57,68,77,81,115],atsmid:[32,66],attach:71,attempt:[3,17,20,21,91,115],attribut:[7,11],audio:92,auger:106,august:111,auth:[9,17,31,57,77,86,99],authent:[0,9,19,20,23,26,27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,89,113,115,117],author:[0,4,17,19,20,23,26,57],authorit:[14,20,93,115],auto:[3,20,101],autofil:17,autom:[20,103],automat:[9,13,16,17,21,95],autonom:[17,19,27,47],avail:[4,9,10,11,17,19,20,22,25,26,28,29,31,41,45,50,54,57,77,79,86,92,95,99,101,109,111,112,115],availabilti:22,availablebandwidthinkbp:[11,29,54],availableperc:[29,31,54,57],averag:[11,49,59,112],avoid:[2,7,20,97],awai:17,awar:[17,91,104],aws:99,b3ff:61,b42be0749415cefd1d14e1a91bb214845b4de556:4,back:[17,20,45,86,90,99,112,115],background_fetch:[17,31,57,77,86],backlog:20,backplan:[39,77],backup:[17,20,51],backward:20,bad:[11,77],badass:21,balanc:[20,111],ball:95,bandwidth:[11,17,19,20,22,31,49,57,77,86,115,116],bar:[8,22,29,31,34,40,43,48,54,57,58,69,70,71,74,77,78,83,86,90,91,93,115],base64:[31,54,57],base64encodedcrt1:54,base64encodedcrt2:54,base64encodedkey1:54,base64encodedkey2:54,base:[0,5,6,8,11,14,15,19,20,29,31,57,77,86,91,97,101,104,106,113,115],base_url:[13,99],bash:[13,17,18],basi:[17,20,103,115,116],basic:[9,93,99,108,113,115],baz:[31,40,57,69,77,78,86],bbt:99,bcm5720:[39,77],bean:101,becaus:[3,7,11,16,17,20,21,97,115],becom:[2,17,84,97,107,109],been:[2,3,4,10,11,14,15,16,17,19,20,21,22,23,101,112,113],befor:[2,3,9,11,16,17,19,21,29,86,104,113],begin:[9,10,14,15,21,49,59,112],behalf:91,behav:[11,17],behavior:[20,112],behaviour:50,being:[9,11,13,17,20,21,31,57,92,97,99,109],bell:70,belong:[17,19,31,35,37,39,47,57,72,75,77,86],below:[11,13,17,20,21,22,91,93,94,98,99,101,104,111,112,115],best:[14,17,20,21,22,104,115],beta:[17,99],better:[20,113,115],between:[6,9,13,15,17,20,21,22,97,99,103,104,108,112,113,115],bin:[9,13,14,17,20,99],binari:[0,20],bind:101,bio:[39,77],bit:[11,17],bitbucket:14,blacked_out:7,blacklist:26,blank:[11,17,22],block:[0,5,11,17,20,57],blockanonymousvpn:1,blockhostingprovid:1,blockpublicproxi:1,blocktorexitnod:1,blue:14,blue_cdn:14,bobmack:65,bodi:[8,17,90,91,93],bond0:[17,39,57,69,77],bond:[17,69],boo:[31,57,77,86],bool:[29,31,39,50,54,57,73,74,77,82,86],boot:11,bootabl:[17,19],bootproto:17,bootstrap:[9,20,99,101],booya:[61,62,65],bot:17,both:[3,6,8,9,11,16,17,20,26,31,51,57,71,74,77,86,91,92,97,99,101,112,113],bottom:[12,17,21,22,23],bower:100,bower_compon:100,box:[6,20],bp12g:[39,77],bracket:[17,20],brave:17,breach:17,brief:22,bring:6,broadcom:[39,77],brought:22,brows:[21,101],browser:[4,9,10,99,113],bucket:23,bug:[30,55],build:[11,14,17,18,21,22,96,97,99,101,103,109],built:[14,95,101],bulk:0,bunch:17,bundl:[20,23,104],busi:[31,57,112],businessunit:[31,57],button:[2,4,8,12,17,22],bypass:[17,20,31,57,77,86],bypassdestin:[29,54],c0a8:20,cabl:106,cacertfil:23,cach:[0,3,4,6,7,9,10,17,21,22,24,26,29,31,33,39,41,42,45,47,54,56,57,67,77,79,81,84,86,92,93,94,97,98,99,101,102,103,107,108,109,110,111,113,114,115,116],cache01:91,cache_group_edg:[50,77],cache_group_mid:50,cache_range_request:[17,31,57,77,86],cache_stat:[22,25,116],cachegroup:[6,11,17,25,27,29,31,39,40,47,48,51,52,54,57,59,77,78,89,108,112,115,116],cachegroup_graph_url:22,cachegroup_id:52,cachegroupid:[39,47,50,51,52,57,77,89],cachegroupnam:[50,51],cachegroupparamet:[28,50],cachekei:[0,17,109],cachekeypatch:16,cacheloc:102,cachelocationid:102,cacheretentionpolici:22,cachestat:98,cacheurl:[0,17,31,57,77,86],cafe:89,calcavail:97,calcul:[9,17,97,103],call:[9,11,13,15,17,20,22,26,97,99,106,112,115],callahan:[45,86],can:[1,2,4,5,6,8,11,13,14,16,17,19,20,21,22,23,26,31,42,45,51,57,69,71,81,86,90,91,93,95,97,99,101,107,109,112,115,116,117],canadian:7,cannot:[19,31,57,77,86],capabl:[11,17,24,67,109],capac:[17,29,31,54,57,111,112],captur:[16,17,19,77],care:[17,20,22,45,86,113],carri:115,carton:99,catalina:20,catalina_bas:9,catalina_hom:9,catalina_opt:20,catalina_pid:9,catalina_tmpdir:9,categori:[30,55],caus:[17,45,86,112],caution:17,cb00:14,ccp:61,ccr1:[73,74],ccr:[16,17,39,41,44,77,79,85,107,109],ccr_copi:73,ccr_ignor:[41,77,79],ccr_top:[36,71],ccrdnsttl:[31,57,77,86],ccsi:91,cdn1:[14,17,29,54,57,62,73,77],cdn2:[29,54],cdn3:54,cdn:[0,2,3,4,6,7,8,9,11,14,16,17,20,21,22,23,24,25,26,31,33,39,42,45,46,47,49,50,53,57,61,62,67,73,77,81,84,86,90,91,92,93,97,98,101,103,106,107,108,111,112,113,114,115,116],cdn_1:56,cdn_eng:[31,57],cdn_id:56,cdn_name:[17,29,54],cdn_number_1:[50,77],cdn_test2:54,cdn_test:54,cdn_uri_sig_kei:23,cdnid:[31,39,50,54,56,57,77,86],cdnlab:[20,42,81],cdnname:[9,17,29,31,39,49,54,56,57,73,77,86],cdu:[13,17,19,99],cen:[32,66],cent6:7,center:77,cento:[0,9,10,14,15,17,18,20,69],centos65:11,centos72:69,centos96:14,central:[60,92],cert:[0,23,31,57,109,113],certain:[98,99,117],certainli:17,certfil:23,certif:[0,14,17,21,23,31,54,57,101,117],cfg:[10,11,17,22,69,97],cfg_:17,cg1:89,cg_edg:50,cgw:50,chain:[0,17],challeng:11,chang:[3,4,11,14,16,17,19,20,21,22,23,24,33,57,67,77,90,91,93,97,99,100,101,104,109,111,112,113],changelog:17,channel:[97,106],charact:[7,17,20],charset:[90,91,93],chart:116,check:[0,1,6,11,13,16,20,21,22,29,31,39,43,57,77,83,86,91,101,108,113],check_extension_bool:[43,83,99],check_extension_num:99,check_nam:13,checkpath:[31,57,77,86],chi:[7,20,39,50,57,77,104],chicago:[28,39,50,57,77,87],child:[6,17,50,77],chkconfig:9,chmod:15,choic:[15,20],choos:[2,4,12,17,22],chosen:[2,7,17,111,115],chown:[11,15],chr:[13,17,19,99],cidr:[1,7,11,64],cipher:11,circular:97,circumst:11,cisco:106,citi:[11,14,19,20,31,35,45,57,72,86],clarif:[20,93],classless:[1,7],classpath:9,clean:101,cleaner:21,clear:[11,19],cli:100,click:[1,2,4,6,7,8,9,12,17,19,20,21,22],clickabl:17,client:[1,4,7,11,17,19,20,24,29,31,41,54,57,77,79,86,90,91,93,97,100,101,102,103,104,108,109,111,112,114,115],client_connect:116,client_steer:17,clone:[19,23,97,99,100,101,103],close:[4,17,90,91,97,112],closer:20,closest:[17,20,101,108,111,115],closur:97,cluster:[22,23,104],cmc:[28,50],cmd:[4,14],cmkoiixxgaxumdcswvngloimgmniut5i:57,cms_interfac:13,cname1:[62,65],cname:[4,17,20,57,61,62,63,65],cname_record:[40,78],cnd:69,coalesc:11,coalesce_masklen_v4:11,coalesce_masklen_v6:11,coalesce_number_v4:11,code:[1,6,7,11,14,17,20,31,41,57,77,79,86,97,99,101,103],code_abc123:17,codebas:101,codepoint:99,coexist:115,collect:[11,17,20,22,26,27,28,29,31,39,42,43,45,46,47,50,51,52,53,54,57,58,61,71,73,74,77,81,83,86,87,89,97,111,113],collector:20,collis:99,colorado:[31,57],column:[13,17,19,49,59,99],com:[1,3,7,14,16,17,18,19,20,21,26,29,31,35,43,45,54,56,57,58,61,65,69,72,77,83,86,89,90,91,93,95,97,99,101,104,115],combin:[16,104,108,115],combinedst:97,combinest:97,comcast:[20,101,104,106,111],come:[16,17,31,57,90,97,99],comma:[11,17,98],command:[2,9,14,20,21,22,23,95,99],comment:[11,35,42,72,81],commit:3,common:[0,11,14,16,26,57,93,97,99,112,115],commonli:[90,97,99,100,101,103],commun:[20,91,99,101,104,106],compani:[11,14,17,21,45,65,86],compar:[16,17,19],comparison:[11,104],compass:100,compat:[17,45,86],compens:16,compil:[97,99],complet:[0,5,9,14,17,19,20,21,26,57,93,101],complianc:91,complic:[5,112],compon:[12,17,19,20,22,95,109,110,111,112,113],compos:[96,109],comprehens:[14,93],compris:101,comput:[22,97],computation:20,concaten:[17,99],concept:[12,94,115],concern:17,concurr:[20,106],cond:6,condit:[17,20,45,86],conf:[9,10,11,14,17,18,20,22,23,69,99,100,101],config:[3,6,7,9,10,11,16,17,18,19,20,21,22,23,24,29,34,41,50,54,67,69,71,79,84,99,100,109],config_fil:[17,29,34,50,54,71,74],configdoc:98,configfil:[25,50,71,74],configfile1:[71,74],configfile2:[71,74],configur:[0,5,13,14,15,16,17,18,26,29,31,39,45,50,51,53,54,56,57,77,84,86,91,92,93,97,98,101,102,104,109,111,112,113,114,115,116],configurationlisten:101,confirm:[11,17],confirmlocalpassword:86,conjunct:[17,112],connect:[4,9,10,14,15,17,19,20,21,22,26,29,48,54,57,77,90,91,92,93,99,112,115],connect_attempts_max_retri:6,connect_attempts_max_retries_dead_serv:6,connect_attempts_timeout:[6,17],connector:101,consequ:101,consid:[11,17,31,57,104,112,115],consist:[11,17,20,22,92,101,102,108,112,113,115],consisten_hash:17,consistent_hash:[6,17],consistenthash:102,consol:[15,101],construct:[17,97,111],consult:22,consum:[17,19,26,92,96,98,100,112,114],contact:[26,35,72],contain:[1,9,10,11,17,20,93,95,97,100,101,103,104,111,116],content:[0,4,5,7,13,21,23,26,29,31,36,45,54,57,70,71,77,84,86,90,91,93,94,104,106,107,108,109,110,111,112],contentrout:84,contentserv:84,contenttyp:[31,57],context:91,continu:[1,12,20,22,93,103,104],contribut:[97,99,105],control:[0,2,4,5,9,11,12,14,15,16,17,19,20,21,22,26,31,39,45,57,77,86,91,93,94,96,97,98,99,103,107,108,111,113,115,116],convent:[96,109],convers:[15,17],convert:[11,20],cooki:[4,8,23,26,45,86,99],cool:[31,57,77,86],coordin:[11,17,20,24,29,54,88,89,104,109,115],coordinate1:89,coordinateid:89,copi:[17,18,20,22,57,73,95,101],copyfromxmlid:57,core:[17,20,101],corpor:[31,57,65],correct:[10,17,20,22,23,26,56,97,99],correctli:[17,20,22],correspond:20,cost:[20,97,115],could:[11,17,20,97],count:[9,17,29,31,39,49,54,59,77,98],counter:112,countri:[11,14,17,31,45,57,86],countrycod:11,coupl:[20,23],cover:53,coverag:[0,29,54,57,102,104,108,109,115],coveragezon:[17,29,54,102],coveragezonejsonurl:17,coveragezoneonli:[29,54],cox:106,coyot:115,cpan:[11,14,99],cpanfil:99,cpld:[39,77],cpu:20,cqhm:[7,20],cqhv:[7,20],cr_bar:[29,54],cr_foo:[29,54],cran:25,crconfig:[0,1,2,7,9,11,20,24,29,30,54,55,67,77,97,98,109],creat:[0,4,5,6,8,9,14,16,17,19,20,21,22,29,30,31,35,37,43,45,46,50,51,52,53,54,55,57,58,60,61,62,63,64,65,71,72,73,74,75,77,80,82,83,86,87,89,96,97,99,101,103,104,108,116,117],create_network_lin:17,create_ts_databas:22,createdb:14,createdbi:70,createstat:97,creation:[6,46,53,54,58,80,86],credenti:[4,20,21,26,101],critic:[20,112],cron:[0,11,17,21,43,83,99,109],cronjob:99,crontab:[13,21],cross:[30,55],crossdomain:[17,31,57],crs:102,crstate:[9,97,98],crt:[11,20,23,31,54,57,117],crypt:21,cryptograph:[20,54],csp:97,csr:[11,31,57,117],css:[18,99],csv:17,cti:99,curl:[4,8,9,18,20,23,26,101],current:[2,3,7,9,11,13,16,17,19,20,23,29,30,45,54,55,57,61,70,84,86,97,98,99,102,103,111,113,116],current_client_connect:[17,49,116],currentgbp:[29,54],custom:[0,1,11,16,17,18,21,22,31,57,77,86,99,103,112,113],customiz:113,custommenu:19,cycl:[9,20],czf:[17,20,31,57,77,86],czm:108,czmap:20,d0d0:[39,57,77,89],d1s2:[39,77],d1s4:[32,66],d4ayzj1ae2nyisa9mxmty03tpdchji9c:57,d6xpdv1:[39,77],d903:[39,77],dai:[2,11,17,22,29,30,54,55,86,93,103,116],daili:[0,22,103,116],daily_bw_url:[17,22],daily_served_url:[17,22],daily_stat:[22,116],dailysummarypollinginterv:22,dailysummaryretentionpolici:22,danc:20,dash:[7,17,20],dashboard:[0,22,103,109],data:[14,15,17,19,20,22,26,29,31,39,49,50,54,57,59,77,90,98,101,103,111,113,116],databas:[0,1,7,11,13,14,17,20,22,23,26,31,39,57,77,86,96,103,104,108,109,113,115,116],datacran:25,datadeliveryservic:25,datadeliveryserviceserv:25,datadomain:25,datahwinfo:25,datalink:25,dataloc:25,datalocationparamet:25,datalog:25,dataparamet:25,dataphys_loc:25,dataprofil:25,dataregion:25,datareq:97,datarol:25,dataserv:[25,29,54],dataserverdetail:25,datastaticdnsentri:25,datastatu:25,datatyp:25,dataus:25,date:[1,2,4,17,20,21,26,27,28,29,32,34,36,39,41,45,47,49,50,54,57,59,66,71,73,77,79,86,87,89,90,91,115],dbconf:[14,99],dbix:99,dcchi:[28,50],dczf:[17,20],dczmap:20,deactiv:17,dead:89,dead_server_retri:17,dead_server_retry_en:6,dead_server_retry_response_cod:6,deal:112,debug:[4,9,21],dec:[4,90,91],decim:[20,57],decis:[101,115],decod:[57,97],decreas:20,deem:97,deep:[0,57,77,86,102,109],deep_cz:20,deepcachingtyp:[20,57,77,86],deepcoveragezon:[17,20,102],default_qdisc:17,defin:[1,7,9,11,17,19,20,57,69,99,101,104],degre:[20,57],del:[31,57,77,86],delai:[9,101],deleg:[14,20],delet:[4,5,11,17,18,19,23,26,29,31,43,46,50,51,52,53,54,57,58,61,62,64,65,71,73,74,77,80,83,87,89,90],delimit:[17,101],deliv:[17,21,92,106,115],deliveri:[0,1,2,4,5,6,7,9,13,16,21,22,24,29,33,39,45,50,54,61,67,70,77,80,84,86,89,94,97,98,99,101,102,103,104,106,108,109,110,111,112,113,114,116],deliveryprotocol:[31,57],deliveryservic:[0,4,7,8,9,11,17,22,23,25,29,39,40,45,50,54,58,61,70,77,78,80,84,86,89,97,98,101,102,104,109,115,116],deliveryservice_graph_url:22,deliveryservice_serv:57,deliveryservice_stat:[22,25,116],deliveryservice_us:57,deliveryservicedata:97,deliveryserviceid:[7,80,89,102],deliveryservicenam:59,deliveryservices_regex:58,deliveryserviceserv:[25,31,57],dell:[39,77],demand:[19,20,31,57],den:104,deni:[7,57],denial:20,denorm:97,denver:[11,14,29,31,37,40,54,57,75,78],depend:[2,14,16,17,20,80,97,99,100,103],dependeci:14,deploi:[3,11,19,20,21,42,77,81,92,101,109,112],deploy:[3,17,19,20,101],deprec:[16,39,77],depth:11,dequeu:[50,54,77],deriv:[17,20],des3:11,descend:70,describ:[17,20,31,42,53,57,61,77,81,86,91],descript:[9,11,14,17,19,20,22,26,27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,89,98,99],deserli:97,design:[97,100,113,114],desir:[3,8,17,20,31,57,59,115],destin:[11,17,20,31,57,77,86,92,109,112],detail:[0,6,9,10,11,17,19,20,25,26,30,31,39,46,47,50,53,54,55,57,77,93],detect:112,deteremin:17,determin:[3,17,19,20,97,99,101,108,112,113,115],dev:[11,13],devel:100,develop:[0,15,22,106,107,111],devic:[11,17,108],dhcp:[17,69],diagnost:[39,77],diagram:111,dialog:17,did:[11,20,90],diff:[1,7,17,19,104],differ:[6,11,17,20,21,22,23,91,93,97,104,112,113,116],differenti:[17,31,57,77,86],diffserv:99,dig:[2,4,20],digest:54,digesttyp:54,dilig:20,dimens:112,dir:[15,20,69],direct:[17,91,104,108],directli:[17,20,23,91,95,108],directori:[0,10,11,12,14,17,22,56,69,95,97,101,103,109,112],disabl:[1,17,19,20,54,57,73],disallow:7,discuss:115,disk:[9,11,14,17,19,32,39,66,69,77,99,115],dispatch:97,dispers:[11,17,21,57],displai:[4,9,13,17,19,22,31,39,57,77,86,98,101,116],displaynam:[31,57,77,86],disregard:9,dist:[14,15,21,95,100],distanc:[104,111,115],distinguish:[6,11],distribut:[0,11,20,92,101,106,109,115],divers:112,divert:17,divis:[0,11,17,24,37,67,75,104,109],division_nam:[37,75],divisionid:[37,75],divisionnam:[37,75],divsionid:[37,75],dns:[17,20,31,57,101],dns_live:17,dns_live_natnl:17,dnsbypasscnam:[31,57,77,86],dnsbypassip6:[31,57,77,86],dnsbypassip:[31,57,77,86],dnsbypassttl:[31,57,77,86],dnskei:[17,20,54],dnssec:[0,5,19,23,47,101,109,117],dnssecen:[29,47,54],dnsseckei:[17,29,54],doc:[17,19,21,95,97],docker:[15,96,109],document:[5,14,16,17,20,21,22,23,26,33,68,91,106,109,112],doe:[9,11,17,20,23,31,35,57,72,74,77,86,91,93,97,99,104,108,111,115,116],doesn:[17,20,26,84,90,97,99],doesssss:[35,72],doing:[3,17],domain:[1,2,3,7,14,16,17,19,20,25,39,57,69,70,77,99,115],domain_nam:[17,29,34,54,71,99],domainnam:[13,29,39,54,57,69,77],don:[11,17,26,29,104],done:[3,4,6,17,20,23,97,100,104],dot:[16,61],doubl:[16,20],down:[9,17,19,21,31,41,57,79,95,99,115],download:[9,10,12,14,15,17,18,21,22,23,56,95,101],downsampl:[22,103],downstream:[31,57,77,86,90],draft:[3,19],drill:17,drive:[17,77,103,116],drive_config:17,drive_lett:[11,34,50,71],drive_prefix:11,driver:[39,77],drop:[17,19,31,57,77,86,99,112],dropdown:22,ds1:54,ds2:54,ds_bypass:20,ds_client_geo_unsupport:20,ds_cz_backup_cg:20,ds_cz_onli:20,ds_miss:20,ds_no_bypass:20,ds_not_found:20,ds_profil:6,ds_redirect:20,dscp:[0,13,19,31,57,77,86,99],dsid:[39,45,57,58,62,70,77,80,86],dsname:[58,115],dsr:[29,31,54,57],dsrecord:54,dsretentionpolici:22,dsstat:[97,98],dsxmlid:[45,86],dtxsu8nsw04yht0knokbhu2g3p9wrpqj:57,due:[17,31,57,77,86,112],dummi:104,dummyxmpp:[39,77],dump:17,duplic:[11,104],durat:17,dure:[9,11,17,20,21,50,99,101],dynam:17,each:[0,1,6,9,11,12,13,14,16,17,19,20,22,23,29,30,31,50,54,55,57,84,95,97,98,99,104,111,112,115],earlier:17,earth:108,easi:17,easier:[11,26],easiest:95,easili:[22,97],east:[35,72,104],echo:17,eclips:101,econom:[92,109],edg:[0,2,9,11,16,17,19,20,21,29,31,39,41,43,50,54,57,71,77,79,83,86,91,99,104,106,108,112,115,116],edge1:11,edge1_cdn1_421:77,edge1_cdn1_421_ssl:[39,57,77],edge1_foo_721:48,edge1_top_421_pspp:68,edge_27_profil:73,edge_28_profil:73,edge_ats_:12,edge_cdn_1_exampl:56,edge_loc:50,edgeheaderrewrit:[31,57,77,86],edgeloc:[20,84],edh:11,edit:[3,4,9,11,13,14,17,19,20,22,42,46,47,50,53,54,57,71,73,77,81,87,89,99],editor:11,effect:[1,2,7,17,20,23],effici:[31,57,97],either:[8,17,20,23,51,69],el6:[4,9],el7:[14,15,21,95],element:[1,7,111],elev:3,elig:[57,115],els:[16,20,22],email1:[45,86],email:[11,17,19,31,35,45,57,65,72,86],emailto:[31,57],embed:[99,101],emit:21,empti:[1,7,16,17,20,73],enabl:[1,2,3,6,7,11,14,17,19,20,21,23,29,31,47,54,57,77,86],enclos:20,encod:[29,31,54,57],encompass:92,encrypt:[14,57],end:[16,17,20,29,31,49,54,59,61,91,92,97,98,108,115],end_dat:[29,31,54],enddat:[49,59],endpoint:[9,10,11,23,24,97,109,112,113],endtim:98,engin:[15,31,57,95],enhanc:[99,113],ensur:[9,10,11,16,17,18,20,92,101,112],enter:[2,6,10,11,14,17,20,22,31,39,45,57,69,77,86,99,104],enteredtim:[45,86],enterpris:[11,22,39,77],entir:[3,20,91,97],entri:[0,2,6,20,21,24,27,28,29,30,31,33,34,36,41,44,47,50,54,55,57,67,71,73,77,79,85,86,87,89,91,92,99,109],enumer:97,env:[14,15,99],enviro:99,environ:[11,14,17,22,23,96,109],epel:14,epoch:[17,20,29,54,98],equal:[7,20,71,74],equival:[41,79,99],err:[29,31,54,57],error:[2,6,15,17,20,21,24,29,31,39,43,45,46,47,50,51,52,53,54,56,57,58,61,71,73,74,77,83,86,87,89,91,97,99,101,109],errorcount:97,especi:[104,115],essenti:93,establish:20,etag:[90,91],etc:[11,13,16,17,18,20,23,56,69,97,99,101,103,112,113],eth0:[13,77],eth4:[17,69],ethernet:[17,39,77],evalu:[17,58,112],even:[6,26,92,104,109,113],event:[0,9,29,54,98,109],eventlog:98,eventu:101,everi:[10,11,17,20,21,92],everyth:[0,17,23],examp:74,exampl:[0,1,4,6,7,8,11,14,17,19,20,21,22,26,27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,89,90,91,93,97,101,104,109,112,115],exampleurl:[31,57,77,86],exce:[17,112],exceed:[17,31,57,77,86,112],except:[6,11,17,19,20,115],exclud:[7,11,17,77,115],excludepostalcod:7,exclus:7,execut:[11,97,99,101],exist:[1,3,7,9,11,16,17,19,20,26,29,51,57,62,63,65,71,73,74,97,98,101],exit:[1,3,9,14,21],exp:[39,77],expand:101,expect:[14,17,20,21],expens:[17,45,86],experi:20,experienc:17,experiment:[17,20],expir:[2,4,17,20,26,29,45,54,86,90],expirationd:[29,54],explain:[17,23,111],explainatori:17,explan:14,explicit:[20,91],explicitli:[90,112,113],explor:101,expos:[113,116],expres:17,express:[0,11,19,20,45,86,100],extend:[1,7,108],extens:[0,17,19,20,24,33,67,96,108,109,110],extensioncheck:13,extensionnam:99,extern:[24,109],extra:11,extract:15,extrem:[20,112],eyjhdxrox2rhdgeioijhzg1pbiisimv4cglyzxmioje0mjk0mdqzmdz9:26,eyjlehbpcmvzijoxndi5ndaymjaxlcjhdxrox2rhdgeioijhzg1pbij9:26,eyjlehbpcmvzijoxndi5ndazodyzlcjhdxrox2rhdgeioijhzg1pbij9:26,eyjlehbpcmvzijoxndq5mta1mti2lcjhdxrox2rhdgeioijmzwrlcmf0aw9ux3vzzxixin0:4,eyjlehbpcmvzijoxndq5mta1otqylcjhdxrox2rhdgeioijmzwrlcmf0aw9ux3vzzxixin0:4,f990d03b7180b1ece97c3bb5ca69803cd6a79862:26,fact:[3,11,17,104,112],factor:115,fail:[7,17,20,26,74,95,112],fail_threshold:17,failov:[6,17,31,57],failur:[0,17,50,57,99,109,112],fair:17,fairli:17,fall:[20,115],fallback:[7,20,24,50,67,109],fallbackid:51,fallbacknam:51,fallbackord:51,fallbacktoclosest:50,fals:[1,6,9,11,17,19,20,29,31,34,39,45,50,54,57,62,63,65,71,73,74,77,82,86,89,112],familiar:94,fast:112,faster:97,fatal:21,fe1e:61,fe80:61,feasibl:20,featur:[0,1,5,6,7,11,17,31,57,77,86,99,109,114,115],fed:[20,57,62,63,65],fedeat:4,feder:[0,5,19,20,24,57,67,109],federation_user1:4,fedresolverid:63,feedback:20,fetch:[1,7,17,20,21,71,97],fetchcount:97,fetcher:97,few:11,ffff:20,field:[0,1,3,7,9,11,13,14,17,23,25,26,30,31,55,57,77,86],fifthpercentil:[49,59],file:[0,1,6,7,14,16,19,21,22,24,31,41,42,45,50,57,67,69,71,77,79,81,86,90,91,92,93,97,99,100,101,102,103,104,106,108,109,113,115],filenam:[16,17,56],filepol:97,fill:[7,11,17,106],filter:[8,20,39,44,47,50,57,70,71,72,73,75,77,85,86,87,89],find:[17,20,91,101,108,115],finish:[101,112],firmwar:[39,77],first:[6,7,8,11,14,16,17,20,21,57,100,111,115,116],first_step:99,fix:[16,21,103],fixtur:99,flag:[4,7,11,17,21,22,31,71,74,97],flow:97,flush:10,fmt:103,fnameondisk:56,folder:11,foll:17,follow:[1,2,3,4,6,7,9,10,11,13,14,15,16,17,18,19,20,21,22,23,26,31,86,91,92,93,97,99,100,101,103,109,115,117],foo:[4,7,8,17,20,22,29,31,34,40,43,48,50,54,57,58,69,70,71,73,74,77,78,83,86,89,90,91,93,101,115],foobar:[36,71],foober:[31,57],fooconfig:[34,71],footprint:106,fooya:[61,65],forc:[11,14,17,45,86],forcesystemexit:9,form:[0,9,17,20,26,56,97,106],format:[0,1,7,11,16,17,49,51,52,59,71,74,96,109],former:11,forward:[7,11,17,42,81,94,108],found:[1,3,4,9,16,20,22,23,26,31,57,69,77,86,91,93,97,117],four:[17,112],fqdn:[6,9,10,11,13,14,17,19,20,29,31,39,54,57,69,77,86,89,99,101,115],fqpacingr:57,frag:112,framework:[99,113],fred:17,free:[17,97,99],freeform:[32,66],frequenc:[9,20],frequent:[20,97],fri:[42,81],from:[0,1,3,4,7,9,10,12,14,17,18,19,20,21,22,23,31,42,45,48,51,56,57,62,65,69,73,77,81,86,90,91,92,93,97,98,99,100,101,103,104,108,109,111,112,113,114,115,116],fsa:7,fulfil:[5,19,93,99],full:[6,11,14,16,17,19,20],fulli:[11,16,20,99,113],fullnam:[45,65,86],fullscreen:22,fun:[90,91,93,115],further:[1,4,7,16,17,19,97,99,111],futur:[11,15,20,97,111],fzbd37qbndf_3e_rvq3rp9pasmvepe24am:57,fzbpdbnbk2gqhwob_dgbasbxqqzvix04riolj7p_rl:57,gain:115,garbag:20,gatewai:[17,39,57,69,77],gather:[98,99,101,116],gbp:[17,31,57,116],gcm:11,gener:[0,2,6,11,14,16,20,21,22,23,29,31,42,54,56,57,69,81,84,98,99,101,102,103,107,109,113],genrsa:11,geo2:7,geo:[0,5,11,17,20,29,31,54,57,77,86,104,108,115],geo_no_cache_found:20,geo_redirect:20,geoblock:[17,20,57],geoenabl:[29,54],geograph:[17,92,104,112],geographi:[17,112],geoip2:20,geoip:14,geolimit:[0,17,31,57,77,86,109],geolimitcountri:[31,57,77,86],geolimitredirecturl:[31,57,77,86],geolit:14,geolite2:14,geolitec:11,geoloc:[7,11,17,20,29,54,57,101,102],geolocation6:[11,29,54],geolocationservic:101,geoprovid:[31,57,77,86],get:[0,2,4,7,9,11,12,14,17,19,21,22,23,26,27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,53,54,55,56,57,58,59,60,61,62,63,65,66,68,69,70,71,72,73,75,76,77,78,79,80,81,82,83,84,85,86,87,89,90,91,92,93,97,99,103,104,107,109,112,115],gid:[45,86],gigabit:[31,39,77],git:[14,17,97,99,101,103],github:[21,23,26,29,54,97,99,104,106],give:[17,19,20,21],given:[4,9,11,17,20,29,45,54,86,91,97,99,102,112,115],global:[4,11,17,22,31,42,57,77,81,86,112],globalmaxmbp:[31,57,77,86],globalmaxtp:[31,57,77,86],glossari:109,gmt:[4,17,26,90,91,115],go1:14,go_direct:17,goal:92,goe:[17,20,31,57],gofmt:97,going:[4,11,14,17,23,115],golang:[9,10,14,26,96,109,116],good:[17,21,99,104,106],googleapi:14,goos:[14,99],gopath:[22,97,103],goroutin:97,got:[4,17],gototarget1:8,govern:112,grafana:[17,22,103,116],grafana_url:22,grafanahost:22,grant:23,graph:[0,22,99,103,113,116],graphic:17,greater:[11,20,23,97,103],green:[22,111],group1:51,group2:51,group:[0,6,17,22,23,24,29,31,33,39,47,48,54,57,67,77,84,102,107,108,109,111,113,115],grow:20,grunt:100,guarante:11,gui:97,guid:[20,24,39,57,77],h710p:[39,77],hack:[9,17,29,54],had:90,hand:[17,19],handl:[0,6,7,19,20,31,57,77,86,97,112],handler:97,handlerfunc:97,handshak:[17,20],happen:20,hard:[11,17],hardcod:[16,99],harden:113,hardwar:[11,17,20,24,33,39,67,77,109],hardwareinfo:[39,77],has:[2,3,10,11,12,14,15,16,17,19,20,21,22,23,50,51,90,91,93,97,99,100,101,103,104,106,113],hash:[17,20,29,31,39,42,45,46,47,49,50,53,54,57,59,61,77,81,84,86,101,102,108,115],hashid:[29,54],hasnegativecachingcustom:[31,57],hasoriginaclwhitelist:[31,57],hasorigindynamicremap:[31,57],hassignedurl:[31,57],hat:[11,17,90,91],have:[3,4,6,8,11,14,15,16,17,19,20,22,23,26,71,90,91,93,99,101,103,104,112,113,115,117],hdr_rewrit:6,hdr_rw_:17,head:17,header:[0,4,6,9,11,20,26,31,42,45,57,77,81,86,91,93,94,109,115],header_regexp:17,header_rewrit:17,headerrewriteedg:[31,57],headerrewritemid:[31,57],headerrewriteredirectrout:[31,57],health:[0,9,10,11,19,20,22,41,77,79,86,92,98,99,101,102,108,109,110,111,113,115],healthhistori:97,healthi:[17,19,48,111],healthiter:97,healthparam:[9,29,54],heap:20,heart:17,heartbeat:97,heath:9,help:[1,7,14,15,17,22,103,107,109,112,115],helper:99,here:[3,5,9,10,11,12,16,17,22,23,31,42,45,57,81,86,99,106,117],hierarchi:[17,115],high:[11,17,19,20,22,29,35,54,72,99],higher:[3,11,17,22,108],highest:[11,14,97],highli:11,hint:17,histor:9,histori:[17,29,54,98],hit:[11,17,19,20,31,57,77,86,90,99,112,115],hls:7,hmac_md5:17,hmac_sha1:17,hold:[97,101],home:[22,99],honor:[20,90,101],hook:99,hop:[20,106,115],horizont:[20,115],host:[1,6,9,10,11,14,17,19,20,21,22,23,26,31,39,40,57,77,78,86,90,91,93,99,101,115],host_id:56,host_nam:[17,39,77,99],host_regexp:[17,31,57,58,77,86],hostnam:[9,11,13,14,16,17,19,20,23,25,26,29,31,32,39,48,54,57,66,69,77,91,108,115,116],hot:112,hou:104,hour:[17,20,45,86],hover:17,how:[0,17,19,22,23,31,45,57,77,86,90,93,97,99,107,109,112,115],howev:[11,13,17,20,97,113],hs256:57,html:[7,21,43,70,83,90,91,93,97,100,115],http11protocol:101,http:[0,1,3,4,6,7,8,9,11,13,14,15,16,17,18,19,21,22,23,26,29,31,39,42,43,45,49,50,54,56,57,69,70,77,81,83,86,89,90,91,92,94,95,99,100,101,104,108,109,110,112,113,116,117],http_live:17,http_live_natnl:17,http_no_cach:17,httpbypassfqdn:[31,57,77,86],httpfetcher:97,httpmethod:46,httponli:[4,26],httppoller:97,httprout:46,httpsport:[39,57,77],human:[14,17,39,57,77],hundr:[11,92,104],hurt:14,hwinfo:[25,39,77],hypertext:93,hypnotoad:11,icon:17,idb:22,idcopyfrom:73,idea:104,ideal:17,ident:17,identifi:[11,19,27,28,29,30,32,39,47,50,54,55,57,66,70,77,87,89,90],idiomat:97,ids:[39,77],ifconfig:14,ignor:[6,17,20,31,57,69,77,86],illustr:[93,111],ilo:[13,17,19,43,77,83,99],ilo_ip_address:[43,83,99],ilo_p:[43,83],iloipaddress:[13,39,57,77],iloipgatewai:[39,57,77],iloipnetmask:[39,57,77],ilopassword:[39,57,77],ilousernam:[39,57,77],imag:[4,6,17,19,42,81,95,99,106,115],img:[4,45],immedi:[16,17],impact:[17,112],imper:20,implement:[16,17,19,25,29,54,101,109,111],improv:[17,20],inaccess:[11,17,45,86],inact:[31,57,77,82,86],inc:[14,39,77],incept:20,inceptiond:[29,54],includ:[1,7,9,11,17,19,31,41,48,57,77,79,86,91,97,99,101,112,114,115],includepostalcod:7,incom:[17,20],inconsist:16,incorpor:[11,99],incorrect:56,incub:[15,21,26,29,54,95,97,111],independ:[97,112],index:[17,21,23,71,74,111],indic:[1,3,7,17,19,39,57,77,90,93,99],individu:[17,20,22,112],inf:101,influenc:[17,20,90,112,116],influx:22,influxdb:[0,17,24,39,67,77,103,109,116],influxdb_tool:[22,103],influxpassword:22,influxurl:22,influxus:22,info:[17,21,24,26,31,33,39,42,43,45,46,47,50,51,52,53,54,56,57,58,61,67,71,73,74,77,81,83,86,87,89,97,99,104,106,109],info_url:[43,83],inform:[2,10,11,14,16,17,20,21,22,23,29,31,42,54,57,77,81,86,91,97,98,99,101,102,104,112,113,115,117],infourl:[11,31,42,57,77,81,86],infrastructur:95,infuxdb:22,init:[11,20,23,101],initdb:[14,99],initi:[10,17,21,45,57,70,77,86,99,104],initialdispers:[31,57,77,86],initiatingheapoccupancyperc:20,inlin:17,input:[17,115],insecur:99,insert:[11,91,93,97,115],insight:112,inspect:20,instal:[0,13,15,17,18,42,81,95,96,104,109,113],instanc:[10,11,14,15,17,31,39,42,57,77,81,86,99,100,101,103,112,115],instance_nam:[11,42,81],instead:[17,20],instruct:[9,10,11,14,15,22,23,31,57,99,101],intact:[15,26],integ:[8,50,54,71,74,77],integr:[12,22,39,77,99,101,109,110],intel:[39,77],intend:[7,17,19,111],intent:17,inter:[1,7],interact:[21,113],interest:[20,91],interf:115,interfac:[11,17,19,21,39,57,77,99,101,111,112,113],interfacemtu:[39,57,69,77],interfacenam:[29,39,54,57,69,77],intermedi:20,intern:[8,17,20,23,26,41,79,97,106,109,111],internet:[20,91,92,109,115],interv:[1,7,9,10,17,19,20,22,29,54,97,99,111,112,113,116],intervent:17,introduc:110,introduct:[96,109,110],intruct:22,invalid:[0,11,45,70,86,109],invoc:9,involv:[5,20,97,107,109],ip4whitelist:1,ip6:[29,54],ip6_address:99,ip6address:[13,39,57,69,77,89],ip6gatewai:[39,57,69,77],ip6whitelist:1,ip_address:[43,83,99],ip_allow:[11,17],ipaddr:17,ipaddress:[13,39,57,63,64,69,77,89,102],ipaddrr:17,ipgatewai:[39,57,69,77],ipnetmask:[39,57,69,77],ips:57,ipv4:[1,4,7,11,13,17,19,20,31,39,57,61,69,77,86,89,91,93,99,101,102,104],ipv6:[1,4,11,13,17,19,20,31,39,57,61,77,86,89,99,101,102,104],ipv6addr:17,ipv6gatewai:17,ipv6routingen:[31,57,77,86],ipwhitelist:[1,7],isact:[43,83],isn:97,iso8601:[49,59],iso:[0,11,24,67,109],isolinux:11,isourl:69,isp:17,isprimari:89,issu:[17,21,29,54,101,104,112,115],issuer:57,item:[0,11,20,31,98],iter:99,its:[7,9,10,17,20,41,79,91,97,99,101,112,113,115],itself:[20,96,97,99],ivh:22,jan:115,jane:[35,72],jar:[9,101],java:[9,10,20,23,96,109],javascript:[97,99,100,103],jdk:[23,101],jdog24:70,jenkin:[18,20],jhgdpw5x9o8tqhfgezcm0bqb9sqpaswl:57,jmx:101,job:[17,19,21,24,45,67,86,109],joe:22,jpg:[45,86],jre_hom:9,json:[1,3,4,7,8,9,10,11,14,17,18,19,20,21,23,25,26,30,31,32,34,35,38,40,42,43,45,49,57,59,61,66,68,72,76,77,78,81,83,86,97,99,100,103,112,115,116],junit:101,just:[14,17,20,31,57,77,86,98],jvd:[11,26],jvm:20,jwa:57,jwt:57,k6hmzlbh1x6htkkyprffwqhandqqe50:57,kabletown:[2,4,8,9,14,17,20,21,23,29,30,31,39,42,54,55,57,77,81,91],kabletown_cdn:[9,14],kbaletown:[30,55],kbp:[31,48,59,97,116],keep:[4,11,14,17,21,26,74,99,111,115],kei:[0,2,11,16,19,23,36,42,71,73,77,81,86,109,113,117],kepler:101,kept:[9,20,99,111],kernel:[17,57],key0:57,key10:57,key11:57,key12:57,key13:57,key14:57,key15:57,key1:57,key2:57,key3:57,key4:57,key5:57,key6:57,key7:57,key8:57,key9:57,keyfil:23,keyn:57,keypair:[29,54],keystor:[17,20,117],keysus:23,keyword:[11,45,70,86],kh_rkumj:57,kick:112,kickstart:[0,17,69],kickstart_create_network_lin:17,kickstart_drive_config:17,kid:57,kill:20,kind:[17,20],kl0tevax:9,know:[11,17,115],knowledg:20,known:[17,19,112],ks_script:17,ksk:[2,17,20,29,54],kskexpirationdai:[29,54],kty:57,kvs:23,l9v:7,l9w:7,label:[20,29,31,54,57],lack:11,lacp:[17,69],lai:20,laika:26,lambda:97,land:[17,19],languag:[11,113],larg:[11,17,20,92,97,112,115],larger:[108,115],last:[3,6,9,17,19,20,27,28,32,34,36,39,41,47,50,57,66,71,73,77,79,87,89,90,91,99],last_upd:[28,34,50,71],lasthealthdur:97,lasthealthdurationsthreadsaf:97,lasthealthendtim:97,lastkbpsstat:97,lastsuccessfulbuild:21,lastupd:[26,27,28,29,30,31,32,35,36,37,39,41,44,45,46,47,50,53,54,55,57,60,66,71,72,73,75,77,79,82,85,86,87,89],lat:[11,17],latch:17,latenc:[17,20,91,112],later:[7,17,22,99,112],latest:[7,11,21,22,23],latitud:[17,19,20,28,29,31,50,54,57,77,86,87],latter:11,launch:17,lax:[42,81,104],layer:[17,31,57,108,115],ldap:14,ldn:[91,93,115],lead:20,learn:91,least:[2,14,17,104],leav:[11,17,22],left:[11,16,17,26],legaci:[0,10,19,109,114],length:[4,20,26,90,91,93,115],lenienc:9,less:[11,17,22,31,57,103,112,115,116],let:16,letter:[11,14,17],level:[2,3,4,13,17,19,20,26,29,30,31,35,37,39,43,45,46,47,50,51,52,53,54,55,56,57,58,60,61,62,63,64,65,69,71,72,73,74,75,77,80,82,83,86,87,89,95,97,99,112,115],leverag:111,liamstask:14,lib:[13,14,99],librari:[24,109],licens:[107,109],life:11,lifecycl:[39,77],lifetim:11,light:[39,57,77,99],lighten:[11,42,81],like:[11,14,17,20,21,22,90,97,99,108,113,115],limit:[3,11,17,20,31,50,55,57,70,77,86,115],line:[11,17,21,22,23,31,57,77,86,95,99],linear:17,link:[17,19,21,103,115,116],lint:103,linux:[11,14,17,57,97,99,100,101,103],list:[1,3,4,6,7,11,13,17,21,29,31,41,43,45,51,54,57,61,77,79,83,84,86,91,95,97,98,99,101,102,106,115],list_bucket:23,list_kei:23,listen:[11,17,23,39,57,77,89,97,99,101],listen_address:14,littl:17,live4:7,live51:7,live5:7,live5_low_bitr:7,live:[7,17,20,29,45,54,61,86,93,97,99],load:[11,17,20,42,43,81,83,95,99,111,112,115],load_schema:99,loadavg:[11,29,54],loadbalanc:17,local0:13,local:[11,13,14,17,20,27,28,29,30,32,47,50,54,55,66,87,89,91,93,97,99,100,101,108,109,110,112],localcachestatu:97,localhost:[4,11,13,14,22,26,100,101],localpassword:86,localst:97,localus:[45,86],locat:[0,6,7,9,10,13,17,18,20,24,29,31,33,39,54,56,57,67,69,77,92,99,100,102,103,104,108,109,111,112,115],location1:[35,72],lock:97,log4j:[17,20,101],log:[0,1,4,7,8,11,13,17,21,23,24,25,26,33,45,57,67,77,86,92,95,97,98,99,109,111],log_level:[13,21],logformat:16,logic:[1,7,11,104],login:[4,8,9,14,17,21,22,23,26,45,86],login_dispers:21,logo:[11,42,81],logobject:16,logourl:[11,42,81],logout:[17,45,86],logs_xml:16,logsen:[31,57,77,86],longdesc1:[31,57,77,86],longdesc2:[31,57,77,86],longdesc:[31,57,77,86],longer:[3,11,17,45,77,86,93,97],longest:11,longitud:[17,19,20,28,29,31,50,54,57,77,86,87],look:[11,23,91,93,99,101,115],lookup:[6,13,17,20,31,57,77,86],loop:7,lot:[17,21,97,104],low:[17,20],low_bitr:7,lower:[11,20,115],lowercas:17,lowest:115,ltd:11,lua:16,m3u8:[7,20],machin:[17,20],maco:[97,99,100,101,103],made:[4,6,17,20,21,22,30,45,55,86,99],mai:[2,6,11,13,14,15,17,20,45,57,86,97,99,101,111,112],mail:[11,106],main:[17,19,26,39,57,77,91,99,101],maintain:11,mainten:[17,31,57,77,114],maintenanceperc:[29,31,54,57],major:[21,92,97,109],make:[1,7,9,10,11,14,15,16,17,20,21,22,26,29,31,45,57,77,86,92,101,103,104,109,112,115],makedispatchmap:97,manag:[0,2,8,14,19,20,31,39,57,77,92,96,97,109,113],mandatori:51,mangement:99,mani:[3,11,17,20,21,45,86,92,97,99,109,112,113,115],manipul:17,manner:[99,113],manual:[2,3,4,17,20,22,96,104,109],manufactur:[39,77],map:[4,17,20,29,31,46,54,57,61,91,93,97,102,104,108,115],mar:[42,81],mark:[3,17,19,31,48,57,77,86,97,99,112],masklen:11,master:[21,26,99],match:[1,7,9,11,13,14,16,17,19,20,26,43,45,77,83,86,90,91,93,104],matchlist:[29,31,54,57,77,86],matchset:[29,54],matchtyp:[29,54],matter:[17,19,20],maven:101,max:[4,13,17,20,26,29,31,45,49,54,59,86,90,116],max_simple_retri:[6,17],max_unavailable_server_retri:[6,17],maxdnsansw:[31,57,77,86],maxdnsipsforloc:[29,54],maxgbp:[29,54],maximum:[11,17,20,31,39,57,77,86,90,99],maxkbp:[49,116],maxlibrarysizeestim:[31,57],maxmind:[11,14,20,57,108,115],maxrevaldurationdai:11,mayb:91,mbp:17,mbpsout:19,md5:[11,14,17],mean:[6,11,17,20,21,29,31,54,57,77,86,90,112],meant:[22,117],measur:[31,57,115,116],mechan:[17,20],media:[11,92,106,109],median:31,mega:4,member:10,memori:[17,20,97],mention:22,menu:[0,22,109],merg:112,messag:[0,17,21,26,30,31,39,43,45,46,47,50,51,52,53,54,55,57,58,61,71,73,74,77,83,86,87,89],met:[31,57],metadata:[24,67,109],meter:115,method:[4,11,17,20,26,31,45,57,86],metric:[49,59,103,112,116],metric_typ:[29,31,54],metrictyp:[49,59],mgmtipaddress:[39,57,77],mgmtipgatewai:[39,57,77],mgmtipnetmask:[39,57,77],microthread:97,mid1:11,mid:[0,6,9,11,17,19,21,31,39,41,42,57,71,77,79,81,86,91,104,108],mid_ats_:12,mid_loc:[28,50],middl:91,midheaderrewrit:[31,57,77,86],midnight:116,might:[17,20,21,99,112,115],migrat:[0,11,20,99,109,113],miker:11,mile:[11,35,72],million:[92,109],millisecond:[17,20,98],min:[11,20,29,31,49,54,59],mind:99,mine:[103,116],mini:[39,77],minim:[11,14,15,20,91,92,101],minimum:[0,17,29,54,93,101,109],minut:[11,14,17,21,93,99,101,113],mis:[17,45,86],misc:[4,11,17,23,99],miscellan:[17,99],miss:[17,20,29,31,54,57,103,104,112],misscoordin:[29,54],misslat:[31,57,77,86],misslong:[31,57,77,86],mix:11,mkdir:11,mkisof:17,mmdb:[14,20],mnt:17,mode:[9,11,21,95,99],model:[39,77],modif:17,modifi:[3,15,17,19,20,45,86,90,91,100,101],modul:[9,14,21,101],modulu:11,mojo:99,mojo_mod:99,mojolici:[4,8,26,99,113],mojoplugin:99,monitor:[0,1,7,11,12,17,20,21,22,26,29,42,48,54,77,81,84,92,96,99,101,103,104,106,108,109,110,111,113,114,116],monitorconfig:97,monitorconfigpol:97,monkei:[107,109],monthli:22,morbo:99,more:[1,2,5,6,11,17,20,22,23,26,31,39,42,45,57,62,63,65,74,77,81,86,91,93,97,99,106,112,115],most:[3,11,13,17,20,26,39,57,77,90,97,99,100,101,103,115],mostli:[17,20,91,97,99],mount:17,move:[17,111,115],movi:[17,19,106],mp4:20,msec:4,msg:4,mso:[6,17],mtu:[13,17,19,39,57,77,99],much:[14,20,22,99,115],multi:[0,5,20,31,57,77,86,115],multipl:[6,11,17,20,31,42,57,81,92,97,103,104],multipli:17,multisiteorigin:[31,57,77,86],multisiteoriginalgor:[31,77,86],multisiteoriginalgorithm:[31,77,86],must:[4,6,7,8,9,11,13,14,15,16,17,19,20,26,31,51,57,73,77,91,97,117],mutex:97,mutual:7,mvn:101,my_coordin:87,my_ds_1:57,my_ds_displayname_1:57,mycdn:[16,23],myd:[16,89],mydeliveryservic:[20,115],mydivision1:[37,60,75],myhead:20,myorigin:[31,57],myphylocati:[35,72],myphylocation1:[35,72],myregion1:[35,37,72,75],mysecret:22,mysql:15,n0h:7,n6g:7,name:[0,1,6,7,9,11,13,14,17,19,20,21,22,23,25,27,28,29,30,31,34,35,36,37,38,39,41,42,43,44,45,46,47,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,69,70,71,72,73,74,75,76,77,79,80,81,82,83,84,85,86,87,89,91,93,95,97,101,103,106,109,115,117],nameserv:17,namespac:99,narrow:[9,17],nation:20,nativ:[24,95,109],natur:99,navig:[0,12,99,100,103,109],nearest:[17,101,108],necessari:[2,4,11,17,20,22,23,45,86,101],necessarili:[84,104,115],necessit:97,need:[0,1,2,7,9,11,13,14,16,17,20,21,22,23,31,45,57,68,74,86,97,99,100,101,103,104,109,113],neg:[31,57],negativecachingcustomizationnot:[31,57],neither:[6,91],net:[2,4,8,9,14,16,17,20,21,22,23,29,30,31,34,36,39,42,50,54,55,57,69,70,71,77,81,86,91,101],netaddr:11,netinstal:69,netmask:[17,39,57,77],network6:17,network:[0,14,17,20,39,57,77,91,94,104,108,109,111,112,115],network_lin:17,neustar:[57,101],neustargeolocationservic:101,never:[41,57,77,79,86],newcastl:[29,31,54,57],newcount:[30,55],newdir:11,newli:[6,11],newlin:17,newlogcount:[30,55],newus:[45,86],next:[14,97,101,111],ngb:20,ninetyeighthpercentil:[49,59],ninetyfifthpercentil:[49,59],nix:[97,99,100,101,103],no_detail:20,no_dns_just_forward_to_par:17,noarch:[14,15],nodata:20,node:[1,18,20,22,100,114],node_modul:100,nodej:18,nodenam:23,nodesourc:18,noerror:[4,20],nolq:99,non:[7,9,16,17,20,21,26,31,50,57,77,86,112],none:[17,19,21,27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,53,54,55,57,58,59,60,61,62,63,65,66,68,69,71,72,73,75,76,77,78,79,80,81,82,83,85,86,87,89,90,101],nor:[6,91],normal:[17,20,21,115],not_a_par:11,notabl:11,note:[11,16,17,20,21,26,29,31,54,57,77,86,90,91,96,99,109],notic:[4,95],notifi:97,notimp:20,now:[2,4,6,8,14,15,16,17,21,22,23,29,41,54,79,86,97,101,104,112],npm:100,nsec3:20,nsec:20,nsf:99,nubmer:6,number:[2,9,11,14,17,19,20,21,22,27,29,30,31,39,47,54,55,57,77,86,98,99,104,112,115],numer:[17,99],nxdomain:20,nyc:[30,55,104,115],object:[11,17,26,45,57,86,90,97,112,115],objectnam:[45,86],objecttyp:[45,86],obtain:[4,20,91,99,104],occur:[17,20,26,30,55,91,112],oct:57,odol:[20,30,32,55,66,68],off:[17,20,22,23,26,104],offer:115,offici:[19,114],offlin:[19,22,29,31,39,41,54,57,77,79,112],offlinereason:[39,57,77],ofqdn:6,often:[17,92,93,104,115],old:[11,17,113],oldcfg:11,older:[17,20,106],omg:61,omit:[17,69],onc:[0,2,3,9,10,11,16,17,20,22,23,84,99,103,116],one:[2,3,4,7,11,17,20,22,23,29,31,51,54,57,62,63,65,74,77,80,86,92,97,99,103,104,108,109,112,115],ones:[29,97],onli:[1,2,3,4,7,14,17,19,20,21,22,23,26,31,34,38,45,50,51,57,71,74,76,77,86,90,91,95,97,98,99,100,102,104,111,112,113,117],onlin:[9,19,20,21,22,29,31,39,41,54,57,77,79,104,112],onward:20,ooff:[29,54],opcod:4,open:[15,17,91,93,99,101,106,109,111,115],openssl:[11,20],openssl_configur:14,oper:[0,3,13,17,19,21,30,31,35,37,45,46,47,50,51,52,53,54,55,56,57,58,60,69,70,71,72,73,74,75,77,82,84,86,87,89,92,93,97,99,112,113,116],oppos:91,opposit:99,ops:[3,4,9,14,17,20,21,22,23,57,97,108,117],opsconfig:97,opsconfigfilehandl:97,opt:[9,10,11,13,14,15,18,20,21,22,23,56,99,101],optim:[92,101,108,115],optimist:[97,99,112],option:[0,1,3,4,6,7,11,13,16,18,19,21,22,26,30,31,39,55,57,77,95,98,99,101,115],order:[0,2,6,8,11,13,17,22,23,51,58,80,99,104,116,117],orderbi:[25,31,57],ordinari:11,org:[6,11,14,15,17,19,21,31,57,97,99],org_loc:50,organ:[11,14,17,31,57],organiz:[11,14],orgserverfqdn:[31,57,77,86],origin1:89,origin2:89,origin:[0,4,5,9,11,16,19,20,24,26,29,31,45,54,57,77,86,88,90,91,93,104,106,108,109,112,115],origin_tp:[29,54],originhead:[31,57],originshield:[31,57,77,86],origintestfil:[31,57],originurl:[31,50,57],orm:99,orphan:17,ort:[0,11,13,17,19,23,99],osvers:[11,69],osversiondir:69,other:[0,6,7,9,11,14,17,20,21,31,57,69,91,93,97,99,104,109,111,112,113,115],otheroriginsecur:[31,57],otherwis:[2,7,19,41,79,95],otr:99,ott:[29,31,54,57],our:[17,22,23,105,106],out:[11,17,20,26,39,45,48,57,77,86,91,99,103,106,112],out_byt:59,outag:[17,112],outbyt:97,outlook:112,output:[11,14,15,17,95,112],outsid:[17,20,115],outweigh:[20,97],over:[17,20,29,31,49,57,77,86,92,99],overal:[17,19,20,112,116],overflow:[17,29,31,54,57,112],overflowcdn:[31,57],overflowservic:[31,57],overload:[17,45,86,111,115],overrid:[11,17,20,99,101],overridden:101,overview:[0,17,19,22,24,29,54,96,98,112],overwrit:[11,97,99],own:[14,15,16,17,21,22,57,77,86,97,101,112,115],owner:[14,91],p2p1:77,pace:17,pack:[39,77],packag:[0,11,14,17,21,95,96,100,103,109],packet:[17,19,99],page:[2,6,11,13,14,17,19,21,22,31,42,57,81,105,106,115],pagin:[31,57],pair:[17,20,57,77,86],pakistan:106,panel:22,panelid:22,panic:21,paradigm:97,param1:[71,74],param2:[71,74],param:[9,16,17,73,74],paramet:[0,1,6,7,9,12,16,20,22,24,25,26,27,28,29,30,31,32,33,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,72,73,75,76,77,78,79,80,81,82,83,84,85,86,87,89,97,98,101,104,108,109,112,115],parameter_id:[28,50,52,74],parameterid:[29,52,54,74],parameterprofil:74,paramid:74,paramt:[71,74],parent:[0,2,6,11,19,20,21,28,31,41,50,56,57,77,79,82,86,104,108,112],parent_origin:6,parent_pend:21,parent_proxi:17,parent_proxy_rout:6,parent_proxy_routing_en:17,parent_retri:[6,17],parentcachegroup:50,parentcachegroupid:[28,50],parentcachegroupnam:[28,50],parentid:82,parentnam:82,pars:[7,111],part1:17,part:[7,8,11,17,20,21,39,54,57,77,104],parti:[7,29,31,54,57,106],partial:98,particular:[11,17,91,104,108,112,115],parts0:17,parts1:17,pass:[11,17,19,22,23,26,31,57,77,86,97,103],passin:11,passout:11,passphras:14,password:[4,9,10,11,14,17,20,21,22,23,39,45,57,69,77,86,99,117],past:[20,22],patch:[16,46],path:[4,11,13,14,16,17,20,22,26,31,43,45,56,57,77,83,86,91,93,99,102,115],path_regexp:17,pattern:[8,17,31,57,58,77,86],pcre:[17,45,86],peak:[17,112],peakbpsestim:[31,57],peaktpsestim:[31,57],peer:[9,98,112],peeroptimist:9,peerstat:[97,98],peewe:[45,86],pem:11,pend:[3,17,19,45,77,84,86],per:[0,17,20,27,31,47,57,77,86,93,98,101,109,115],per_parent_connect_attempt:17,perc:[39,77],perceiv:99,percent:[17,19,57],percentag:[17,29,31,54,57],perform:[0,1,3,4,6,7,16,17,19,20,21,22,23,26,31,57,77,84,86,91,97,101,104,112,115,116],period:[13,17,19,20,21,99,113],perl5:[13,14,99],perl5lib:[13,14,99],perl:[4,9,11,14,21,26,96,109,113],perltidyrc:99,permiss:[3,14,15,86],permut:17,persist:20,perspect:113,pertain:112,pessimist:[97,99],pg_hba:14,pgdg:14,pgloader:15,pgsql:14,phase:14,philosophi:112,phl:104,phone:[35,72],phonenumb:[45,86],phy:[0,77],phys_loc:25,physic:[9,10,11,17,19,24,32,33,39,57,66,67,77,104,109],physloc:[39,57,77],physlocationid:[39,57,77],pick:[11,97],pictur:5,pid:9,pin:[20,99],ping:[13,17,19,23,43,83,99],pingabl:99,pipe:17,pittsburgh:[27,47],pkg:[18,96,109],pki:[11,23],place:[16,17,20,22,91,97,104],plai:99,plan:[20,31,57],plane:[94,111],planet:108,platform:[12,106],pleas:[11,14,17,20,26,45,56,86],plocat:[39,57,77],plugin:[0,9,11,17,31,45,57,77,86,99,108,109,112],png:[42,81],poc:[35,72],point:[9,10,14,17,20,23,31,35,57,72,77,86,93],polici:[1,22,57,103],poll:[1,7,9,10,11,17,20,22,29,54,97,99,101,104,111,112],poller:97,pollinginterv:22,pool:9,poor:17,pop:17,popul:[17,45,86,97],popular:17,populateddimmslot:[39,77],port:[9,10,14,15,17,20,22,23,26,29,39,54,56,57,77,89,91,93,101,115,117],portal:[0,3,17,26,80,86,96,109,110,111,113,116],portion:[20,31,57,77,86,91],portnam:77,posit:[8,99,112],possibl:[16,17,20,22,92,97,101,109,115],post:[4,16,20,26,29,31,35,37,39,43,45,46,50,51,52,53,54,57,58,60,61,62,63,64,65,69,71,72,73,74,75,77,80,82,83,86,87,89,99],postal:7,postalcod:[45,86],postgr:[14,15,99],postgresql96:14,postgresql:[14,99,113],postinstal:[11,14,99],power:[39,77],powercap:[39,77],poweredg:[39,77],powerst:[39,77],practic:20,pre:[11,14,16,17,20,22,29,31,54,57,101],pre_prod:77,precis:20,preclud:[17,19],precomput:97,preconfigur:99,prefer:[17,20,91],prefix:[16,17,20,69,77,108],prepar:[0,1,7,109],prepend:77,preprocess:97,prerequisit:17,presenc:11,present:[0,17,26,73,91,111,112],preserv:17,prevent:[11,17,20,31,57,77,86,99,111,112],previou:[11,14,17,91],previous:[14,16,20,91],primari:[6,17,20,36,71,73,89],primarili:[11,17,97],prime:17,primer:17,print:[21,99],prior:20,pristin:[31,57],priv:23,privat:[11,20,23,29,31,54,57,99,113,117],priveleg:4,privileg:[14,19,20,117],privlevel:[38,76],probabl:17,problem:[17,103,112],proce:[14,17,99],procedur:[11,20],process:[7,10,11,17,20,21,22,49,50,54,77,97,101,113,115,116],product:[0,14,17,22,23,42,81,99,106],profil:[0,6,9,14,16,20,21,22,23,24,25,29,31,33,34,39,42,45,48,52,54,57,67,71,77,81,86,89,107,108,109,115],profile_copy_from:73,profile_id:[56,74],profile_nam:[34,73],profilecopyfrom:73,profiledesc:[39,57,77],profiledescript:[29,31,54,57,77,86],profileid:[29,31,39,54,56,57,74,77,86,89],profilenam:[29,31,54,56,57,74,77,86],program:[11,116],programmat:26,project:[11,23,95,96,109,113],prompt:[9,14],prop:23,propag:[17,112,113],proper:20,properli:[2,17],properti:[11,16,17,20,26,27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,89,101],propos:9,proprietari:108,protect:112,protobuf:23,protocol:[0,9,10,17,19,29,31,41,54,57,77,79,86,89,91,92,93,98,108,109,110,115],prove:99,provid:[1,14,17,19,20,26,27,29,31,47,57,91,92,95,97,99,101,112,116],provinc:[11,14],provis:[31,57,91,99],proxi:[1,6,11,17,34,42,49,50,56,71,81,92,93,94,108,109,113,115,116],proxy_auth_to_par:17,proxy_nam:[34,50,71],psel:17,psql:14,pssc:[7,20],pub:14,publicli:99,publicsshkei:[45,86],publish:[9,20,98],publishdsst:9,pull:[11,17,21,42,81,101,103],puppet:21,pure:17,purg:[0,17,45,70,86,109],purge_allow_ip:11,purpos:[11,17,42,81,99],push:[11,17],put:[1,4,7,17,20,22,23,26,31,35,37,41,46,47,50,51,53,54,57,58,60,61,71,72,73,75,77,79,80,82,84,86,87,89,91],python:[17,26],qclass:20,qname:20,qrp:99,qstring:[0,19],qstring_handl:17,qstringignor:[31,57,77,86],qtype:[7,20],qualifi:[20,99],qube:106,queri:[4,9,17,19,20,22,23,31,39,44,45,46,47,49,50,51,55,56,57,59,70,71,72,73,77,85,86,87,89,97,98,103,115,116],querystringhandl:[31,57],querytim:[29,54],question:[4,6,14,21,106],queu:[17,77],queue:[0,3,19,20,21,50,54,77],queue_upd:[50,54,77],queueu:17,quick:[0,17,109],quickli:[17,22,97],quiet:95,quit:[11,93,115],quot:[17,20],qwilt:106,r720xd:[39,77],rack:[39,57,77],ram:[9,10,14,17,20,115],random:[17,21,91,93],rang:[11,17,31,57,64,77,86],rangerequesthandl:[31,57,77,86],rapid:21,rascal:[9,11,17,39,77,107,109],rascal_cdn:9,rate:[17,31,57],ratelimitinggbp:[31,57],ratelimitingtp:[31,57],rather:[17,45,86,104],ratio:[17,19,99],raw:[9,17,22,31,57,77,86,97,98,112],rc4:11,rcode:20,rcvd:4,rdtl:[7,20],reachabl:97,read:[11,14,17,26,38,46,53,76,97,101,112],readabl:[14,17,39,57,77,97],readi:[3,13,17,19,99,104,113],readm:[17,101],real:[17,19,111],realist:91,realli:17,reason:[17,39,57,77,97],receiv:[1,11,17,20,91,93,97,99,115],recent:[17,20,98,99],reciev:20,recommend:[0,11,16,17,22,42,81,95,103,109],reconcil:18,recor:54,record:[2,6,17,19,20,23,31,34,50,54,57,71,101,115],recreat:97,recurs:4,red:[11,17,90,91],redhat:[4,14],redirect:[0,1,7,17,31,57,101,109,115],redirecturl:[1,7],redo:99,reduc:[20,91,112],redund:[11,17,108,112,115],ref:[31,57,77,86],refer:[20,24,30,41,55,79,93,109,115],referenc:[11,54],reflect:[11,17,23,104],refresh:[17,20,29,54,112],refus:[20,26],regard:115,regardless:[6,20,112],regener:[2,17],regex:[0,7,11,16,19,24,29,31,45,54,57,67,77,86,109],regex_remap:17,regex_revalid:[11,17,45,86],regexp:[0,31,57,77,86],regexremap:[31,57,77,86],region:[0,5,17,20,24,25,33,35,57,67,72,104,109],region_id:[35,72],region_nam:[35,72],regional_geo_alternate_without_cach:20,regional_geo_no_rul:20,regional_geoblock:[7,20],regionalaltern:57,regionaldeni:57,regionalgeoblock:[31,57,77,86],regionid:[35,72],regionnam:[35,72],regist:[13,17,19,20,86,97,99],registr:86,registrations:[45,86],regular:[11,17,20,45,86,112,113],reject:[5,19,20,50],rel:[11,17,19,20,42,81,111],relai:22,relat:[11,17,20,27,47,51,99,112],relationship:[6,20,104],releas:[9,11,15,16,17,22,107,109,111],reli:17,reliabl:20,reload:20,remain:[20,112],remap:[0,19,29,31,54,56,57,77,86,91,112,115],remap_pseudo_hook:6,remap_requir:17,remap_stat:11,remaptext:[31,57,77,86],rememb:14,remot:[17,39,77],remov:[11,15,16,17,20,45,57,62,65,77,86,97,113],renew:57,renewal_kid:57,repeat:[17,29,54,57],replac:[0,15,17,19,57,62,63,65,74,100,114],replic:22,replica:17,repo:[14,15,17,101,103],report:[9,17,19,21,30,41,48,55,68,77,79,99,104,112],repositori:[14,97,99,100,101,103],repres:[7,20,29,54,84],req:11,request:[0,1,4,5,7,8,11,16,17,20,21,26,28,29,30,31,34,35,36,37,39,41,43,44,45,46,47,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,69,70,71,72,73,74,75,77,79,80,82,83,84,85,86,87,89,90,91,92,93,99,101,102,103,111,112,113,115],requestpath:102,requir:[0,1,2,3,6,7,8,9,10,11,16,17,18,19,20,21,22,27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,89,91,96,109,113,116],requisit:22,rerr:[7,20],reserv:[3,99],reset:[45,86,90,99],reset_password:[45,86],resid:[97,101],resign:17,resolut:[13,20],resolv:[4,9,10,14,17,20,24,61,67,91,93,101,109,115],resolve4:[4,61,63],resolve6:[4,61],resourc:[18,20,26,101],respect:[6,97,112],respond:[6,7,17,19,20,90,91,93,115],respons:[1,2,4,6,9,17,19,20,24,27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,89,90,91,93,97,99,109,111,112],rest:[9,10,17,24,26,99,109,112,117],restart:[14,20,21,23,97],restor:20,restrict:[17,31,57,112],resuabl:101,result:[17,19,20,31,39,57,77,91,92,97,99,102,103],retent:[22,103],retri:[6,17,21,29,54],retriev:[0,7,17,23,29,31,39,41,43,45,48,49,50,51,54,57,58,59,61,62,63,65,69,71,77,79,83,84,86,91,93,115,117],retry_tim:17,reus:[91,92,115],reusabl:101,rev_proxi:11,reval_pend:11,revalid:[4,11,17,21,26,45,86,94,109],reveal:20,revers:[11,17,56,94,108,115],review:[3,19,68,109],rewrit:[0,6,31,57,77,86,115],rewritten:[11,113],rfc:[20,57,93],rgalt:[7,20],rgb:[0,5],rgdeni:[7,20],rhel:14,riak:[0,2,11,17,31,57,109,117],riak_al:[11,23],riak_cor:23,riak_kv:23,riak_search:23,riakserv:23,riakus:23,riakuserpassword:23,right:[17,26],ring:[17,20],rloc:[7,20],robin:17,role:[0,3,4,8,14,17,20,24,25,27,28,29,30,31,32,33,34,35,36,37,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,77,78,79,80,81,82,83,84,85,86,87,89,99,109],rolenam:[45,86],roll:[0,99],rollup:116,root:[11,13,14,17,20,23,57,77,82,86,97,101],rootpass:69,rotat:[17,111],round:17,round_robin:6,rout:[0,1,7,8,11,17,19,20,24,28,30,31,34,35,36,37,39,41,43,44,45,46,47,50,52,53,55,56,57,58,60,61,62,63,64,65,71,72,73,74,75,77,79,80,82,83,84,85,86,97,99,101,108,109,110,111,112],router:[0,1,2,4,7,8,11,12,13,16,19,23,29,31,36,39,42,54,57,71,73,77,81,84,86,92,96,97,98,99,104,106,109,110,111,112,113],router_top:[31,57,77,86],routerhostnam:[39,57,77],routerportnam:[39,57,77],routingdis:73,routingnam:[57,77,86],routingtyp:[31,57],row:[17,31,39,48,55,57,77,86],rpm:[9,11,14,15,18,21,22,95,96,99,103,109,113],rpmnew:18,rsa:[11,14],rtr:[13,17,19,39,57,77,99],rtype:[1,7,20],rubi:100,rule:[1,7,17,20,31,45,57,77,86,91,112,115],run:[0,9,10,11,13,14,15,17,19,20,21,22,23,95,97,99,100,101,103,107,109,112,113],rurl:[7,20],rvl:19,safe:[16,57],sai:[5,17,22,112],salt:17,same:[6,7,8,11,16,17,19,20,22,31,45,57,73,86,90,91,97,104,112,113,115],sampl:[0,8,9,11,21,22],sanjos:[28,50],sass:100,sat:26,satisfi:[31,57],save:[6,11,14,17,20,21,22,112],sbt:99,scalabl:115,scale:[17,20],scaleabl:11,scenario:[11,20,91,115],schedul:[17,21,45,86],schema:[23,99],scheme:17,scope:[11,56],scratch:[0,11],screen:[2,5,6,8,11,17,22,42,81],screenshot:2,script:[0,9,11,13,17,19,20,22,23,95,99,101],script_fil:[43,83],scroll:21,sda:[11,17,69],sdf:11,search:[0,11,17,93,99,109,111],search_index:23,sec:[17,23],second:[2,11,17,20,21,22,31,57,77,86,90,93,115,116],secondari:[6,28,29,50,54],secondaryparentcachegroup:50,secondaryparentcachegroupid:[28,50],secondaryparentcachegroupnam:[28,50],secret:[14,17,113],secret_passwd:26,section:[4,9,11,14,17,19,20,21,22,56,93,109,111,115],secur:[17,20,23,31,34,45,50,57,71,74,77,86,113],see:[2,6,9,10,11,13,14,17,19,20,21,22,23,29,31,39,54,57,59,77,86,91,93,94,97,99,104,105,106,108,112,113,114,115],seed:[13,99],seelogconfig:22,seelong:22,seen:97,select:[0,6,9,11,12,13,20,21,22,25,43,83,101,108,115],self:[0,17,23],selinux:15,semicolon:[20,101],send:[4,11,17,20,31,41,45,57,77,79,86,90,91,93,97,99,106,112,115],sens:[17,20,45,86],sensit:113,sent:[6,11,17,20,26,29,31,45,54,57,77,86,92,109],separ:[9,11,13,16,17,20,21,57,77,86,97,98,101,113,115],seper:22,seri:[20,49,59,113],serv:[0,7,11,17,19,20,31,39,57,77,86,91,97,98,100,104,108,112,113,114,116],server1:57,server2:57,server:[0,1,2,4,6,7,9,10,11,12,13,14,15,18,20,22,23,24,25,26,27,29,30,32,33,34,36,41,43,47,50,54,55,66,67,71,73,79,83,84,86,90,91,92,93,97,99,100,101,103,104,108,109,111,112,113,114,115],server_graph_url:22,server_typ:31,servercheck:[39,77,99],servercheck_short_nam:[39,43,77,83],serverhostnam:[23,32,66],serverid:[32,56,57,66,77],serveripv4:56,servernam:[50,56,57],servertcpport:56,servic:[0,1,2,4,5,6,7,9,10,11,13,14,16,18,21,22,23,24,27,29,33,39,45,47,50,54,61,67,70,77,80,84,86,89,97,98,99,101,102,103,104,108,109,110,111,112,113,114,116],servicealias:[31,57],servicedesc:[31,57],servicetag:[39,77],session:[9,17,45,86],set:[0,3,4,6,7,9,10,11,12,14,15,16,17,18,19,21,26,31,42,45,57,69,77,81,84,86,97,99,101,104,108,112,115],set_bucket:23,setenv:20,setnumb:[31,57,58,77,86],setsockopt:17,setup:[0,11,14,17,22,99,109],setup_6:18,setup_kabletown:99,seven:101,sever:[6,17,20,22,93,101,112,113],sha256:11,shall:7,shanghai:[35,72],share:[6,11,17,22,101,104,112,113],shield:[17,57],ship:11,shortnam:[28,35,50,72],shot:5,should:[2,3,6,8,9,11,14,15,16,17,20,21,22,23,45,51,86,97,98,99,101,111],show:[2,3,6,7,17,19,93,99],shown:[21,91,99],shutdown:9,side:[17,100,115],sign:[0,2,12,17,19,23,29,31,54,77,86,117],signal:[11,97],signatur:[11,17,19,20],signaturemanag:17,signific:[17,97],significantli:[11,17,42,81],signingalgorithm:[31,57],signkei:11,silent:[18,57],sim:20,similar:[17,20,41,79,91],simpl:[11,16,17,20,22,23,45,86,99,101],simple_retri:[6,17],simple_retry_en:6,simple_retry_response_cod:[6,17],simpler:97,simpli:[0,7,17,22,97],simplifi:93,simpson:[45,86],simultan:[17,51],sinc:[17,20,90,91,97,98,115],singl:[11,16,17,20,52,71,74,92,97,99,104,109,112,113],site:[0,5,9,10,20,31,57,77,86,112,115],situat:[17,93,112],siwv3gohwn7ee9wswpfj18qe4m07sfxn:57,six:80,size:[4,6,17,22,45,86,99],skin:18,skip:14,slack:106,slot:[39,77],slow:17,slower:[95,97],small:[17,20,97,115],smaller:[17,22],smooth:17,snapshot:[0,1,3,7,9,16,19,20,24,30,55,67,97,104,109],snarf:17,so_max_pacing_r:17,soa:[17,20,29,54],socket:[101,115],softwar:[11,96,104,106,109,111],sole:[11,113,115],solo:22,solr:23,solv:17,some:[3,5,11,14,15,16,17,20,22,57,97,99,112,115],some_crt:[31,57],some_csr:[31,57],some_kei:[31,57],somecdn:101,someth:[16,17,20,45,86],sometim:[5,17,20,45,86,106],soon:16,sort:[17,22,70],sortat:7,sourc:[0,15,17,18,19,22,23,59,92,95,100,101,103,106,108,109,111,113],space:[14,16,17,20],spec:[90,93],special:[11,17,20,31,57,77,86,112],specialti:17,specif:[0,11,12,17,22,31,32,42,45,50,54,57,58,66,77,81,86,91,99,113],specifi:[9,10,11,17,20,29,31,54,57,69,77,98,112],speed:[17,45,86],split:20,splunk:17,spread:[11,17],sql:[13,14,17,99],sqqkbr6lqeozp8aewzucvtbcw_8yfc1g:57,sr2:101,src:[11,95,97,100,101],srvhttp:97,ssh:[17,19,99],ssh_key_edge_us:13,ssl:[0,17,19,20,21,23,109,113,117],ssl_multicert:56,ssleai:21,sslkei:[23,31,54,57],sslkeyvers:[31,57,77,86],stack:17,stage2:17,stage:[42,81,97],stai:15,stale:11,standalon:23,standard:[11,17,20,101,103,113],start:[0,9,10,11,12,14,16,17,18,19,21,29,31,45,54,57,70,77,86,96,97,98,99,100,101,112,115],start_dat:[29,31,54],startdat:[49,59],starthealthresultmanag:97,startmonitorconfigmanag:97,startpeermanag:97,startstatecombin:97,startstathistorymanag:97,starttim:[45,70,86,98],startup:[20,112],startupmincycl:9,stat:[0,11,17,29,31,42,49,54,59,68,81,84,96,98,99,102,109,110,111],state:[9,10,11,14,17,19,20,21,31,35,41,57,72,77,79,84,98,99,101,102,104,111,112],statecombin:97,stateorprovinc:[45,86],static_rout:20,staticdnsentri:[25,44,85],staticrout:[29,31,54,57],statinfohistori:97,statist:[11,19,24,67,97,98,99,103,109,111,112,116],statisti:17,statmaxkbps:97,statresulthistori:97,stats_over_http:108,statsummari:98,statu:[3,4,14,17,19,20,21,22,24,29,30,33,39,45,48,54,55,57,67,77,86,99,104,109,112],status:[0,25],status_4xx:[59,116],status_5xx:[59,116],statusid:[39,57,77],statustomon:22,stddev:31,stead:[17,90],steer:[0,5,17,19,24,57,67,102,109],steering_ord:80,step:[0,3,4,11,14,16,20,23,93,101,104,109,115],still:[7,11,13,17,19,20,90,95,101,106,112],stop:[11,14,17,18,20],storag:[11,14,17,20,34,50,71,112],store:[2,4,8,14,17,20,22,23,26,41,56,57,79,91,97,99,103,113,116,117],straight:17,stream:17,streamlin:11,strict:[6,17],strictli:112,string:[17,19,20,26,27,28,29,30,31,32,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,89,98,115],strip:15,struct:[39,77,97],structur:[17,24,97,99,109],stylesheet:99,sub:[14,17],subdomain:20,subject:11,submit:[3,11,12,17,19,21],submodul:101,subnet:[1,7],subscrib:97,subsequ:[26,91,115],subset:20,success:[4,9,10,14,15,20,26,29,31,35,37,39,43,45,46,47,50,51,52,53,54,57,58,60,61,62,63,64,65,69,71,72,73,74,75,77,80,82,83,84,86,87,89,99],successfulli:[2,4,17,20,23,26,29,31,39,45,50,54,57,71,74,77,86],sudo:[9,10,11,14,15,18,20,21,22],suffic:23,suffici:17,suggest:[0,2,11,117],suitabl:[17,20,101],sum:[17,22,29,31,54],summar:116,summari:[0,22,31,39,49,59,98,116],sun:[26,90,91],supercdn:14,superus:14,suppli:[26,39,77,91],support:[1,2,7,11,12,14,16,17,20,23,45,86,101,111],supress:95,sure:[9,10,14,15,16,17,20,21,22,29,104],symmetr:57,syn:17,sync:[17,21,22,103],sync_ts_databas:22,syncd:[11,17,21],synchron:112,syntact:17,syntax:17,sys:23,sysctl:17,syslog_facil:13,sysmemtotals:[39,77],system:[0,5,9,11,13,17,19,20,24,27,30,33,39,47,55,67,77,90,92,97,104,108,109,112],systemat:17,systemctl:[14,21],t_integr:99,tab:[9,11,17,22,98],tabl:[0,7,9,11,13,19,21,23,39,44,77,85,99,104,107],taco:70,tag:[17,49,59,116],taht:[31,57,77,86],take:[2,9,11,14,15,16,17,20,21,22,45,86,97,101,112,113],taken:[16,17,20,23],talk:0,tar:[14,15,95],tarbal:15,tarball_vers:15,target:[8,15,17,19,20,22,24,67,99,109],targetid:80,task:11,tbd:[17,29,54],tc1_ats1:[57,77],tc1_ats2:77,tc_logo:[42,81],tcdomain:21,tcoveragezon:[29,54],tcp:[17,20,23,39,57,77,89,91,93,101],tcpport:[39,57,77],tcr0ck:14,team:[2,31,57],technic:[97,104],technolog:92,televis:115,tell:[11,17,90],temp:[9,16],templat:99,temporari:[41,79,99],temporarili:[100,115],tenanc:19,tenant:[0,3,17,24,57,67,77,86,89,92,109,115],tenanta:89,tenantid:[57,77,86,89],term:[20,77,103,116],termin:101,test:[13,15,16,17,19,20,31,57,77,96,102,109],text:[4,11,17,26,31,35,37,39,43,45,46,47,50,51,52,53,54,56,57,58,60,61,62,63,64,65,69,71,72,73,74,75,77,80,82,83,86,87,89,90,91,93],tha:99,than:[1,5,11,17,20,22,31,45,57,77,86,95,97,104],thei:[3,6,8,11,16,17,20,22,29,44,85,91,97,98,103,104,116,117],them:[17,20,21,22,26,29,77,97,103,115],themselv:11,therebi:91,therefor:17,thi:[0,1,2,3,4,6,7,8,9,10,11,13,14,15,16,17,19,20,21,22,23,26,27,28,29,31,32,34,35,36,39,41,42,45,47,50,54,57,66,71,72,73,74,77,79,81,84,86,87,89,90,91,93,95,96,97,98,99,101,102,103,106,111,112,113,115],thing:[3,9,17,22,97],third:[7,106],thorough:68,thoroughli:16,those:[16,17,95],though:[26,104],thousand:[5,17,92,109],thread:[9,20],threadpool:[9,17,29,54],threadsaf:97,three:[1,3,7,22,91,99,104,112,113,116],threshold:[11,17,29,54,112],through:[9,11,17,20,42,77,81,91,99,111,112,113,115,116],throughout:20,throughput:[20,112],thru:[19,97],thu:[4,7],ticketnum:[30,55],tidi:99,tier:[0,11,17,31,42,57,77,81,86,104,108],time:[2,4,9,10,11,13,14,15,17,19,20,21,22,23,27,28,29,31,32,34,36,39,41,45,47,49,50,54,57,59,61,66,70,71,73,77,79,86,87,89,90,93,97,99,100,101,111,115],timefilt:22,timeout:[9,17,29,54],timepad:[9,29,54],timer:[11,90],timestamp:[19,29,54],timezon:14,tini:97,titl:22,tld:[2,17,20,29,54],tls:[11,23],tls_protocol:23,tlsv1:23,tm1:11,tmhostnam:[9,17],tmp:[8,17,21],to_develop:99,to_extens:13,to_hom:[13,99],to_pw:23,to_test:99,to_un:23,to_url:23,tocducheck:13,tochrcheck:13,todai:[91,92,109],todata:97,todscpcheck:13,tofqdncheck:13,togeth:108,token:[0,19,31,45,57,77,86,99,113,115],tom:[45,86],tomcat:[9,20,101],tommyboi:[45,86],too:[11,17],took:20,tool:[0,1,2,4,7,11,15,20,42,81,97,103,104,109,113],toolnam:[11,42,81],tools_serv:17,toortcheck:13,top:[2,17,20,22,29,31,36,49,57,71,77,86,95,99],topasswd:22,topic:94,topingcheck:[13,99],topolog:[0,109],tor:1,torevproxyurl:56,tortrcheck:13,tosess:97,total:[17,19,20,29,31,54,57,59,77,99,116],total_connect_attempt:17,totalbyt:59,totalkbpsthreshold:[29,54],totalofflin:[29,31,54,57],totalonlin:[29,31,54,57],totaltpsthreshold:[29,54],totaltransact:59,tourl:[22,56],touser:22,toward:17,tps:[29,31,54],tps_2xx:[31,59,116],tps_3xx:[31,59,116],tps_4xx:[31,59,116],tps_5xx:[31,59,116],tps_total:[59,116],tr1:11,trace:21,track:[30,32,55,66,111],traffic:[0,1,2,3,4,6,7,8,24,26,29,31,33,39,41,42,43,45,48,54,56,57,59,67,73,77,79,81,83,84,86,88,90,91,92,93,94,96,107,108,111],traffic_control:[26,97,99,100,101,103,104],traffic_lin:11,traffic_mon:9,traffic_mon_fwd_proxi:[11,42,81],traffic_monitor:[9,10,20,68,97,101],traffic_monitor_build:95,traffic_monitor_config:9,traffic_monitor_golang:97,traffic_monitor_host:101,traffic_monitor_profil:12,traffic_op:[9,10,11,12,13,14,20,23,42,69,81,95,97,99,101,103],traffic_ops_:22,traffic_ops_build:95,traffic_ops_cachegroup:22,traffic_ops_db:[0,109],traffic_ops_devliveryservic:22,traffic_ops_extens:99,traffic_ops_golang:11,traffic_ops_ip:13,traffic_ops_login:21,traffic_ops_ort:[21,95,99],traffic_ops_serv:22,traffic_ops_url:21,traffic_port:[18,100],traffic_portal_build:[18,95],traffic_portal_properti:[3,18,19],traffic_rout:[20,101],traffic_router_api:101,traffic_router_build:95,traffic_router_connector:101,traffic_router_cor:101,traffic_router_profil:12,traffic_rtr_fwd_proxi:[42,81],traffic_serv:21,traffic_stat:[17,22,103],traffic_stats_build:95,traffic_stats_profil:12,traffic_traffic_rout:101,trafficcontrol:[15,19,21,26,29,54,95,97],trafficmonitor:[29,54],trafficmonitorurl:21,trafficop:[11,21,24,109],trafficopsdata:97,trafficopshost:[29,54],trafficopspath:[29,54],trafficopss:11,trafficopsus:[29,54],trafficopsvers:[29,54],trafficopswrapp:97,trafficrout:[29,54],trafficrouterstart:101,trafficserv:[11,16,21,29,54,56],trafficstat:[59,99],traffop:[21,42,81],trafop:11,traiffic:17,trail:16,tran:13,transact:[17,20,31,57,77,86,92,93,97,112,115],transaction_active_timeout_in:6,transfer:93,transit:17,translat:17,transmiss:[39,57,77,99],transpar:[11,94,113],treat:[17,19,31,57,77,86,90,98,104],tree:[11,17,21,26,96,109],tri:[17,104],trial:17,trigger:[17,20,101],trim:[28,35,36,44,50,72,73,85],trivial:5,troubleshoot:[0,92,109],trred:17,trrequesthead:[31,57,77,86],trresponsehead:[31,57,77,86],tsimpson:[45,86],ttl:[11,17,20,29,31,40,45,54,57,61,70,77,78,86,93],ttm:[7,20],tue:115,tune:[0,109],turn:[6,17,20,104],tutori:5,twelv:[107,109],two:[7,8,10,11,17,20,22,52,74,80,99,104,112,113,116],txt:[9,17],type:[0,1,3,4,6,8,9,13,14,21,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,86,87,89,90,91,93,97,98,99,104,109,113,117],typeid:[28,31,39,50,57,64,77,80,86],typenam:[28,50,58],typic:[11,17,22,45,69,86,92,93,97,103,104,116],typo:16,udp:[20,101],uefi:[39,77],ugli:17,uichang:[30,55],uid:[45,86],unabl:20,unassign:[5,57],unassigned_paramet:[50,71],unassigned_profil:71,unauthor:[26,45,86],unavail:[17,20,31,57,97,112],unavailable_server_retri:6,unavailable_server_retry_respons:6,unavailable_server_retry_response_cod:17,unavailableperc:[29,31,54,57],unawar:91,uncacheable_requests_bypass_par:17,uncommon:112,under:[11,14,17,20,22,42,57,77,81,86,98,103,107,109,111],understand:[17,93,99],unexpect:16,unfilt:9,unforeseen:15,unhealthi:[19,48,77],uniqu:[6,17,19,27,28,30,31,32,39,45,47,50,55,57,61,66,70,77,86,87,89,90],unit:[11,13,14,17,31,39,57,77,99,101,103],unix:[11,17,29,31,54],unknown:[9,11,19,77],unless:[6,39,57,77,100],unlik:[11,17],unlimit:11,unlink:57,unlockexperimentalvmopt:20,unmarshal:97,unnecessari:[17,45,86],unquot:20,unsort:57,unspecifi:16,unsur:17,until:[17,20,93,101],unus:6,unusu:[11,20,97],uodat:17,upd:[17,19],updat:[0,5,9,11,14,18,19,20,21,23,27,28,30,32,34,35,36,37,39,41,45,46,47,50,51,53,54,55,57,58,60,61,66,71,72,73,75,77,79,80,82,86,87,89,91,97,113],update_riak_for_search:23,updpend:[39,57,77],upgrad:[0,16,18,99],upgrade_http_routing_nam:16,upload:[0,26],upon:[2,16,20,26,29,112],upstream:[17,20,112],uri:[16,17,19,31],uri_sign:[17,31,57],urisign:57,urisignkei:57,url:[1,6,7,9,10,11,14,16,19,20,21,22,23,29,31,42,54,56,69,70,77,81,86,89,91,93,97,98,99,101,104,108,112,115,117],url_remap:17,url_sig:[17,31,57],url_sig_:17,url_sig_kei:23,urlencod:26,urlhash:17,urlkei:57,urlregex:7,usa:[31,57,77,86],usag:[16,17,19,20,21,26,29,54,92,99,113],uscsssfupsen:91,use:[5,11,13,14,16,17,19,20,21,22,31,56,57,73,77,86,90,91,93,97,98,99,103,104,108,111,112,115],use_in_t:[31,57,77,86],use_ip_address:17,use_reval_pend:[11,21],used:[6,7,11,14,16,17,20,21,22,31,32,39,42,51,54,56,57,66,77,81,84,86,95,97,99,100,101,102,103,108,111,112,113,115,116,117],useful:11,useg1gc:20,useint:[44,64,85],user23:77,user:[0,3,4,8,9,14,15,17,20,22,23,24,25,26,29,30,31,33,34,38,39,47,50,54,55,61,67,70,71,73,74,76,77,91,92,99,104,108,109,113,117],userid852:[30,55],userid853:[30,55],userid:[57,65,70],usernam:[9,10,14,19,20,21,23,45,65,70,77,86,117],userprofil:[45,86],uses:[1,7,9,11,14,16,17,20,22,23,42,81,91,99,101,106,108,111,112,113,115,117],using:[0,4,9,11,14,15,16,17,19,20,21,22,23,31,45,57,86,91,93,96,97,99,101,102,103,104,107,108,109,112,113,115,116],usr:[9,14,22],usual:[11,14,16,17,20,21,42,45,81,86,90,93,99,108,112],utc:[14,42,81,116],utf:[90,91,93],util:[20,23,99,101,103],utilizedperc:[29,31,54,57],v11:[31,57,77,86],v12:57,val:[32,66],valid:[6,7,17,20,23,49,59,69,71,77,90,95],valu:[1,6,7,8,9,11,16,17,19,20,22,23,26,29,31,32,34,39,45,49,50,54,57,59,66,69,71,73,74,77,80,86,97,98,99,101,112,113],value1:[71,74],value2:[71,74],variabl:[10,11,42,81,97,99,101],varieti:112,variou:[19,20,97,109],vast:[92,109],vault:[0,2,11,17,109,110],vcpu:[9,10,14,20],vda:69,verbatim:17,verbos:[13,95],veri:[17,20,111,115],verifi:[9,10,11,17,20,21,91,101],version:[1,9,10,11,12,14,15,16,17,20,21,22,23,26,29,31,39,43,45,52,54,57,61,69,71,73,74,77,83,86,90,97,99,103,104,112,115],vertic:20,vet:16,via:[4,8,9,10,11,14,16,17,20,22,51,91,97,99,101,117],video:[17,31,57,92,106,112],view:[0,7,11,19,21,22,53,93,99,104,112,113],viewabl:113,vim:[11,23],vip:[6,17],virtual:93,visibl:[4,11,19,34,42,50,71,81,97],visit:17,visual_status_panel_1:22,visual_status_panel_2:22,vital:108,vod:20,vpn:1,w90yhlgc_kylyw5_i0lrkpv9jozsinei:57,wai:[0,17,21,22,92,95,99,109,113],wait:[14,17,20,21,97],wait_for_par:21,walk:99,want:[12,13,14,17,20,22,23,29,54,57,99,112],war:101,warm:99,warn:[4,9,21,26,31,39,43,45,46,47,50,51,52,53,54,57,58,61,71,73,74,77,83,86,87,89,99],watch:[15,112],watcher:100,wbb:99,web:[4,11,17,21,97,100,101,111,113,114,115],webapp:101,webbrows:17,webserv:108,websit:[22,23],wed:4,weight:[8,17,20,80],welcom:103,well:[0,10,17,19,20,22,97,99,103,111,112,116],were:[14,16,17,23,29,31,52,54,57,62,63,65,74,91,97],west:[11,37,60,75,104],wget:[9,14,15,21],what:[11,17,19,20,21,22,30,55,90,107,109,115],whatev:[16,17],when:[0,1,2,3,4,6,7,9,11,14,17,19,20,21,22,23,26,29,31,34,42,45,50,54,57,71,73,74,77,81,86,90,91,97,108,112,113,115],whenev:20,where:[11,13,14,17,19,20,21,22,26,64,69,74,97,99,104,115],whether:[6,17,20,47,54,89,91,97,98],which:[0,1,2,7,10,11,12,14,16,17,20,21,22,23,29,31,39,41,42,44,45,50,51,54,57,58,77,79,81,84,85,86,89,91,93,97,99,101,103,104,111,112,113,115,116],white:[1,7,21],whitelist:[7,31,57],whitespac:14,who:[5,17,30,55,107,109],whole:17,whose:[7,51,112],why:[11,17,39,57,77],wiki:99,wikipedia:[91,108],wildcard:[20,57,98],window:[4,17,98],wish:[0,11],within:[6,12,17,20,21,99,101],withing:17,without:[1,7,11,17,19,20,93,97,104,112,115],wls:99,wnwnr1mcz1o4c7efptcqhd0xumqynfha:57,woburn:[27,28,47,50],won:14,word:[5,97,99],work:[0,1,2,7,13,16,17,22,23,45,86,96,97,99,100,101,103,108],world:20,would:[17,90,99],wrapper:97,writabl:15,write:[1,7,9,11,14,17,22,26,46,53,97,104,112],writt:17,written:[11,17,20,22,69,97,99,103,116],wrong:[17,20],wrote:17,wrs:99,www:[9,20,26,57,69,90,91,93,115],x509:11,x520:[39,77],x86_64:[9,14,21,95],xdebug:16,xml:[7,16,17,19,23,31,34,45,57,61,71,80,86,101],xml_id:[20,29,31,54,57,89,116],xmlid:[29,31,45,54,57,61,62,77,86],xmpp:[41,79],xmppid:[39,77],xmpppasswd:[39,77],xms2g:20,xmx2g:20,xpost:4,xput:[4,8,23],xxx:[45,86],xxxx:14,xxxyyi:8,xyz:[31,57,65],xzf:14,yes:[7,14,17,28,29,30,31,34,35,36,37,39,41,43,44,45,46,47,49,50,52,53,54,55,57,58,59,60,61,62,63,64,65,69,71,72,73,74,75,77,79,80,82,83,84,85,86,87,89],yesterdai:[29,54],yet:[4,17,19],yield:[20,115],yml:[14,95,99],you:[0,2,3,11,12,13,14,16,17,19,20,22,23,26,29,39,45,54,57,69,77,86,91,97,99,100,101,103,104,106,108,113],your:[2,3,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,26,29,31,54,57,82,99,100,101,103,104],yourcompani:1,yourcustomextens:99,yourself:[2,94],youvebeenblock:1,ys08:[39,77],ysxdp1t8iedee1ocmftzzb9eiw_20wwq:57,yum:[9,10,14,18,20,21,23],yyyyyyi:14,zbtmb3mrkqfs8hnx9_xwbip_opwlupzc:57,zcf:108,zero:20,zip:[35,72],zone:[0,2,29,54,57,101,102,104,108,109,115,117],zonemanag:17,zsk:[2,17,20,29,54],zskexpirationdai:[29,54],zvvqnyppvqwqv8tjqnul6osm4y7xk4zd:57,zxvf:15,zyonfdd7fgykj4klvij4u0918csuzo0d:57},titles:["Administrator\u2019s Guide","Configure Anonymous Blocking","Configure DNSSEC","Delivery Service Requests","Configure Federations","Quick How To Guides","Configure Multi Site Origin","Configure Regional Geo-blocking (RGB)","Configure Delivery Service Steering","Traffic Monitor Administration (Legacy)","Traffic Monitor Administration","Traffic Ops - Configuring","Traffic Ops - Default Profiles","Managing Traffic Ops Extensions","Traffic Ops - Installing","Traffic Ops - Migrating from 1.x to 2.x","Traffic Ops - Migrating from 2.0 to 2.2","Traffic Ops - Using","Traffic Portal Administration","Traffic Portal - Using","Traffic Router Administration","Traffic Server Administration","Traffic Stats Administration","Traffic Vault Administration","APIs","API Routes","API Overview","ASN","Cache Group","CDN","Change Logs","Delivery Service","Hardware Info","API 1.1 Reference","Parameter","Physical Location","Profiles","Regions","Roles","Server","Static DNS Entries","Status","System","TO Extensions","Types","Users","API-Capabilities","ASN","Cache","Cache Statistics","Cache Group","Cache Group Fallback","Cache Group parameters","Capabilities","CDN","Change Logs","Config Files and Config File Metadata","Delivery Service","Delivery Service Regexes","Delivery Service Statistics","Divisions","Federation","Federation Delivery Service","Federation Federation Resolver","Federation Resolver","Federation User","Hardware Info","API 1.2 Reference","InfluxDB","ISO","Jobs","Parameter","Physical Location","Profiles","Profile parameters","Regions","Roles","Server","Static DNS Entries","Status","Steering Targets","System","Tenants","TO Extensions","Snapshot CRConfig","Types","Users","Coordinate","API 1.3 Reference","Origin","Cache Control Headers and Revalidation","Caching Proxies","Content Delivery Networks","HTTP 1.1","CDN Basics","Building Traffic Control","Developer\u2019s Guide","Traffic Monitor Golang","Traffic Monitor APIs","Traffic Ops","Traffic Portal","Traffic Router","Traffic Router API","Traffic Stats","Running a Traffic Control CDN","Development","General","FAQ","Glossary","Traffic Control","Traffic Control Overview","Introduction","Traffic Monitor","Traffic Ops","Traffic Portal","Traffic Router","Traffic Stats","Traffic Vault"],titleterms:{"case":[97,99,101,103],"default":12,"import":12,"static":[17,40,78],DNS:[17,20,40,78,115],Ops:[5,11,12,13,14,15,16,17,23,97,99,113],The:[17,97,99,100,101,103],Using:[17,19,26],admin:[19,23],administr:[0,9,10,18,20,21,22,23,109],aggreg:97,alwai:20,anonym:1,apach:16,api:[24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,59,60,61,62,63,64,65,66,67,70,71,72,73,74,75,76,77,78,79,81,82,83,84,85,86,87,88,89,97,98,101,102,109],api_cap:46,applic:11,architectur:97,arrow:[91,112,113,115],asn:[17,19,27,47],assign:[3,17],ats:56,authent:17,author:11,avail:97,base:17,basic:[94,109],becom:105,block:[1,7],build:95,bulk:17,cach:[11,19,20,28,48,49,50,51,52,90,91,104,112],cache_stat:49,cachegroup:[28,50],cachegroup_fallback:51,cachegroupparamet:52,cachekei:16,cacheurl:16,can:[3,105],capabl:[46,53],ccr:106,cdn:[19,29,54,56,94,99,104,109],cdn_name:[56,84],cento:11,cert:11,certif:[11,20],chain:20,chang:[30,55],check:[17,19,99],client:26,combin:97,complet:3,compos:95,config:[56,97],configfil:56,configur:[1,2,4,6,7,8,9,10,11,19,20,21,22,23,99],content:[3,11,17,19,20,92,115],control:[90,95,104,106,109,110],convent:[97,99,101,103],coordin:87,coverag:[17,20],crconfig:[17,84,104],creat:[3,11],cron:13,custom:19,daili:17,dashboard:19,data:[97,99],databas:[15,99],deep:[17,20],delet:3,deliveri:[3,8,11,17,19,20,31,57,58,59,62,92,115],deliveryservic:[16,31,57,62],deliveryservice_stat:59,develop:[11,96,97,99,100,101,103,105,109],directori:[15,99],divis:[19,60],dnssec:[2,17,20,29,54],docker:95,domain:[29,54],dscp:17,endpoint:26,entri:[17,40,78],environ:[97,99,100,101,103],error:26,event:[20,97],exampl:[13,16,95,99],express:17,extens:[13,43,83,99,113],failur:20,fallback:51,faq:[107,109],featur:20,feder:[4,17,61,62,63,64,65],federation_resolv:[63,64],field:20,file:[9,10,11,13,17,20,23,56],format:[20,97,99,101,103],forward:91,from:[11,15,16],fulfil:3,gener:[17,19,106],geo:7,geolimit:20,get:[20,106],glossari:108,golang:97,graph:17,group:[11,19,28,50,51,52,104],guid:[0,5,96,109],handl:17,hardwar:[32,66],header:[17,90],health:[17,29,31,54,57,97,112],help:106,hostnam:56,how:[3,5,20,105,106],http:[20,93,97,115],hwinfo:[32,66],indic:109,influxdb:[22,68],info:[32,66],instal:[9,10,11,14,20,21,22,23,97,99,100,101,103],introduct:[97,99,100,101,103,111],invalid:[17,19],involv:105,iso:[17,19,69],item:19,java:101,job:70,json:104,kabletown:99,kei:[17,20,29,31,54,57],kickstart:11,legaci:9,librari:26,licens:106,local:115,locat:[11,19,35,72],log:[9,10,16,20,30,55],manag:[13,17,99],manual:101,menu:[17,19],messag:20,metadata:56,metric:[29,31,54],migrat:[15,16],minimum:12,monitor:[9,10,19,97,98,112],monkei:106,multi:[6,17],name:[16,99],nativ:26,navig:[14,15],need:12,network:[11,92],note:100,oper:20,option:[17,20],order:20,origin:[6,17,89],ort:21,other:19,overview:[9,10,20,26,97,99,100,101,103,109,110],packag:[99,101],paramet:[11,17,19,34,52,71,74],parent:17,peer:97,per:16,perl:99,phy:19,phys_loc:[35,72],physic:[35,72],pipelin:97,pkg:95,plugin:16,portal:[5,18,19,100,114],prepar:15,present:20,product:11,profil:[11,12,17,19,36,56,73,74,104],profile_nam:56,profileparamet:74,project:[97,99,100,101,103],protocol:[20,112],proxi:91,purg:11,qstring:17,queue:17,quick:5,rascal:106,recommend:20,redirect:20,refer:[33,67,88],regex:[17,58],regexp:17,region:[7,11,19,37,75],reject:[3,104],releas:106,remap:17,replac:16,request:[3,19,97],requir:[14,15,95,97,99,100,101,103],resolv:[63,64],respons:26,retriev:20,revalid:90,revers:91,rewrit:17,rgb:7,riak:23,role:[19,38,76],roll:20,rout:[16,25,29,54,115],router:[17,20,101,102,115],rpm:101,run:104,runtim:99,sampl:20,script:21,search:23,select:17,self:11,server:[16,17,19,21,31,39,56,57,77],servic:[3,8,17,19,20,31,57,58,59,62,115],set:20,setup:15,share:97,sig:[17,57],sign:[11,20,57],site:[6,17],snapshot:[17,84],softwar:[97,99,100,101,103],sourc:99,specif:20,ssl:[11,31,54,57],start:20,stat:[19,22,48,97,103,116],state:97,staticdnsentri:[40,78],statist:[49,59],statu:[41,79],status:[19,41,79],steer:[8,20,80],step:12,structur:26,suggest:20,summari:[17,20],system:[14,15,42,81],tabl:[17,109],target:80,tenant:[19,82],test:[97,99,101,103],to_extens:[43,83],token:17,tool:[17,19,22],topolog:[19,20,29,54],traffic:[5,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,95,97,98,99,100,101,102,103,104,106,109,110,112,113,114,115,116,117],traffic_ops_db:15,trafficop:26,trafficopsrout:99,transpar:91,tree:[97,99,100,101,103],troubleshoot:[9,10,20],tune:20,twelv:106,type:[17,19,20,44,85],unassign:3,under:106,updat:[3,17],upgrad:14,upload:17,uri:57,url:[17,57],usag:95,user:[19,45,57,65,86],using:[95,106],vault:[23,117],view:17,wai:20,what:106,who:[3,106],why:104,work:20,zone:[17,20]}})
\ No newline at end of file
