logo

Test

This document describes the API for reading and updating Tests.

List Tests

Returns a list of Tests.

Search parameters

Filter Description
author_name The author name of the Test
created_at The date when this Test was created
custom True if the Test is custom (user generated), false if it's Secureframe-authored
description The description of the Test
enabled True if the Test is currently enabled
enabled_field_updated_by_user The name of the user who enabled the Test, null if wasn't enabled by a user
frameworks The framework keys for this Test
health_status The overall health of the Test
id The ID of the Test
key The user-friendly identifier used to reference this Test
last_evaluated The date the Test was last evaulated at
next_due_date The date new Test evidence is needed by if applicable
owner_assigned_at The date the Test owner was assigned
owner_name The Test owner's name
pass True if the Test is passing, false otherwise. [DEPRECATED - Use health_status instead]
passed_with_upload True if the Test passed from the existance of an upload, false otherwise
promote_at The current date set for implementation of the Test
recommended_action Actions for completing the Test
required_implementation_date The pre-configured date the Test must be implemented by
resource_category The category the Test resource belongs to
status The status of the Test. [DEPRECATED - Use health_status instead]
test_domain The domain the Test belongs to
test_function The purpose of the Test
test_interval_seconds The interval in which Test evidence should be collected if applicable
test_type The type of Test
title The title of the Test
tolerance_window_seconds The time between the Test interval elapsing and evidence becoming stale and Test failing if applicable
updated_at The date the Test was last updated
vendor_name The vendor name associated with the Test if applicable
Securityheader_authorization
Request
query Parameters
include
boolean

Set to true along with relationships to return the entire relationship data in the included key within the response.

page
integer

Used for pagination of response data (default: page 1). Specifies the offset of the next block of data to receive.

per_page
integer

Used for pagination of response data (default: 100 items per response). Specifies the number of results for a given page.

q
string

Search and filter the Test data using Lucene syntax.

relationships
boolean

Set to true to return the associated relationships data within the response. (default: false)

Responses
400

Bad Request

401

Unauthorized

403

Forbidden

default
get/tests
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get a Test
Returns a Test by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
get/tests/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
Update a Test
Update a Test by ID


Securityheader_authorization 
Request 
path Parameters
id
required
string
Scope response to id


 
query Parameters
disabled_justification
string
The justification reason for why this test is disabled.


 
enabled
boolean
true or false for whether this test should be enabled or disabled.


 
next_due_date
string <date-time> 
Date time in ISO8601 format.


 
owner_id
string <uuid> 
The UUID of a user.


 
passed_with_upload_justification
string
The justification reason for why this test is passed with upload.


 
promote_at
string <date-time> 
Date time in ISO8601 format.


 
test_interval_seconds
string
How often the test should be run.


 Enum: "one_day" "one_week" "two_weeks" "one_month" "three_months" "six_months" "one_year" "none"  
tolerance_window_seconds
string
The tolerance window representation for a test to be at risk.


 Enum: "one_day" "one_week" "two_weeks" "one_month" "three_months" "six_months" "one_year" "none"  
Responses 
400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource not found


default
put/tests/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
➔ Next to Test Evidence