GET /api/foreman_datacenter/platforms
List all platforms

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
created_at
name
rpc_client
updated_at

GET /api/foreman_datacenter/platforms/:id
Show a platform

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_datacenter/platforms
Create a platform

Params

Param name Description
platform
required

Validations:

  • Must be a Hash

platform[name]
required

Validations:

  • Must be a String

platform[rpc_client]
optional , nil allowed

RPC Client

Validations:

  • Must be a number.


PUT /api/foreman_datacenter/platforms/:id
Update a platform

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.

platform
required

Validations:

  • Must be a Hash

platform[name]
optional

Validations:

  • Must be a String

platform[rpc_client]
optional , nil allowed

RPC Client

Validations:

  • Must be a number.


DELETE /api/foreman_datacenter/platforms/:id
Delete a platform

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.