GET /api/foreman_datacenter/sites
List all sites

Params

Param name Description
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
asn
comments
created_at
facility
name
physical_address
shipping_address
updated_at

GET /api/foreman_datacenter/sites/:id
Show a site

Params

Param name Description
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/foreman_datacemter/sites
Create a site

Params

Param name Description
site
required

Validations:

  • Must be a Hash

site[name]
required

Validations:

  • Must be a String

site[rack_ids]
optional , nil allowed

Rack IDs

Validations:

  • Must be an array of any type

site[rack_group_ids]
optional , nil allowed

RackGroup IDs

Validations:

  • Must be an array of any type


PUT /api/foreman_datacenter/sites/:id
Update a site

Params

Param name Description
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.

site
required

Validations:

  • Must be a Hash

site[name]
optional

Validations:

  • Must be a String

site[rack_ids]
optional , nil allowed

Rack IDs

Validations:

  • Must be an array of any type

site[rack_group_ids]
optional , nil allowed

RackGroup IDs

Validations:

  • Must be an array of any type


DELETE /api/foreman_datacenter/sites/:id
Delete a site

Params

Param name Description
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.