Get an API key

curl --request GET \
  --url https://api.checkfu.com/v1/api-keys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

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

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/api-keys/{id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "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
        },
        "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>"
    }
  },
  "resource_version": 4503599627370495,
  "created_at": "<string>",
  "updated_at": "<string>",
  "revoked_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": "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"
  }
}

Get an API key

Reads one ApiKey issued by the authenticated Organization, including its role, scope, kind, rate limit, runner enrollment, resource_version, and revoked_at. The secret is never returned. Use the returned resource_version as expected_resource_version when patching or rotating.

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.

GET

api-keys

{id}

Get an API key

curl --request GET \
  --url https://api.checkfu.com/v1/api-keys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

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

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/api-keys/{id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "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
        },
        "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>"
    }
  },
  "resource_version": 4503599627370495,
  "created_at": "<string>",
  "updated_at": "<string>",
  "revoked_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": "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

Path Parameters

string

required

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

Response

Success

string

required

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

organization_id

string

required

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

display_name

string

required

Required string length: 1 - 255

role

enum<string>

required

Available options:

root,

admin,

developer,

runner,

viewer

scope

object

required

Option 1
Option 2

Show child attributes

api_key_type

enum<string>

required

Available options:

organization_managed,

console_session

rate_limit_per_minute

integer

required

Required range: 0 < x <= 2147483647

runner_enrollment

object | null

required

Show child attributes

resource_version

integer

required

Required range: 0 < x <= 9007199254740991

created_at

string

required

updated_at

string

required

revoked_at

string | null

required

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Get an API key

Authorizations

Headers

Path Parameters

Response