Rotate an API key

curl --request POST \
  --url https://api.checkfu.com/v1/api-keys/{id}/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "expected_resource_version": 1
}
'

import requests

url = "https://api.checkfu.com/v1/api-keys/{id}/rotate"

payload = { "expected_resource_version": 1 }
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({expected_resource_version: 1})
};

fetch('https://api.checkfu.com/v1/api-keys/{id}/rotate', 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/api-keys/{id}/rotate",
  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_resource_version' => 1
  ]),
  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/api-keys/{id}/rotate"

	payload := strings.NewReader("{\n  \"expected_resource_version\": 1\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/api-keys/{id}/rotate")
  .header("checkfu-version", "<checkfu-version>")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expected_resource_version\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/api-keys/{id}/rotate")

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  \"expected_resource_version\": 1\n}"

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

{
  "api_key": {
    "id": "<string>",
    "organization_id": "<string>",
    "display_name": "<string>",
    "role": "root",
    "scope": {
      "type": "organization"
    },
    "api_key_type": "organization_managed",
    "rate_limit_per_minute": 1073741823,
    "runner_enrollment": {
      "placement": "local",
      "providers": [
        {
          "id": "<string>",
          "provider_revision": "<string>",
          "materialization_revision": "<string>",
          "drivers": [
            "<string>"
          ],
          "launch_kinds": [
            "trusted"
          ],
          "tiers": [
            "container"
          ],
          "platforms": [
            {
              "os": "linux",
              "architecture": "amd64"
            }
          ],
          "network_modes": [
            "none"
          ],
          "retention_modes": [
            "durable"
          ],
          "package_materialization": true,
          "max_mounts": 1,
          "minimum_resources": {
            "cpu_millis": 1,
            "memory_mib": 1,
            "disk_mib": 1,
            "max_duration_seconds": 1
          },
          "maximum_resources": {
            "cpu_millis": 1,
            "memory_mib": 1,
            "disk_mib": 1,
            "max_duration_seconds": 1
          },
          "browser_observation": {
            "accessibility_tree": true,
            "screenshot": true
          },
          "desktop_observation": {
            "accessibility_tree": true,
            "screenshot": true,
            "window_inventory": true
          },
          "harness_owned_models": [
            {
              "kind": "cursor_api_key",
              "harness_profile_id": "<string>",
              "harness_profile_revision_number": 1,
              "harness_release_digest": "<string>",
              "provider": "cursor",
              "model": "<string>"
            }
          ],
          "session_sandbox": true,
          "runtime_assurances": {
            "compute_accounting": true,
            "network_isolation": true,
            "bounded_start": true,
            "bounded_cancel": true,
            "teardown": true
          },
          "acp_transport": "stdio",
          "snapshot_clone": true,
          "snapshot_custody": "runner",
          "mount_kinds": [
            "uploaded_project"
          ]
        }
      ],
      "plane_protocols": [
        "model-gateway-v1"
      ],
      "runner_pool": "<string>",
      "owner": {
        "principal": "<string>",
        "machine_label": "<string>"
      },
      "placement_conformance_digests": [
        "<string>"
      ]
    },
    "resource_version": 4503599627370495,
    "created_at": "<string>",
    "updated_at": "<string>",
    "revoked_at": "<string>"
  },
  "secret": "<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"
  }
}

Rotate an API key

Rotates an ApiKey’s secret in place: the key id, role, and scope are preserved while the previous secret stops authenticating. Requires an Idempotency-Key and an expected_resource_version matching the key’s current resource_version. The new plaintext secret is returned only in this response. A key may not rotate itself; call this with a different credential.

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

POST

api-keys

{id}

rotate

Rotate an API key

curl --request POST \
  --url https://api.checkfu.com/v1/api-keys/{id}/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "expected_resource_version": 1
}
'

import requests

url = "https://api.checkfu.com/v1/api-keys/{id}/rotate"

payload = { "expected_resource_version": 1 }
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({expected_resource_version: 1})
};

fetch('https://api.checkfu.com/v1/api-keys/{id}/rotate', 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/api-keys/{id}/rotate",
  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_resource_version' => 1
  ]),
  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/api-keys/{id}/rotate"

	payload := strings.NewReader("{\n  \"expected_resource_version\": 1\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/api-keys/{id}/rotate")
  .header("checkfu-version", "<checkfu-version>")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expected_resource_version\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/api-keys/{id}/rotate")

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  \"expected_resource_version\": 1\n}"

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

{
  "api_key": {
    "id": "<string>",
    "organization_id": "<string>",
    "display_name": "<string>",
    "role": "root",
    "scope": {
      "type": "organization"
    },
    "api_key_type": "organization_managed",
    "rate_limit_per_minute": 1073741823,
    "runner_enrollment": {
      "placement": "local",
      "providers": [
        {
          "id": "<string>",
          "provider_revision": "<string>",
          "materialization_revision": "<string>",
          "drivers": [
            "<string>"
          ],
          "launch_kinds": [
            "trusted"
          ],
          "tiers": [
            "container"
          ],
          "platforms": [
            {
              "os": "linux",
              "architecture": "amd64"
            }
          ],
          "network_modes": [
            "none"
          ],
          "retention_modes": [
            "durable"
          ],
          "package_materialization": true,
          "max_mounts": 1,
          "minimum_resources": {
            "cpu_millis": 1,
            "memory_mib": 1,
            "disk_mib": 1,
            "max_duration_seconds": 1
          },
          "maximum_resources": {
            "cpu_millis": 1,
            "memory_mib": 1,
            "disk_mib": 1,
            "max_duration_seconds": 1
          },
          "browser_observation": {
            "accessibility_tree": true,
            "screenshot": true
          },
          "desktop_observation": {
            "accessibility_tree": true,
            "screenshot": true,
            "window_inventory": true
          },
          "harness_owned_models": [
            {
              "kind": "cursor_api_key",
              "harness_profile_id": "<string>",
              "harness_profile_revision_number": 1,
              "harness_release_digest": "<string>",
              "provider": "cursor",
              "model": "<string>"
            }
          ],
          "session_sandbox": true,
          "runtime_assurances": {
            "compute_accounting": true,
            "network_isolation": true,
            "bounded_start": true,
            "bounded_cancel": true,
            "teardown": true
          },
          "acp_transport": "stdio",
          "snapshot_clone": true,
          "snapshot_custody": "runner",
          "mount_kinds": [
            "uploaded_project"
          ]
        }
      ],
      "plane_protocols": [
        "model-gateway-v1"
      ],
      "runner_pool": "<string>",
      "owner": {
        "principal": "<string>",
        "machine_label": "<string>"
      },
      "placement_conformance_digests": [
        "<string>"
      ]
    },
    "resource_version": 4503599627370495,
    "created_at": "<string>",
    "updated_at": "<string>",
    "revoked_at": "<string>"
  },
  "secret": "<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

required

Required string length: 1 - 255

Path Parameters

string

required

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

Body

application/json

expected_resource_version

integer

required

Required range: x > 0

Response

Success

api_key

object

required

Show child attributes

secret

string

required

Minimum string length: 1

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Rotate an API key

Authorizations

Headers

Path Parameters

Body

Response