Plan or apply Connection access

curl --request POST \
  --url https://api.checkfu.com/v1/connections/{id}/access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "agent_ids": [
    "<string>"
  ],
  "tool_names": [
    "<string>"
  ]
}
'

import requests

url = "https://api.checkfu.com/v1/connections/{id}/access"

payload = {
    "agent_ids": ["<string>"],
    "tool_names": ["<string>"]
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "idempotency-key": "<idempotency-key>",
    "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>',
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({agent_ids: ['<string>'], tool_names: ['<string>']})
};

fetch('https://api.checkfu.com/v1/connections/{id}/access', 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/connections/{id}/access",
  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([
    'agent_ids' => [
        '<string>'
    ],
    'tool_names' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>",
    "idempotency-key: <idempotency-key>"
  ],
]);

$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/connections/{id}/access"

	payload := strings.NewReader("{\n  \"agent_ids\": [\n    \"<string>\"\n  ],\n  \"tool_names\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("idempotency-key", "<idempotency-key>")
	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/connections/{id}/access")
  .header("checkfu-version", "<checkfu-version>")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_ids\": [\n    \"<string>\"\n  ],\n  \"tool_names\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/connections/{id}/access")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_ids\": [\n    \"<string>\"\n  ],\n  \"tool_names\": [\n    \"<string>\"\n  ]\n}"

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

{
  "mode": "plan",
  "connection_id": "<string>",
  "tool_source_id": "<string>",
  "tool_names": [
    "<string>"
  ],
  "agents": [
    {
      "agent_id": "<string>",
      "draft_change": true,
      "requires_publish": true,
      "add_tool_names": [
        "<string>"
      ],
      "remove_tool_names": [
        "<string>"
      ],
      "matching_installation_count": 1
    }
  ],
  "permission_assignments": [
    {
      "subject": {
        "kind": "principal",
        "id": "<string>"
      },
      "connection_permission_assignment_id": "<string>",
      "tool_permission_assignment_id": "<string>"
    }
  ],
  "readiness": "apply_required"
}

{
  "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"
  }
}

Plan or apply Connection access

Reconcile one active Executor-backed Connection to the complete desired Agent set. Omitted agents that currently pin the Connection receive explicit draft-tool removals; an empty agent_ids list removes every current draft pin. The compiler discovers and schema-pins the provider tools, creates or reuses the governed ToolSource, attaches exact Connection-pinned catalog tools to selected agent drafts, and mints both use_connection and use_tool PermissionAssignments for the owning Principal and matching active AgentInstallations. It never revokes independently authored PermissionAssignments; after omitted agents publish the narrowed draft, those latent PermissionAssignments cannot make an unpinned tool visible or callable. dry_run=true returns the same per-agent additions and removals without writing. The result reports publish_required until every affected released version matches; the compiler never publishes reviewed agent content automatically. Requires an Idempotency-Key.

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

POST

connections

{id}

access

Plan or apply Connection access

curl --request POST \
  --url https://api.checkfu.com/v1/connections/{id}/access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "agent_ids": [
    "<string>"
  ],
  "tool_names": [
    "<string>"
  ]
}
'

import requests

url = "https://api.checkfu.com/v1/connections/{id}/access"

payload = {
    "agent_ids": ["<string>"],
    "tool_names": ["<string>"]
}
headers = {
    "checkfu-version": "<checkfu-version>",
    "idempotency-key": "<idempotency-key>",
    "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>',
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({agent_ids: ['<string>'], tool_names: ['<string>']})
};

fetch('https://api.checkfu.com/v1/connections/{id}/access', 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/connections/{id}/access",
  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([
    'agent_ids' => [
        '<string>'
    ],
    'tool_names' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "checkfu-version: <checkfu-version>",
    "idempotency-key: <idempotency-key>"
  ],
]);

$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/connections/{id}/access"

	payload := strings.NewReader("{\n  \"agent_ids\": [\n    \"<string>\"\n  ],\n  \"tool_names\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("idempotency-key", "<idempotency-key>")
	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/connections/{id}/access")
  .header("checkfu-version", "<checkfu-version>")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_ids\": [\n    \"<string>\"\n  ],\n  \"tool_names\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/connections/{id}/access")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_ids\": [\n    \"<string>\"\n  ],\n  \"tool_names\": [\n    \"<string>\"\n  ]\n}"

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

{
  "mode": "plan",
  "connection_id": "<string>",
  "tool_source_id": "<string>",
  "tool_names": [
    "<string>"
  ],
  "agents": [
    {
      "agent_id": "<string>",
      "draft_change": true,
      "requires_publish": true,
      "add_tool_names": [
        "<string>"
      ],
      "remove_tool_names": [
        "<string>"
      ],
      "matching_installation_count": 1
    }
  ],
  "permission_assignments": [
    {
      "subject": {
        "kind": "principal",
        "id": "<string>"
      },
      "connection_permission_assignment_id": "<string>",
      "tool_permission_assignment_id": "<string>"
    }
  ],
  "readiness": "apply_required"
}

{
  "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

required

Required string length: 1 - 255

Path Parameters

string

required

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

Query Parameters

dry_run

enum<string>

Available options:

true,

false

Body

application/json

agent_ids

string[]

required

Maximum array length: 1000

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

tool_names

string[]

Maximum array length: 1000

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

Response

Success

mode

enum<string>

required

Available options:

plan,

applied

connection_id

string

required

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

tool_source_id

string | null

required

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

tool_names

string[]

required

Maximum array length: 1000

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

agents

object[]

required

Maximum array length: 1000

Show child attributes

permission_assignments

object[]

required

Maximum array length: 1100

Show child attributes

readiness

enum<string>

required

Available options:

apply_required,

installation_required,

publish_required,

ready

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Plan or apply Connection access

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response