Properties
NAME | TYPE | DESCRIPTION |
key | string | Attribute Key. |
type | string | Attribute type. |
status | string | Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` |
error | string | Error message. Displays error generated on failure of creating or deleting an attribute. |
required | boolean | Is attribute required? |
array | boolean | Is attribute an array? |
format | string | String format. |
default | string | Default value for attribute when not provided. Cannot be set when attribute is required. |
Example
JSON
{
"key": "ipAddress",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"format": "ip",
"default": "192.0.2.0"
}
JSON
{
"key": "ipAddress",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"format": "ip",
"default": "192.0.2.0"
}