Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

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: 
          
         '

Retrieve a specific control by ID

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
orgId
required
integer

Organization ID

policyId
required
integer

Policy ID

controlId
required
integer

Control ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Control

Media type application/json
object
citations
Array
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
                   "
                  

                 

                 

                  

                   }

400

Section titled “400 ”

Bad request - Invalid control ID

Media type application/json
object
key
additional properties
string
Example generated

                     

                      

                       {
                      

                     

                     

                      

                        
                       "additionalProperty"
                       : 
                       "
                       example
                       "
                      

                     

                     

                      

                       }

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json
object
key
additional properties
string
Example generated

                     

                      

                       {
                      

                     

                     

                      

                        
                       "additionalProperty"
                       : 
                       "
                       example
                       "
                      

                     

                     

                      

                       }

403

Section titled “403 ”

Forbidden - No organization access

Media type application/json
object
key
additional properties
string
Example generated

                     

                      

                       {
                      

                     

                     

                      

                        
                       "additionalProperty"
                       : 
                       "
                       example
                       "
                      

                     

                     

                      

                       }

404

Section titled “404 ”

Control not found

Media type application/json
object
key
additional properties
string
Example generated

                     

                      

                       {
                      

                     

                     

                      

                        
                       "additionalProperty"
                       : 
                       "
                       example
                       "
                      

                     

                     

                      

                       }

500

Section titled “500 ”

Internal server error

Media type application/json
object
key
additional properties
string
Example generated

                     

                      

                       {
                      

                     

                     

                      

                        
                       "additionalProperty"
                       : 
                       "
                       example
                       "
                      

                     

                     

                      

                       }