Parameters

A parameter describes a variable impacting a platform, a distribution, or an application. This description includes the schema of the variable i.e. a description of acceptable values.

Representation

The following elements are defined as part of a parameter:

• name: The name of the parameter.
• description: A human friendly description of the parameter.
• version: A version number managed by the system. This value is read-only and is incremented on each changes to the resource.
• key: The name of a variable.
• schema: The schema of the variable.
• value: A default value; it may be used if target variable’s value has not been set by a setting.

Example

{
    "name": "Httpd Port", 
    "description": "The httpd port",
    "version": 1,
    "key": "httpd_port", 
    "schema": {
        "type": "string"
    }, 
    "value": "80"
}

Methods

Parameters are part of a sub-collection, below URLs are therefore relative.

Collection

parameters

• GET: returns the list of parameters.
• POST: adds a new parameter.

Entity

parameters/{param_name}

• GET: returns the parameter.
• PUT: updates the parameter.
• DELETE: removes the parameter.