/config/var/{section}/{var}

The value of the named meter variable. Complex values can be stored, e.g., by JSON-encoding them.

Get /config/var/{section}/{var}

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

The name of the section to access.

Example: global
var
required
string^[a-zA-Z0-9_%.-]+$

The name of a variable.

Example: billing.start_day
Responses
200

Normal response.

401

Unauthorized response.

get/config/var/{section}/{var}
Request samples
Response samples
application/json
{
  • "result": "6",
  • "error": "Error message (present if an error occurred)."
}

Replace /config/var/{section}/{var}

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

The name of the section to access.

Example: global
var
required
string^[a-zA-Z0-9_%.-]+$

The name of a variable.

Example: billing.start_day
Request Body schema: application/json
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}/{var}
Request samples
application/json
"6"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/var/{section}/{var}

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

The name of the section to access.

Example: global
var
required
string^[a-zA-Z0-9_%.-]+$

The name of a variable.

Example: billing.start_day
Request Body schema: application/json
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}/{var}
Request samples
application/json
"6"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/var/{section}/{var}

Delete the named meter variable.

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

The name of the section to access.

Example: global
var
required
string^[a-zA-Z0-9_%.-]+$

The name of a variable.

Example: billing.start_day
Responses
200

Normal response.

401

Unauthorized response.

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