Powered by Redocly

/config/var/{section}

The meter variables in the named section.

Get /config/var/{section}

SecurityApiKey
Request
path Parameters
section
required
string^[a-zA-Z0-9_%-]+$

The name of the section to access.

Example: global
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/var/{section}
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/var/{section}
SecurityApiKey 
Request 
path Parameters
section
required
string^[a-zA-Z0-9_%-]+$
The name of the section to access.


 
 Example:  global
Request Body schema: application/json
var*
additional property
string (configVarSectionVar) 
The value of the named meter variable.  Complex values can be
stored, e.g., by JSON-encoding them.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/var/{section}
Request samples 
application/json
{
  • "billing.start_day": "6",
  • "billing.interval": "15"
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/var/{section}
SecurityApiKey 
Request 
path Parameters
section
required
string^[a-zA-Z0-9_%-]+$
The name of the section to access.


 
 Example:  global
Request Body schema: application/json
var*
additional property
string (configVarSectionVar) 
The value of the named meter variable.  Complex values can be
stored, e.g., by JSON-encoding them.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/var/{section}
Request samples 
application/json
{
  • "billing.start_day": "6",
  • "billing.interval": "15"
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/var/{section}
Delete all meter variables in the named section.


SecurityApiKey 
Request 
path Parameters
section
required
string^[a-zA-Z0-9_%-]+$
The name of the section to access.


 
 Example:  global
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/var/{section}
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/var/{section}/{var}