| .. |
| .. |
| .. 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-plugins: |
| |
| *********** |
| ``plugins`` |
| *********** |
| .. seealso:: :ref:`to_go_plugins` |
| |
| ``GET`` |
| ======= |
| Retrieves the list of configured enabled Traffic Ops plugins. |
| |
| :Auth. Required: Yes |
| :Roles Required: None |
| :Permissions Required: PLUGIN:READ |
| :Response Type: Array |
| |
| Request Structure |
| ----------------- |
| .. code-block:: http |
| :caption: Request Example |
| |
| GET /api/5.0/plugins HTTP/1.1 |
| Host: trafficops.infra.ciab.test |
| User-Agent: curl/7.47.0 |
| Accept: */* |
| Cookie: mojolicious=... |
| |
| Response Structure |
| ------------------ |
| :description: A short description of the plugin. |
| :name: The name of the plugin. |
| :version: A (hopefully) semantic version number describing the version of the plugin. |
| |
| .. code-block:: http |
| :caption: Response Example |
| |
| HTTP/1.1 200 OK |
| Access-Control-Allow-Credentials: true |
| Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept |
| Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE |
| Access-Control-Allow-Origin: * |
| Cache-Control: no-cache, no-store, max-age=0, must-revalidate |
| Content-Type: application/json |
| Date: Tue, 11 Dec 2018 20:51:48 GMT |
| X-Server-Name: traffic_ops_golang/ |
| Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly |
| Vary: Accept-Encoding |
| Whole-Content-Sha512: n73jg9XR4V5Cwqq56Rf3wuIi99k3mM5u2NAjcZ/gQBu8jvAFymDlnZqKeJ+wTll1vjIsHpXCOVXV7+5UGakLgA== |
| Transfer-Encoding: chunked |
| |
| { "response": [ |
| { |
| "name": "helloworld", |
| "version": "1.0.0", |
| "description": "configuration plugin to run at startup" |
| } |
| ]} |