Examples

GET /api/compute_profiles
200
{
  "total": 4,
  "subtotal": 4,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2019-09-11 14:32:44 UTC",
      "updated_at": "2019-09-11 14:32:44 UTC",
      "id": 980190962,
      "name": "1-Small"
    },
    {
      "created_at": "2019-09-11 14:32:44 UTC",
      "updated_at": "2019-09-11 14:32:44 UTC",
      "id": 298486374,
      "name": "2-Medium"
    },
    {
      "created_at": "2019-09-11 14:32:44 UTC",
      "updated_at": "2019-09-11 14:32:44 UTC",
      "id": 113629430,
      "name": "3-Large"
    },
    {
      "created_at": "2019-09-11 14:32:44 UTC",
      "updated_at": "2019-09-11 14:32:44 UTC",
      "id": 281110143,
      "name": "4-Networking"
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organisations

Validations:

  • Must be a Integer

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

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
name string