Get applied policy control

GET

/api/v1/projects/{projectId}/policies/{appliedPolicyId}/controls/{appliedPolicyControlId}

curl --request GET \
  --url https://localhost:10001/api/v1/projects/example/policies/example/controls/example \
  --header 'Authorization: <Authorization>'

Retrieve a control from an applied policy by applied policy control ID

Authorizations

• BearerAuth

Parameters

Path Parameters

projectId

required

string

Project ID, UUID (urn:uuid optional), or slug:my-project

appliedPolicyId

required

string

Applied policy ID, slug:my-policy, or urn:cid:bafy…

appliedPolicyControlId

required

string

Applied policy control ID, code:AC-1, or urn:cid:bafy…

Responses

200

Applied policy control

Media type application/json

A control within an applied policy, with its latest declaration and review state

object

appliedPolicyId

integer

cid

string

controlId

integer

createdAt

string format: date-time

id

integer

indicators

Array<object>

An indicator bound to an applied policy control, defining how and when it is evaluated

object

applicationUuid

Urn:uuid form

string

appliedPolicyControlId

integer

createdAt

string format: date-time

criteria

Custom indicators only

object

declarationProfile

object

emitOn

required

When to emit a declaration

string

Allowed values: pass fail both none

statementTemplate

string

titleTemplate

string

extractionRules

Custom indicators only

object

id

integer

indicatorId

Urn:uuid form

string

lastEvaluatedAt

string format: date-time

parameters

object

status

string

Allowed values: active disabled archived

triggerType

string

Allowed values: event

updatedAt

string format: date-time

status

string

updatedAt

string format: date-time

Example

{
  "indicators": [
    {
      "declarationProfile": {
        "emitOn": "pass"
      },
      "status": "active",
      "triggerType": "event"
    }
  ]
}

400

Bad request - Invalid project ID, applied policy ID, or control ID

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

401

Unauthorized - Authentication required

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

403

Forbidden - No project access or insufficient permissions

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

404

Applied policy control not found

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

500

Internal server error

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}