| .. |
| .. Copyright 2015 Comcast Cable Communications Management, LLC |
| .. |
| .. 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.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 | |
| +------------------+--------+----------------------------------------------------+ |
| | ``value`` | string | The parameter value | |
| +------------------+--------+----------------------------------------------------+ |
| | ``name`` | string | The parameter name | |
| +------------------+--------+----------------------------------------------------+ |
| | ``config_file`` | string | The parameter config_file | |
| +------------------+--------+----------------------------------------------------+ |
| |
| **Response Example** :: |
| |
| { |
| "response": [ |
| { |
| "last_updated": "2012-09-17 21:41:22", |
| "value": "foo.bar.net", |
| "name": "domain_name", |
| "config_file": "FooConfig.xml" |
| }, |
| { |
| "last_updated": "2012-09-17 21:41:22", |
| "value": "0,1,2,3,4,5,6", |
| "name": "Drive_Letters", |
| "config_file": "storage.config" |
| }, |
| { |
| "last_updated": "2012-09-17 21:41:22", |
| "value": "STRING __HOSTNAME__", |
| "name": "CONFIG proxy.config.proxy_name", |
| "config_file": "records.config" |
| } |
| ], |
| } |
| |
| | |
| |
| **GET /api/1.2/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 | |
| +------------------+--------+----------------------------------------------------+ |
| | ``value`` | string | The parameter value | |
| +------------------+--------+----------------------------------------------------+ |
| | ``name`` | string | The parameter name | |
| +------------------+--------+----------------------------------------------------+ |
| | ``config_file`` | string | The parameter config_file | |
| +------------------+--------+----------------------------------------------------+ |
| |
| **Response Example** :: |
| |
| { |
| "response": [ |
| { |
| "last_updated": "2012-09-17 21:41:22", |
| "value": "foo.bar.net", |
| "name": "domain_name", |
| "config_file": "FooConfig.xml" |
| }, |
| { |
| "last_updated": "2012-09-17 21:41:22", |
| "value": "0,1,2,3,4,5,6", |
| "name": "Drive_Letters", |
| "config_file": "storage.config" |
| }, |
| { |
| "last_updated": "2012-09-17 21:41:22", |
| "value": "STRING __HOSTNAME__", |
| "name": "CONFIG proxy.config.proxy_name", |
| "config_file": "records.config" |
| } |
| ], |
| } |
| |
| | |