Compute attributes

>>>

GET /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes
List of compute attributes for provided compute profile and compute resource

GET /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes
List of compute attributes for provided compute profile and compute resource

GET /api/compute_resources/:compute_resource_id/compute_attributes
List of compute attributes for compute resource

GET /api/compute_profiles/:compute_profile_id/compute_attributes
List of compute attributes for compute profile

GET /api/compute_attributes/:id
List of compute attributes

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
compute_profile_id
optional

ID of compute profile

Validations:

  • String
compute_resource_id
optional

ID of compute_resource

Validations:

  • String
search
optional

filter results

Validations:

  • String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
compute_profile string
compute_resource string
name string
>>>

GET /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id
Show a compute attributes set

GET /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id
Show a compute attributes set

GET /api/compute_resources/:compute_resource_id/compute_attributes/:id
Show a compute attributes set

GET /api/compute_profiles/:compute_profile_id/compute_attributes/:id
Show a compute attributes set

GET /api/compute_attributes/:id
Show a compute attributes set

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
>>>

POST /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes
Create a compute attributes set

POST /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes
Create a compute attributes set

POST /api/compute_resources/:compute_resource_id/compute_attributes
Create a compute attributes set

POST /api/compute_profiles/:compute_profile_id/compute_attributes
Create a compute attributes set

POST /api/compute_attributes
Create a compute attributes set

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
compute_profile_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
compute_resource_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
compute_attribute
required

Validations:

  • Hash
compute_attribute[vm_attrs]
required

Validations:

  • Hash
>>>

PUT /api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id
Update a compute attributes set

PUT /api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id
Update a compute attributes set

PUT /api/compute_resources/:compute_resource_id/compute_attributes/:id
Update a compute attributes set

PUT /api/compute_profiles/:compute_profile_id/compute_attributes/:id
Update a compute attributes set

PUT /api/compute_attributes/:id
Update a compute attributes set

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
compute_profile_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
compute_resource_id
optional

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
id
required

Validations:

  • String
compute_attribute
required

Validations:

  • Hash
compute_attribute[vm_attrs]
optional

Validations:

  • Hash