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

Get project policy control

GET
/api/v1/projects/{projectId}/policies/{projectPolicyId}/controls/{controlId} 

       

        

         curl
          
         --request
          
         GET
          
         \
        

       

       

        

          
         --url
          
         https://localhost:10001/api/v1/projects/1/policies/1/controls/1
          
         \
        

       

       

        

          
         --header
          
         '
         Authorization: 
          
         '

Retrieve a control from a project policy by base control ID

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectId
required
integer

Project ID

projectPolicyId
required
integer

Project Policy ID

controlId
required
integer

Control ID (the base control.id; the GET endpoint takes a base control id, unlike the POST endpoints)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Project policy control

Media type application/json
object
controlId
integer
createdAt
string
id
integer
indicators
Array
object
applicationUuid
string
createdAt

Audit

string
criteria
Array
declarationProfile

Declaration behavior

object
emitOn

“pass” | “fail” | “both” | “none”

string
Allowed values: pass fail both none
statementTemplate
string
titleTemplate
string
extractionRules

Custom indicator fields

Array
id
integer
indicatorId
string
lastEvaluatedAt
string
parameters
Array
projectPolicyControlId
integer
status

State

string
Allowed values: active disabled archived
triggerType
string
Allowed values: event
updatedAt
string
projectPolicyId
integer
status
string
updatedAt
string
Example 

                 

                  

                   {
                  

                 

                 

                  

                    
                   "indicators"
                   : [
                  

                 

                 

                  

                    
                   {
                  

                 

                 

                  

                    
                   "declarationProfile"
                   : {
                  

                 

                 

                  

                    
                   "emitOn"
                   : 
                   "
                   pass
                   "
                  

                 

                 

                  

                    
                   },
                  

                 

                 

                  

                    
                   "status"
                   : 
                   "
                   active
                   "
                   ,
                  

                 

                 

                  

                    
                   "triggerType"
                   : 
                   "
                   event
                   "
                  

                 

                 

                  

                    
                   }
                  

                 

                 

                  

                    
                   ]
                  

                 

                 

                  

                   }

400

Section titled “400 ”

Bad request - Invalid project ID, project policy ID, or 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 project access or insufficient permissions

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

                     

                      

                       {
                      

                     

                     

                      

                        
                       "additionalProperty"
                       : 
                       "
                       example
                       "
                      

                     

                     

                      

                       }

404

Section titled “404 ”

Project policy 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
                       "
                      

                     

                     

                      

                       }