• Custom Attributes
  • Querying Custom Attributes
  • Specifying Attribute Actions
  • Custom Attribute Actions
  • Adding Custom Attributes
  • Editing Custom Attributes
  • Deleting Custom Attributes

Custom Attributes

Custom Attributes can be managed for several types of resources. This is done via the custom_attributes sub-collection as follows:

• Querying Custom Attributes

• Specifying Custom Attributes

• Custom Attribute Actions

• Adding Custom Attributes

• Editing Custom Attributes

• Deleting Custom Attributes

Querying Custom Attributes

Custom attributes of a resource can be asked for by expanding the subcollection as follows:

GET /api/vms/:id?expand=custom_attributes
GET /api/instances/:id?expand=custom_attributes
GET /api/providers/:id?expand=custom_attributes
GET /api/services/:id?expand=custom_attributes

Optionally, just the custom attributes of a resource can be queried:

GET /api/vms/:id/custom_attributes
GET /api/instances/:id/custom_attributes
GET /api/providers/:id/custom_attributes
GET /api/services/:id/custom_attributes

Specifying Attribute Actions

Custom attributes are specified as follows:

{
  "name" : "...",
  "value" : "...",
  "field_type" : "...",
  "source" : "...",
  "section" : "...",
}

For adding custom attributes, name field is required.

field_type, source and section are optional.

There is no default value for field_type. Allowed values for field_type are DateTime, Date and Time.

Default value for source is EVM. If source is set to VC, the custom attribute field will be updated on the provider.

Default value for section is metadata. Allowed values for section include metadata and cluster_settings.

For editing a custom attribute, specify the custom attribute either by name:

{
  "name" : "...",
  "value" : "..."
}

Or by href:

{
  "href" : "http://localhost:3000/api/vms/:id/custom_attributes/:id",
  "value" : "..."
}

Custom Attribute Actions

Adding Custom Attributes

Adding custom attributes to a Resource:

POST /api/vms/:id/custom_attributes
POST /api/instances/:id/custom_attributes
POST /api/providers/:id/custom_attributes
POST /api/services/:id/custom_attributes

{
  "action" : "add",
  "resources" : [
    { ... },
    { ... },
    ...
  ]
}

For example, adding two custom attributes:

{
  "action" : "add",
  "resources" : [
    { "name" : "ca1", "value" : "value 1" },
    { "name" : "ca2", "value" : "value 2" }
  ]
}

Editing Custom Attributes

Editing custom attributes of a Resource:

POST /api/vms/:id/custom_attributes
POST /api/instances/:id/custom_attributes
POST /api/providers/:id/custom_attributes
POST /api/services/:id/custom_attributes

{
  "action" : "edit",
  "resources" : [
    { ... },
    { ... },
    ...
  ]
}

For example:

{
  "action" : "edit",
  "resources" : [
    { "name" : "ca_name1", "value" : "updated custom attribute value 1" },
    { "name" : "ca_name2", "value" : "updated custom attribute value 2" }
  ]
}

Deleting Custom Attributes

Deleting custom attributes of a Resource:

POST /api/vms/:id/custom_attributes
POST /api/instances/:id/custom_attributes
POST /api/providers/:id/custom_attributes
POST /api/services/:id/custom_attributes

{
  "action" : "delete",
  "resources" : [
    { ... },
    { ... },
    ...
  ]
}

In the following example, a request to delete custom attributes of a VM by name and by href:

{
  "action" : "delete",
  "resources" : [
    { "name" : "ca_name1" },
    { "href" : "http://localhost:3000/api/vms/:id/custom_attributes/:id" }
  ]
}

Custom attributes can be deleted via a delete action as follows:

POST /api/vms/:id/custom_attributes/:ca_id
POST /api/instances/:id/custom_attributes/:ca_id
POST /api/providers/:id/custom_attributes/:ca_id
POST /api/services/:id/custom_attributes/:ca_id

{
  "action" : "delete"
}

They can also be deleted via the DELETE method:

DELETE /api/vms/:id/custom_attributes/:ca_id
DELETE /api/instances/:id/custom_attributes/:ca_id
DELETE /api/providers/:id/custom_attributes/:ca_id
DELETE /api/services/:id/custom_attributes/:ca_id