Configuration APIMeter Properties

Create a meter property

Requires the METER_PROPERTY.CREATE permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Request

This endpoint expects an object.
referencestringRequiredformat: "^\S+$"0-256 characters
statusenumRequired
The status of the meter property indicating the activity and the ability to update properties.
Allowed values:
namestring or nullOptionalformat: "^.*$"0-256 characters
descriptionstring or nullOptionalformat: "^.*$"0-256 characters
typeenum or nullOptional
The type of the meter property.
Allowed values:
enum_valueslist of strings or nullOptional
The list of available ENUM values.

Response

Created
referencestringformat: "^\S+$"0-256 characters
statusenum
The status of the meter property indicating the activity and the ability to update properties.
Allowed values:
object_typestring or nullRead-only
idstring or nullRead-only
namestring or nullformat: "^.*$"0-256 characters
descriptionstring or nullformat: "^.*$"0-256 characters
typeenum or null
The type of the meter property.
Allowed values:
enum_valueslist of strings or null
The list of available ENUM values.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error