Skip to content

Get control

GET
/api/v1/organizations/{orgId}/policies/{policyId}/controls/{controlId}
curl --request GET \
--url https://localhost:10001/api/v1/organizations/1/policies/1/controls/1 \
--header 'Authorization: <Authorization>'

Retrieve a specific control by ID

orgId
required
integer

Organization ID

policyId
required
integer

Policy ID

controlId
required
integer

Control ID

Control

Media type application/json
object
citations
Array<object>
object
title
string
url
string
controlCode
string
createdAt
string
description
string
id
integer
policyId
integer
title
string
updatedAt
string
Example generated
{
"citations": [
{
"title": "example",
"url": "example"
}
],
"controlCode": "example",
"createdAt": "example",
"description": "example",
"id": 1,
"policyId": 1,
"title": "example",
"updatedAt": "example"
}

Bad request - Invalid control ID

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Unauthorized - Authentication required

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Forbidden - No organization access

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Control not found

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Internal server error

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}