Skip to main content
POST
/
component
/
search
Search and filter components
curl --request POST \
  --url https://api.draftt.io/v1/component/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "tags": [
      {
        "key": "Environment",
        "value": "dev-us-east-1"
      }
    ],
    "technology": "k8s"
  },
  "sort": {
    "createdAt": "asc"
  },
  "nextToken": "eyJza2lwIjoxMH0",
  "pageSize": 10
}
'
import requests

url = "https://api.draftt.io/v1/component/search"

payload = {
"filter": {
"tags": [
{
"key": "Environment",
"value": "dev-us-east-1"
}
],
"technology": "k8s"
},
"sort": { "createdAt": "asc" },
"nextToken": "eyJza2lwIjoxMH0",
"pageSize": 10
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter: {tags: [{key: 'Environment', value: 'dev-us-east-1'}], technology: 'k8s'},
sort: {createdAt: 'asc'},
nextToken: 'eyJza2lwIjoxMH0',
pageSize: 10
})
};

fetch('https://api.draftt.io/v1/component/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.draftt.io/v1/component/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'tags' => [
[
'key' => 'Environment',
'value' => 'dev-us-east-1'
]
],
'technology' => 'k8s'
],
'sort' => [
'createdAt' => 'asc'
],
'nextToken' => 'eyJza2lwIjoxMH0',
'pageSize' => 10
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.draftt.io/v1/component/search"

payload := strings.NewReader("{\n \"filter\": {\n \"tags\": [\n {\n \"key\": \"Environment\",\n \"value\": \"dev-us-east-1\"\n }\n ],\n \"technology\": \"k8s\"\n },\n \"sort\": {\n \"createdAt\": \"asc\"\n },\n \"nextToken\": \"eyJza2lwIjoxMH0\",\n \"pageSize\": 10\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.draftt.io/v1/component/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"tags\": [\n {\n \"key\": \"Environment\",\n \"value\": \"dev-us-east-1\"\n }\n ],\n \"technology\": \"k8s\"\n },\n \"sort\": {\n \"createdAt\": \"asc\"\n },\n \"nextToken\": \"eyJza2lwIjoxMH0\",\n \"pageSize\": 10\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.draftt.io/v1/component/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"tags\": [\n {\n \"key\": \"Environment\",\n \"value\": \"dev-us-east-1\"\n }\n ],\n \"technology\": \"k8s\"\n },\n \"sort\": {\n \"createdAt\": \"asc\"\n },\n \"nextToken\": \"eyJza2lwIjoxMH0\",\n \"pageSize\": 10\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "id": 20,
      "integrationId": 6,
      "uniqueIdentifier": "arn:aws:rds:us-east-1:1234567:db:rds-dev-1",
      "region": "us-east-1",
      "technology": "rds",
      "type": "rds-postgres",
      "typeDisplayName": "Amazon RDS PostgreSQL",
      "version": "14.10",
      "tags": [
        {
          "key": "Terraform",
          "value": "true"
        },
        {
          "key": "Environment",
          "value": "dev-us-east-1"
        },
        {
          "key": "Name",
          "value": "rds-dev-1"
        }
      ],
      "details": {
        "database": {
          "lastActiveConnectionTime": "2024-09-09T14:36:11.531Z"
        }
      },
      "createdAt": "2024-05-06T11:25:50.750Z",
      "updatedAt": "2024-09-09T14:36:11.531Z"
    }
  ],
  "nextToken": "<string>",
  "totalCount": 12
}
{
"error": {
"message": "<string>"
}
}
{
"error": {
"message": "<string>"
}
}
{
"error": {
"message": "<string>"
}
}
{
"error": {
"message": "<string>"
}
}
{
"error": {
"message": "<string>"
}
}
{
"error": {
"message": "<string>"
}
}

Authorizations

Authorization
string
header
required

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

Body

application/json
filter
object
Example:
{
"tags": [
{
"key": "Environment",
"value": "dev-us-east-1"
}
],
"technology": "k8s"
}
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