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

Examples

GET /api/compute_attributes
200
{
  "total": 5,
  "subtotal": 5,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2021-05-18 15:46:21 UTC",
      "updated_at": "2021-05-18 15:46:21 UTC",
      "id": 980190962,
      "name": null,
      "compute_resource_id": 928692541,
      "compute_resource_name": "amazon123",
      "provider_friendly_name": "EC2",
      "compute_profile_id": 980190962,
      "compute_profile_name": "1-Small",
      "vm_attrs": {
        "flavor_id": "m1.small",
        "availability_zone": "eu-west-1a"
      },
      "attributes": {
        "flavor_id": "m1.small",
        "availability_zone": "eu-west-1a",
        "subnet_id": null,
        "image_id": null,
        "managed_ip": null,
        "flavor_name": "M1 Small Instance",
        "subnet_name": null,
        "image_name": null,
        "security_groups": {}
      }
    },
    {
      "created_at": "2021-05-18 15:46:21 UTC",
      "updated_at": "2021-05-18 15:46:21 UTC",
      "id": 298486374,
      "name": null,
      "compute_resource_id": 980190962,
      "compute_resource_name": "bigcompute",
      "provider_friendly_name": "Libvirt",
      "compute_profile_id": 980190962,
      "compute_profile_name": "1-Small",
      "vm_attrs": {
        "cpus": 2,
        "memory": 536870912
      },
      "attributes": {
        "cpus": 2,
        "memory": 536870912,
        "image_id": null,
        "image_name": null,
        "volumes_attributes": {},
        "interfaces_attributes": {}
      }
    },
    {
      "created_at": "2021-05-18 15:46:21 UTC",
      "updated_at": "2021-05-18 15:46:21 UTC",
      "id": 113629430,
      "name": null,
      "compute_resource_id": 928692541,
      "compute_resource_name": "amazon123",
      "provider_friendly_name": "EC2",
      "compute_profile_id": 298486374,
      "compute_profile_name": "2-Medium",
      "vm_attrs": {
        "flavor_id": "m1.medium",
        "availability_zone": "eu-west-1a"
      },
      "attributes": {
        "flavor_id": "m1.medium",
        "availability_zone": "eu-west-1a",
        "subnet_id": null,
        "image_id": null,
        "managed_ip": null,
        "flavor_name": "M1 Medium Instance",
        "subnet_name": null,
        "image_name": null,
        "security_groups": {}
      }
    },
    {
      "created_at": "2021-05-18 15:46:21 UTC",
      "updated_at": "2021-05-18 15:46:21 UTC",
      "id": 281110143,
      "name": null,
      "compute_resource_id": 980190962,
      "compute_resource_name": "bigcompute",
      "provider_friendly_name": "Libvirt",
      "compute_profile_id": 298486374,
      "compute_profile_name": "2-Medium",
      "vm_attrs": {
        "cpus": 4,
        "memory": 4294967296
      },
      "attributes": {
        "cpus": 4,
        "memory": 4294967296,
        "image_id": null,
        "image_name": null,
        "volumes_attributes": {},
        "interfaces_attributes": {}
      }
    },
    {
      "created_at": "2021-05-18 15:46:21 UTC",
      "updated_at": "2021-05-18 15:46:21 UTC",
      "id": 394428105,
      "name": null,
      "compute_resource_id": 980190962,
      "compute_resource_name": "bigcompute",
      "provider_friendly_name": "Libvirt",
      "compute_profile_id": 281110143,
      "compute_profile_name": "4-Networking",
      "vm_attrs": {
        "nics_attributes": {
          "1": {
            "attr": 1
          },
          "2": {
            "attr": 2
          }
        }
      },
      "attributes": {
        "cpus": null,
        "memory": null,
        "image_id": null,
        "image_name": null,
        "volumes_attributes": {},
        "interfaces_attributes": {
          "1": {
            "type": null,
            "model": null,
            "bridge": null
          },
          "2": {
            "type": null,
            "model": null,
            "bridge": null
          }
        }
      }
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
compute_profile_id
optional

ID of compute profile

Validations:

  • Must be a String
compute_resource_id
optional

ID of compute_resource

Validations:

  • Must be a String
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a 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