devguard

Controls

Get a paginated list of controls from adopted frameworks.

GET
/controls/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

limit?number
Default100
Range5 <= value
page?number
Default1
Range1 <= value
organizationId*string
sortColumn?string
sortDirection?string
Value in"asc" | "desc"
search?string
frameworks?array<>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.devguard.ch/api/controls/?organizationId=string"
{
  "items": [
    {
      "id": "string",
      "identifier": "string",
      "name": "string",
      "slug": "string",
      "type": "CATEGORY",
      "purpose": "string",
      "description": {},
      "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"
      },
      "sourceMatches": [
        {
          "id": "string",
          "matchLevel": "FULL",
          "matchedControl": {
            "id": "string",
            "identifier": "string",
            "name": "string",
            "slug": "string",
            "framework": {
              "id": "string",
              "name": "string",
              "identifier": "string",
              "identifierColor": "string"
            }
          }
        }
      ],
      "children": [
        {
          "id": "string",
          "identifier": "string",
          "name": "string",
          "slug": "string",
          "type": "CATEGORY",
          "purpose": "string",
          "description": {},
          "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"
          },
          "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
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

How is this guide?