Skip to main content
POST
/
policy
/
{policyId}
/
component
/
search
Search and filter policy components
curl --request POST \
  --url https://api.draftt.io/v1/policy/{policyId}/component/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": "<string>",
  "totalCount": 12
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

policyId
integer
required

Body

application/json
filter
object
Example:
{
"technology": "mongodb",
"tags": [
{
"key": "environment",
"value": "development"
}
],
"dueDate": {
"gte": "2024-12-22T13:47:25.036Z",
"lt": "2025-12-31T00:00:00.000Z"
}
}
sort
object
Example:
{ "createdAt": "asc" }
nextToken
string
Example:

"eyJza2lwIjoxMH0"

pageSize
integer
default:10
Required range: 1 <= x <= 100

Response

Success

items
object[]
required
nextToken
string
totalCount
integer
Example:

12