Apply a ConnectionVault

curl --request POST \
  --url https://api.checkfu.com/v1/connection-vaults/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "schema_version": 1,
  "name": "<string>",
  "description": "<string>",
  "connection_ids": [
    "<string>"
  ],
  "members": [
    {
      "kind": "principal",
      "principal": "<string>"
    }
  ]
}
'

import requests

url = "https://api.checkfu.com/v1/connection-vaults/apply"

payload = {
    "schema_version": 1,
    "name": "<string>",
    "description": "<string>",
    "connection_ids": ["<string>"],
    "members": [
        {
            "kind": "principal",
            "principal": "<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({
    schema_version: 1,
    name: '<string>',
    description: '<string>',
    connection_ids: ['<string>'],
    members: [{kind: 'principal', principal: '<string>'}]
  })
};

fetch('https://api.checkfu.com/v1/connection-vaults/apply', 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/connection-vaults/apply",
  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([
    'schema_version' => 1,
    'name' => '<string>',
    'description' => '<string>',
    'connection_ids' => [
        '<string>'
    ],
    'members' => [
        [
                'kind' => 'principal',
                'principal' => '<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/connection-vaults/apply"

	payload := strings.NewReader("{\n  \"schema_version\": 1,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"connection_ids\": [\n    \"<string>\"\n  ],\n  \"members\": [\n    {\n      \"kind\": \"principal\",\n      \"principal\": \"<string>\"\n    }\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/connection-vaults/apply")
  .header("checkfu-version", "<checkfu-version>")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"schema_version\": 1,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"connection_ids\": [\n    \"<string>\"\n  ],\n  \"members\": [\n    {\n      \"kind\": \"principal\",\n      \"principal\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/connection-vaults/apply")

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  \"schema_version\": 1,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"connection_ids\": [\n    \"<string>\"\n  ],\n  \"members\": [\n    {\n      \"kind\": \"principal\",\n      \"principal\": \"<string>\"\n    }\n  ]\n}"

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

{
  "mode": "plan",
  "plan": {
    "name": "<string>",
    "connection_count": 1,
    "member_count": 1,
    "use_connection_permission_assignments": 1
  }
}

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

Apply a ConnectionVault

Compile one inline ConnectionVault document — a named grouping of Connections with explicit member access (principals or groups) — into ordinary use_connection PermissionAssignments, one per member × Connection (D213). The apply reconciles against the stored vault: it mints PermissionAssignments for new edges, re-mints any compiled PermissionAssignment that was deleted elsewhere, and revokes only PermissionAssignments the vault itself compiled for dropped edges. Because the apply revokes, it never adopts a pre-existing equivalent PermissionAssignment minted outside the vault — that conflicts instead, so a vault edit can never destroy an operator’s independent row. At most 1024 member × Connection edges compile in one apply. dry_run=true returns the compile plan without materializing. The vault row grants nothing by itself; no runtime check consults it. Requires an Idempotency-Key; re-apply of the same name is a CAS’d upgrade of the derived aggregate.

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

connection-vaults

apply

Apply a ConnectionVault

curl --request POST \
  --url https://api.checkfu.com/v1/connection-vaults/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "schema_version": 1,
  "name": "<string>",
  "description": "<string>",
  "connection_ids": [
    "<string>"
  ],
  "members": [
    {
      "kind": "principal",
      "principal": "<string>"
    }
  ]
}
'

import requests

url = "https://api.checkfu.com/v1/connection-vaults/apply"

payload = {
    "schema_version": 1,
    "name": "<string>",
    "description": "<string>",
    "connection_ids": ["<string>"],
    "members": [
        {
            "kind": "principal",
            "principal": "<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({
    schema_version: 1,
    name: '<string>',
    description: '<string>',
    connection_ids: ['<string>'],
    members: [{kind: 'principal', principal: '<string>'}]
  })
};

fetch('https://api.checkfu.com/v1/connection-vaults/apply', 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/connection-vaults/apply",
  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([
    'schema_version' => 1,
    'name' => '<string>',
    'description' => '<string>',
    'connection_ids' => [
        '<string>'
    ],
    'members' => [
        [
                'kind' => 'principal',
                'principal' => '<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/connection-vaults/apply"

	payload := strings.NewReader("{\n  \"schema_version\": 1,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"connection_ids\": [\n    \"<string>\"\n  ],\n  \"members\": [\n    {\n      \"kind\": \"principal\",\n      \"principal\": \"<string>\"\n    }\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/connection-vaults/apply")
  .header("checkfu-version", "<checkfu-version>")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"schema_version\": 1,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"connection_ids\": [\n    \"<string>\"\n  ],\n  \"members\": [\n    {\n      \"kind\": \"principal\",\n      \"principal\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/connection-vaults/apply")

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  \"schema_version\": 1,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"connection_ids\": [\n    \"<string>\"\n  ],\n  \"members\": [\n    {\n      \"kind\": \"principal\",\n      \"principal\": \"<string>\"\n    }\n  ]\n}"

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

{
  "mode": "plan",
  "plan": {
    "name": "<string>",
    "connection_count": 1,
    "member_count": 1,
    "use_connection_permission_assignments": 1
  }
}

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

idempotency-key

string

required

Required string length: 1 - 255

Query Parameters

dry_run

enum<string>

Available options:

true,

false

Body

application/json

schema_version

enum<number>

required

Available options:

1

name

string

required

Required string length: 1 - 255

description

string | null

required

Required string length: 1 - 2048

connection_ids

string[]

required

Maximum array length: 256

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

members

object[]

required

Maximum array length: 256

Option 1
Option 2

Show child attributes

Response

Success

Option 1
Option 2

mode

enum<string>

required

Available options:

plan

plan

object

required

Show child attributes

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Apply a ConnectionVault

Authorizations

Headers

Query Parameters

Body

Response