logo

Control

This document describes the API for reading Controls.

List Controls

Returns a list of Controls.

Search parameters

Filter Description
author_name The author name of the Control
description The description of the Control
key The key of the Control
name The name of the Control
created_at The date when this Control was created
custom True if Control is custom, False if authored by Secureframe
enabled Flag to indicate if this Control is enabled
first_failed_at When the Control first failed
health_status The health status of the Control
id The ID of the Control
implementation_date The implementation date of the Control
owner_assigned_at When the owner was assigned to the Control
owner_name The Control owner's name
updated_at The date the Control was last updated
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: 1000 items per response). Specifies the number of results for a given page.

q
string

Search and filter the control 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/controls
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get a Control
Returns a Control 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/controls/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "includes": { }
}
➔ Next to Device