Sync a Tool Source

curl --request POST \
  --url https://api.checkfu.com/v1/tool-sources/{id}/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "expected_version": 1,
  "connector_tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "input_schema": "<unknown>",
      "output_schema": "<unknown>"
    }
  ]
}
'

import requests

url = "https://api.checkfu.com/v1/tool-sources/{id}/sync"

payload = {
    "expected_version": 1,
    "connector_tools": [
        {
            "name": "<string>",
            "description": "<string>",
            "input_schema": "<unknown>",
            "output_schema": "<unknown>"
        }
    ]
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    expected_version: 1,
    connector_tools: [
      {
        name: '<string>',
        description: '<string>',
        input_schema: '<unknown>',
        output_schema: '<unknown>'
      }
    ]
  })
};

fetch('https://api.checkfu.com/v1/tool-sources/{id}/sync', 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.checkfu.com/v1/tool-sources/{id}/sync",
  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([
    'expected_version' => 1,
    'connector_tools' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'input_schema' => '<unknown>',
                'output_schema' => '<unknown>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/tool-sources/{id}/sync"

	payload := strings.NewReader("{\n  \"expected_version\": 1,\n  \"connector_tools\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"input_schema\": \"<unknown>\",\n      \"output_schema\": \"<unknown>\"\n    }\n  ]\n}")

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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.checkfu.com/v1/tool-sources/{id}/sync")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expected_version\": 1,\n  \"connector_tools\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"input_schema\": \"<unknown>\",\n      \"output_schema\": \"<unknown>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/tool-sources/{id}/sync")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expected_version\": 1,\n  \"connector_tools\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"input_schema\": \"<unknown>\",\n      \"output_schema\": \"<unknown>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workspace_id": "<string>",
  "name": "<string>",
  "provider": "<string>",
  "description": "<string>",
  "source": {
    "kind": "mcp",
    "url": "<string>",
    "authenticated": true
  },
  "status": "pending",
  "default_enabled": true,
  "default_permission": "always_ask",
  "tool_count": 1,
  "last_sync_at": "<string>",
  "last_sync_error_code": "<string>",
  "version": 1,
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Sync a Tool Source

Re-run discovery against the source and replace its Tool projection, preserving each tool’s local enablement by name — an explicit enable or disable is a review, and re-running discovery never overwrites one. A tool seen for the first time takes the source’s default_enabled posture instead. Requires expected_version in the body for optimistic concurrency and accepts an Idempotency-Key. Returns the ToolSource with a refreshed status, tool count, and last sync timestamp or error code.

Checkfu support posture: alpha; hosted. Required evidence journey: capability-catalog. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

POST

tool-sources

{id}

sync

Sync a Tool Source

curl --request POST \
  --url https://api.checkfu.com/v1/tool-sources/{id}/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "expected_version": 1,
  "connector_tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "input_schema": "<unknown>",
      "output_schema": "<unknown>"
    }
  ]
}
'

import requests

url = "https://api.checkfu.com/v1/tool-sources/{id}/sync"

payload = {
    "expected_version": 1,
    "connector_tools": [
        {
            "name": "<string>",
            "description": "<string>",
            "input_schema": "<unknown>",
            "output_schema": "<unknown>"
        }
    ]
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'checkfu-version': '<checkfu-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    expected_version: 1,
    connector_tools: [
      {
        name: '<string>',
        description: '<string>',
        input_schema: '<unknown>',
        output_schema: '<unknown>'
      }
    ]
  })
};

fetch('https://api.checkfu.com/v1/tool-sources/{id}/sync', 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.checkfu.com/v1/tool-sources/{id}/sync",
  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([
    'expected_version' => 1,
    'connector_tools' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'input_schema' => '<unknown>',
                'output_schema' => '<unknown>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/tool-sources/{id}/sync"

	payload := strings.NewReader("{\n  \"expected_version\": 1,\n  \"connector_tools\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"input_schema\": \"<unknown>\",\n      \"output_schema\": \"<unknown>\"\n    }\n  ]\n}")

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	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.checkfu.com/v1/tool-sources/{id}/sync")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expected_version\": 1,\n  \"connector_tools\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"input_schema\": \"<unknown>\",\n      \"output_schema\": \"<unknown>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/tool-sources/{id}/sync")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expected_version\": 1,\n  \"connector_tools\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"input_schema\": \"<unknown>\",\n      \"output_schema\": \"<unknown>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "workspace_id": "<string>",
  "name": "<string>",
  "provider": "<string>",
  "description": "<string>",
  "source": {
    "kind": "mcp",
    "url": "<string>",
    "authenticated": true
  },
  "status": "pending",
  "default_enabled": true,
  "default_permission": "always_ask",
  "tool_count": 1,
  "last_sync_at": "<string>",
  "last_sync_error_code": "<string>",
  "version": 1,
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "validation.conflict",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-conflict"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-27

idempotency-key

string

Maximum string length: 255

Path Parameters

string

required

Pattern: ^ts_[0-9a-f]{32}$

Body

application/json

expected_version

integer

required

Required range: x > 0

connector_tools

object[]

Maximum array length: 1000

Show child attributes

Response

Success

string

required

Pattern: ^ts_[0-9a-f]{32}$

workspace_id

string

required

Pattern: ^wrkspc_[0-9a-f]{32}$

name

string

required

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$

provider

string

required

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$

description

string | null

required

Maximum string length: 16384

source

object

required

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

status

enum<string>

required

Available options:

pending,

healthy,

sync_failed

default_enabled

boolean

required

default_permission

enum<string>

required

Available options:

always_ask,

always_allow

tool_count

integer

required

Required range: x >= 0

last_sync_at

string | null

required

last_sync_error_code

string | null

required

Required string length: 1 - 8192

version

integer

required

Required range: x > 0

created_at

string

required

updated_at

string

required

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Sync a Tool Source

Authorizations

Headers

Path Parameters

Body

Response