devguard
Controls

Get a paginated list of controls from adopted frameworks.

GET
/controls/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

limit?number
Range5 <= value
Default100
page?number
Range1 <= value
Default1
organizationId*string
Length1 <= length
sortColumn?string
sortDirection?string

Value in

  • "asc"
  • "desc"
search?string
frameworks?array<string>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/controls/?organizationId=string"
{  "items": [    {      "id": "string",      "identifier": "string",      "name": "string",      "slug": "string",      "type": "CATEGORY",      "purpose": "string",      "description": null,      "isMandatory": true,      "parentId": "string",      "frameworkId": "string",      "isCentralized": true,      "createdAt": "string",      "updatedAt": "string",      "framework": {        "id": "string",        "name": "string",        "identifier": "string",        "identifierColor": "string",        "version": "string",        "isCentralized": true      },      "parent": {        "id": "string",        "identifier": "string",        "name": "string"      },      "coverage": {        "coverageStatus": "FULL",        "coverageGap": "string"      },      "effectiveCoverageStatus": "FULL",      "isIndirectlyCovered": true,      "sourceMatches": [        {          "id": "string",          "matchLevel": "FULL",          "matchedControl": {            "id": "string",            "identifier": "string",            "name": "string",            "slug": "string",            "framework": {              "id": "string",              "name": "string",              "identifier": "string",              "identifierColor": "string"            }          }        }      ],      "children": [        {}      ]    }  ],  "total": 0,  "page": 0,  "limit": 0}

How is this guide?