Parameter

/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"
    }
}