ocket8888 commented on a change in pull request #4444: Document undocumented Traffic Ops routes URL: https://github.com/apache/trafficcontrol/pull/4444#discussion_r384065529
########## File path: docs/source/api/v2/servers_details.rst ########## @@ -0,0 +1,117 @@ +.. +.. +.. 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-servers-details: + +******************* +``servers/details`` +******************* +Retrieves details of :ref:`tp-configure-servers`. + + +``GET`` +======= +:Auth. Required: Yes +:Roles Required: "read-only" +:Response Type: Array + +Request Structure +----------------- +.. table:: Request Query Parameters + + +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Required | Description | + +================+========================================+================================================================================================================================================================+ + | hostName | Required if no physLocationID provided | Return only the servers with this (short) hostname. Capitalization of "hostName" is important. | + +----------------+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | physLocationID | Required if no hostName provided | Return only servers with this integral, unique identifier for the physical location where the server resides. Capitalization of "physLocationID" is important. | Review comment: How would you capitalize an id? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
