Architectures

>>>

GET /api/architectures
List all architectures

GET /api/operatingsystems/:operatingsystem_id/architectures
List all architectures for operating system

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
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$/.
operatingsystem_id
optional

ID of operating system

Validations:

  • Must be a String

Search fields

Field name Type Possible values
name
>>>

GET /api/architectures/:id
Show an architecture

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
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /api/architectures
Create an architecture

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
architecture
required

Validations:

  • Must be a Hash
architecture[name]
required

Validations:

  • Must be a String
architecture[operatingsystem_ids]
optional , nil allowed

Operating system IDs

Validations:

  • Must be an array of any type
>>>

PUT /api/architectures/:id
Update an architecture

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
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
architecture
required

Validations:

  • Must be a Hash
architecture[name]
optional

Validations:

  • Must be a String
architecture[operatingsystem_ids]
optional , nil allowed

Operating system IDs

Validations:

  • Must be an array of any type
>>>

DELETE /api/architectures/:id
Delete an architecture

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
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.