Policy Component

Search and filter policy components

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdintegerRequired

Body

application/json

nextTokenstringOptionalExample: eyJza2lwIjoxMH0

pageSizeinteger · min: 1 · max: 100OptionalDefault: 10

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

post

/policy/{policyId}/component/search

HTTPcURLJavaScriptPython

POST /v1/policy/{policyId}/component/search HTTP/1.1
Host: api.draftt.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "filter": {
    "technology": "mongodb",
    "tags": [
      {
        "key": "environment",
        "value": "development"
      }
    ],
    "dueDate": {
      "gte": "2024-12-22T13:47:25.036Z",
      "lt": "2025-12-31T00:00:00.000Z"
    }
  },
  "sort": {
    "createdAt": "asc"
  },
  "nextToken": "eyJza2lwIjoxMH0",
  "pageSize": 10
}

{
  "items": [
    {
      "id": 22,
      "componentId": 3,
      "integrationId": 6,
      "technology": "rds",
      "type": "rds-postgres",
      "typeDisplayName": "Amazon RDS PostgreSQL",
      "name": "dev-1-rds",
      "uniqueIdentifier": "arn:aws:rds:us-east-1:125422356123:db:dev-1-rds",
      "urgency": 17.39,
      "priority": 17.39,
      "isCompliant": true,
      "currentVersion": "14.10",
      "requiredVersion": "14.11",
      "recommendedVersion": "14.11",
      "dueDate": "2025-12-22T00:00:00.000Z",
      "tags": [
        {
          "key": "Terraform",
          "value": "true"
        },
        {
          "key": "Environment",
          "value": "dev-us-east-1"
        },
        {
          "key": "Name",
          "value": "dev-1-rds"
        }
      ],
      "createdAt": "2024-05-06T11:25:51.513Z",
      "updatedAt": "2024-01-06T11:25:51.513Z"
    }
  ],
  "nextToken": "text",
  "totalCount": 12
}

Retrieve a specific policy component by ID

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdintegerRequired

componentIdintegerRequired

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

get

/policy/{policyId}/component/{componentId}

HTTPcURLJavaScriptPython

GET /v1/policy/{policyId}/component/{componentId} HTTP/1.1
Host: api.draftt.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": 22,
      "componentId": 3,
      "integrationId": 6,
      "technology": "rds",
      "type": "rds-postgres",
      "typeDisplayName": "Amazon RDS PostgreSQL",
      "name": "dev-1-rds",
      "uniqueIdentifier": "arn:aws:rds:us-east-1:125422356123:db:dev-1-rds",
      "urgency": 17.39,
      "priority": 17.39,
      "isCompliant": true,
      "currentVersion": "14.10",
      "requiredVersion": "14.11",
      "recommendedVersion": "14.11",
      "dueDate": "2025-12-22T00:00:00.000Z",
      "tags": [
        {
          "key": "Terraform",
          "value": "true"
        },
        {
          "key": "Environment",
          "value": "dev-us-east-1"
        },
        {
          "key": "Name",
          "value": "dev-1-rds"
        }
      ],
      "createdAt": "2024-05-06T11:25:51.513Z",
      "updatedAt": "2024-01-06T11:25:51.513Z"
    }
  ],
  "nextToken": null
}

Search and filter Policy Components

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdintegerRequired

Body

application/json

calculateDisplayNamesbooleanOptional

If true - will return a 'displayType' field containing a prettified technology field

pageTokenstringOptional

Base64 token for pagination

pageSizeinteger · min: 1 · max: 1000Optional

Number of items to return per page

Default: 100

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

post

/policy/{policyId}/component/query

HTTPcURLJavaScriptPython

POST /v1/policy/{policyId}/component/query HTTP/1.1
Host: api.draftt.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 423

{
  "pageSize": 20,
  "filter": {
    "activeExtendedSupport": true,
    "extendedSupportAnnualCost": {
      "$gte": 1000
    }
  },
  "componentData": {
    "select": [
      "tags"
    ]
  },
  "sort": {
    "urgency": "desc"
  },
  "pageToken": "eyJ1bmlxdWVGaWVsZE5hbWUiOiJpZCIsInNvcnQiOnsidXJnZW5jeSI6eyJvcmRlciI6MCwiZGlyZWN0aW9uIjoiZGVzYyJ9LCJpZCI6eyJvcmRlciI6MSwiZGlyZWN0aW9uIjoiYXNjIn19LCJzb3J0VmFsdWVzIjp7InVyZ2VuY3kiOjUuNDM0NzgyNjA4Njk1NjUyLCJpZCI6IjUwMDg1In19",
  "calculateDisplayNames": true
}

{
  "nextPageToken": "eyJ1bmlxdWVGaWVsZE5hbWUiOiJpZCIsInNvcnQiOnsidXJnZW5jeSI6eyJvcmRlciI6MCwiZGlyZWN0aW9uIjoiZGVzYyJ9LCJpZCI6eyJvcmRlciI6MSwiZGlyZWN0aW9uIjoiYXNjIn19LCJzb3J0VmFsdWVzIjp7InVyZ2VuY3kiOjUuNDM0NzgyNjA4Njk1NjUyLCJpZCI6IjUwMDg1In19",
  "items": [
    {
      "id": "456654",
      "technology": "eks",
      "name": "staging-cluster-us-east-1",
      "urgency": 62,
      "effort": 0,
      "priority": 0,
      "status": "Outdated",
      "policyId": "1",
      "componentId": "12321",
      "orgComplexity": 0,
      "isCompliant": false,
      "currentVersion": "1.29",
      "desiredVersion": "1.30",
      "dueDate": "2025-03-23T00:00:00.000Z",
      "createdAt": "2025-03-26T17:02:41.237Z",
      "updatedAt": "2025-04-07T02:47:31.606Z",
      "deletedAt": null,
      "recommendedVersion": "1.32",
      "extendedSupportAnnualCost": 4380,
      "impendingDate": "2025-03-23T00:00:00.000Z",
      "outdatedDate": "2026-03-23T00:00:00.000Z",
      "activeExtendedSupport": true,
      "tags": {
        "environment": "staging",
        "Terraform": "true"
      },
      "displayName": "Amazon EKS"
    },
    "..."
  ]
}

For a list of component types and versions, retrieve their policy data by the policy id

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdintegerRequired

Body

application/json

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

post

/policy/{policyId}/component/complianceCheck

HTTPcURLJavaScriptPython

POST /v1/policy/{policyId}/component/complianceCheck HTTP/1.1
Host: api.draftt.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "componentsData": [
    {
      "type": "cloudsql-mysql",
      "version": "5.7.44"
    },
    {
      "type": "eks",
      "version": "1.30"
    }
  ]
}

{
  "items": [
    {
      "policyId": "1",
      "currentVersion": "5.7.44",
      "technology": "cloudsql-mysql",
      "isCompliant": false,
      "urgency": 57.89473684210526,
      "hasForceUpgrade": true,
      "requiredVersion": "8.0.18",
      "recommendedVersion": "8.4.5",
      "dueDate": "2025-02-01",
      "status": "Outdated"
    },
    {
      "policyId": "1",
      "currentVersion": "1.31",
      "technology": "eks",
      "isCompliant": true,
      "urgency": 25.263157894736842,
      "recommendedVersion": "1.33",
      "hasForceUpgrade": true,
      "dueDate": "2025-11-26",
      "status": "Impending",
      "requiredVersion": "1.32"
    }
  ]
}