GET /api/compliance/tailoring_files
List Tailoring files

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

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
created_at datetime
filename string
location string
location_id integer
name string
organization string
organization_id integer

GET /api/compliance/tailoring_files/:id/xml
Download a Tailoring file as XML

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

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.


GET /api/compliance/tailoring_files/:id
Show a Tailoring file

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

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/compliance/tailoring_files
Create a Tailoring file

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

tailoring_file
required

Validations:

  • Must be a Hash

tailoring_file[name]
required

Tailoring file name

Validations:

  • Must be a String

tailoring_file[scap_file]
required

XML containing tailoring file

Validations:

  • Must be a String

tailoring_file[original_filename]
optional , nil allowed

Original file name of the XML file

Validations:

  • Must be a String

tailoring_file[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

tailoring_file[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


PUT /api/compliance/tailoring_files/:id
Update a Tailoring file

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

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.

tailoring_file
required

Validations:

  • Must be a Hash

tailoring_file[name]
optional

Tailoring file name

Validations:

  • Must be a String

tailoring_file[scap_file]
optional

XML containing tailoring file

Validations:

  • Must be a String

tailoring_file[original_filename]
optional , nil allowed

Original file name of the XML file

Validations:

  • Must be a String

tailoring_file[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

tailoring_file[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


DELETE /api/compliance/tailoring_files/:id
Deletes a Tailoring file

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

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.