Vee3
REMOTE · MCP.VEE3.IO · SCANNED AUG 3
Hosted MCP with 91 agent tools: X, domains, SEO, Maps, Trends, Search, YouTube, TikTok, and more.
Available components
How this component scores in each security and reliability category. Every signal is checked automatically against the live server, and we only credit what we can confirm. How we score →
Endpoint Security57
- The endpoint's TLS certificate is valid, in date, and uses a strong key. View diagnostics → Pass
- Authorisation not fully verified: no authorisation is required to call this server, and 240 tool(s) never declared a destructiveHint. The MCP spec treats an absent hint as destructive by default, so we cannot call this surface safe. See how to fix → View diagnostics → Unverified
- HTTPS is enforced; there's no plaintext access path. View diagnostics → Pass
- HSTS check failed: the Strict-Transport-Security header is absent. See how to fix → View diagnostics → Fail
- DNSSEC check failed: this domain isn't protected by DNSSEC. See how to fix → View diagnostics → Fail
Transport & Reachability100
- Verified streamable-http transport via a live MCP handshake. View diagnostics → Pass
Schema Quality & AI Usability63
- AI-judged instruction clarity (good).Pass
- Context-footprint check failed: tool/resource definitions use about 34744 tokens (~144/item across 240 items; 240 tools + 0 resources), over budget; trim descriptions and params. See how to fix → Fail
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management6
- Stability check failed: schema churn in the 8 days we've observed: 62 tool removals, 0 breaking changes, 0 auth/transport breaks, 6 additions. See how to fix → Fail
Tool Coverage100
- 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
- 100% of tool parameters carry a description.Pass
- Structured output schemas are declared (100% of tools); any adoption earns full credit.Pass
Capabilities100
- Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.
remote · mcp.vee3.io
claude mcp add --transport http vee3io-vee3 https://mcp.vee3.io/mcp
[mcp_servers.vee3io-vee3] url = "https://mcp.vee3.io/mcp"
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"vee3io-vee3": {
"type": "remote",
"url": "https://mcp.vee3.io/mcp",
"enabled": true
}
}
} openclaw mcp add vee3io-vee3 --url https://mcp.vee3.io/mcp --transport streamable-http
mcp_servers:
vee3io-vee3:
url: "https://mcp.vee3.io/mcp" {
"mcpServers": {
"vee3io-vee3": {
"type": "http",
"url": "https://mcp.vee3.io/mcp"
}
}
} The mcpServers block is a cross-client convention. Remote transports vary, so check your client's docs.
Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 2 Aug 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 0 to 2.
- 31 Jul 26 −1
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 30 Jul 26 0
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 29 Jul 26 +1
- This server's schema is too large to store in full, so we cannot compare its tools day to day functional
- 28 Jul 26 0
- This server's schema is too large to store in full, so we cannot compare its tools day to day functional
- 27 Jul 26 0
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 26 Jul 26 60
First indexed and scored.
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 3 Aug 2026 · Probed https://mcp.vee3.io/mcp
TLS valid
Negotiated TLS 1.3 with TLS_AES_128_GCM_SHA256 .
| Subject | Issuer | Valid from | Valid until | Key | Signature | Serial |
|---|---|---|---|---|---|---|
| CN=mcp.vee3.io | CN=WR3,O=Google Trust Services,C=US | 19 Jul 2026 | 17 Oct 2026 | RSA 2048 | SHA256-RSA | 299afbdbcd59affa0a0a4719cdd2adf2 |
| SANs: mcp.vee3.io | ||||||
| CN=WR3,O=Google Trust Services,C=US (CA) | CN=GTS Root R1,O=Google Trust Services LLC,C=US | 13 Dec 2023 | 20 Feb 2029 | RSA 2048 | SHA256-RSA | 7ff005a91568d63abc22861684aa4b5a |
| CN=GTS Root R1,O=Google Trust Services LLC,C=US (CA) | CN=GlobalSign Root CA,OU=Root CA,O=GlobalSign nv-sa,C=BE | 19 Jun 2020 | 28 Jan 2028 | RSA 4096 | SHA256-RSA | 77bd0d6cdb36f91aea210fc4f058d30d |
DNSSEC insecure
Validation of mcp.vee3.io. — Not signed
| Zone | DS | Keys | Algorithms | Outcome |
|---|---|---|---|---|
| . | trust_anchor | 20326, 38696 | 8, 8 | Verified |
| io. | present | 57355 | 8 | Verified |
| vee3.io. | absent | Unsigned (proven) parent-signed NSEC/NSEC3 proves an unsigned delegation |
Authentication No authorisation required
The endpoint answered without asking for a token. Anyone who knows the URL can reach it.
| Result | No authorisation required |
|---|---|
| HTTP status | 200 |
Transports 2 probes
| Transport | URL | Outcome | Status | Location |
|---|---|---|---|---|
| streamable-http | https://mcp.vee3.io/mcp | Verified | 200 | |
| http (plaintext) | http://mcp.vee3.io/mcp | HTTPS enforced | 302 | https://mcp.vee3.io/mcp |
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability.
clerk.list_organizations ~147
List organizations in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns organization id, name, slug, members_count, and created_at for each organization, plus total_count. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| limit | integer | — | Maximum number of organizations to return (1–500). |
| offset | integer | — | Number of organizations to skip before returning results. |
| query | — | — | Optional search string to filter organizations by name or slug. |
| Name | Type | Req | Description |
|---|---|---|---|
| organizations | — | — | Organizations returned for the requested page. |
| total_count | — | — | Total number of organizations in the Clerk application. |
No examples provided.
clerk.list_redirect_urls ~122
List allowed redirect URLs for a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns redirect URL summaries and total_count. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| limit | integer | — | Maximum number of redirect URLs to return (1–500). |
| offset | integer | — | Number of redirect URLs to skip before returning results. |
| Name | Type | Req | Description |
|---|---|---|---|
| redirect_urls | — | — | Allowed redirect URLs returned for the requested page. |
| total_count | — | — | Total number of redirect URLs. |
No examples provided.
clerk.list_sessions ~210
List sessions in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns session id, user_id, status, last_active_at, and expire_at for each session. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| client_id | — | — | Filter sessions to those belonging to this Clerk client id (client_...). |
| limit | integer | — | Maximum number of sessions to return (1–500). |
| offset | integer | — | Number of sessions to skip before returning results. |
| status | — | — | Filter sessions by status. Accepted values: abandoned, active, ended, expired, removed, replaced, revoked. |
| user_id | — | — | Filter sessions to those belonging to this Clerk user id (user_...). Clerk requires user_id or client_id when listing sessions; pass user_id here. |
| Name | Type | Req | Description |
|---|---|---|---|
| sessions | — | — | Sessions returned for the requested page. |
| total_count | — | — | Total number of sessions returned. |
No examples provided.
clerk.list_user_organization_memberships ~144
List all organizations a specific Clerk user belongs to. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns membership id, organization_id, role, and timestamps. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| limit | — | — | Maximum number of organization memberships to return (1–500). |
| offset | — | — | Number of organization memberships to skip before returning results. |
| user_id | string | yes | Clerk user id (user_...) whose memberships to list. |
| Name | Type | Req | Description |
|---|---|---|---|
| memberships | — | — | Organization memberships for the user. |
| total_count | — | — | Total number of organization memberships for the user. |
No examples provided.
clerk.list_users ~129
List users in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns user id, name, primary email, and created_at for each user, plus total_count. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| limit | integer | — | Maximum number of users to return (1–500). |
| offset | integer | — | Number of users to skip before returning results. |
| Name | Type | Req | Description |
|---|---|---|---|
| total_count | — | — | Total number of users in the Clerk application. |
| users | — | — | Users returned for the requested page. |
No examples provided.
clerk.list_waitlist_entries ~193
List waitlist entries in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns waitlist entry summaries and total_count. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| limit | integer | — | Maximum number of waitlist entries to return (1–500). |
| offset | integer | — | Number of waitlist entries to skip before returning results. |
| order_by | — | — | Sort order: created_at, email_address, or invited_at with optional + or - prefix. Defaults to -created_at. |
| query | — | — | Filter by email address or waitlist entry id. |
| status | — | — | Optional status filter: "pending", "invited", "rejected", or "completed". |
| Name | Type | Req | Description |
|---|---|---|---|
| total_count | — | — | Total number of waitlist entries on this page. |
| waitlist_entries | — | — | Waitlist entries returned for the requested page. |
No examples provided.
clerk.reject_waitlist_entry ~112
Reject a waitlist entry in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated waitlist entry. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| waitlist_entry_id | string | yes | Clerk waitlist entry id (wle_...) to operate on. |
| Name | Type | Req | Description |
|---|---|---|---|
| waitlist_entry | — | — | Updated Clerk waitlist entry after rejection. |
No examples provided.
clerk.replace_user_metadata ~154
Replace the entire contents of one metadata namespace for a Clerk user. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. The metadata body fully replaces the chosen namespace. Returns the updated user summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| metadata | object | yes | New metadata dict that fully replaces the chosen namespace. Pass an empty object to clear all keys. |
| metadata_type | string | yes | Metadata namespace to replace. |
| user_id | string | yes | Clerk user id (user_...) whose metadata to replace. |
| Name | Type | Req | Description |
|---|---|---|---|
| user | — | — | Updated Clerk user object after the metadata replacement. |
No examples provided.
clerk.revoke_actor_token ~127
Revoke an actor token in a connected Clerk application so it can no longer be used for impersonation. **Sensitive** — invalidates a high-privilege token. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the revoked actor token object. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| actor_token_id | string | yes | Clerk actor token id to revoke. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| Name | Type | Req | Description |
|---|---|---|---|
| actor_token | — | — | Revoked Clerk actor token object from the Backend API. |
No examples provided.
clerk.revoke_admin_portal_link_token ~150
Revoke an admin portal link token by id in a connected Clerk instance. **Sensitive** — invalidates a single-use deep-link token. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the revoked admin portal link token. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| admin_portal_link_token_id | string | yes | Admin portal link token id (aplt_...) to revoke. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| revocation_reason | — | — | Optional reason recorded when revoking the link token. |
| Name | Type | Req | Description |
|---|---|---|---|
| admin_portal_link_token | — | — | Revoked admin portal link token from the Backend API. |
No examples provided.
clerk.revoke_api_key ~138
Revoke an API key in a connected Clerk application so it can no longer be used. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the revoked API key summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| api_key_id | string | yes | Clerk API key id (ak_...) to retrieve, update, delete, or revoke. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| revocation_reason | — | — | Optional reason recorded when revoking the API key. |
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | — | — | Revoked Clerk API key from the Backend API. |
No examples provided.
clerk.revoke_invitation ~106
Revoke a pending application invitation by invitation id. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Only pending invitations can be revoked. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| invitation_id | string | yes | Clerk application invitation id (inv_...) to revoke. |
| Name | Type | Req | Description |
|---|---|---|---|
| invitation | — | — | Revoked Clerk invitation object from the Backend API. |
No examples provided.
clerk.revoke_m2m_token ~130
Revoke an M2M token by id in a connected Clerk instance. **Sensitive** — invalidates a machine authentication token. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the revoked M2M token. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| m2m_token_id | string | yes | Clerk M2M token id (mt_...) to revoke. |
| Name | Type | Req | Description |
|---|---|---|---|
| m2m_token | — | — | Revoked M2M token from the Backend API. |
No examples provided.
clerk.revoke_organization_invitation ~132
Revoke a pending Clerk organization invitation. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Only pending invitations can be revoked. Returns the updated invitation summary with status revoked. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| invitation_id | string | yes | Clerk organization invitation id (orginv_...). |
| organization_id | string | yes | Clerk organization id (org_...) to operate on. |
| Name | Type | Req | Description |
|---|---|---|---|
| invitation | — | — | Revoked organization invitation summary. |
No examples provided.
clerk.revoke_session ~114
Revoke a session in a connected Clerk application, immediately ending it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the revoked session object with status set to revoked. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| session_id | string | yes | Clerk session id (sess_...) to retrieve or modify. |
| Name | Type | Req | Description |
|---|---|---|---|
| client_id | — | — | Clerk client id associated with this session. |
| created_at | — | — | Unix timestamp in milliseconds when the session was created. |
| expire_at | — | — | Unix timestamp in milliseconds when this session expires. |
| id | — | — | Clerk session id (sess_...). |
| last_active_at | — | — | Unix timestamp in milliseconds of the last activity on this session. |
| status | — | — | Current status of the session. |
| updated_at | — | — | Unix timestamp in milliseconds when the session was last updated. |
| user_id | — | — | Clerk user id (user_...) that owns this session. |
No examples provided.
clerk.revoke_sign_in_token ~129
Revoke a sign-in token in a connected Clerk application so it can no longer be used. **Sensitive** — invalidates a high-privilege token. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the revoked sign-in token object. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| sign_in_token_id | string | yes | Clerk sign-in token id to revoke. |
| Name | Type | Req | Description |
|---|---|---|---|
| sign_in_token | — | — | Revoked Clerk sign-in token object from the Backend API. |
No examples provided.
clerk.rotate_machine_secret_key ~153
Rotate the secret key for a machine in a connected Clerk instance. **Sensitive** — the response includes the new secret key; do not log or expose it. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the new secret key. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| machine_id | string | yes | Clerk machine id (mch_...) to retrieve or modify. |
| previous_token_ttl | integer | yes | Seconds the previous secret key remains valid after rotation (0–28800). |
| Name | Type | Req | Description |
|---|---|---|---|
| machine_secret_key | — | — | Rotated machine secret key payload from the Backend API. |
No examples provided.
clerk.rotate_oauth_application_secret ~147
Rotate the client secret for a confidential OAuth application in a connected Clerk application. **Sensitive** — the response includes a new client_secret. Update authorized OAuth clients immediately and do not log the secret. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated OAuth application summary with the new client_secret. Cost = 10 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| oauth_application_id | string | yes | Clerk OAuth application id (oa_...) to retrieve, update, or delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| oauth_application | — | — | OAuth application summary with the new client_secret. |
No examples provided.
clerk.unban_users ~118
Remove bans from one or more Clerk users, restoring their ability to sign in. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated user summaries and total count. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| user_ids | array | yes | List of one or more Clerk user ids (user_...) to unban. |
| Name | Type | Req | Description |
|---|---|---|---|
| total_count | — | — | Number of users that were unbanned. |
| users | — | — | Updated user summaries for all unbanned users. |
No examples provided.
clerk.update_api_key ~180
Update an API key in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated API key summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| api_key_id | string | yes | Clerk API key id (ak_...) to retrieve, update, delete, or revoke. |
| claims | — | — | Updated custom claims for tokens minted from this API key. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| description | — | — | Updated description for the API key. |
| scopes | — | — | Updated permission scopes for the API key. |
| seconds_until_expiration | — | — | Updated seconds until expiration from now. |
| subject | — | — | Updated subject (user_... or org_...). |
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | — | — | Updated Clerk API key from the Backend API. |
No examples provided.
clerk.update_domain ~129
Update a custom domain on a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated domain. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| domain_id | string | yes | Clerk organization domain id (dmn_...) to update, delete, or verify. |
| name | — | — | Updated domain hostname. |
| proxy_url | — | — | Updated proxy URL for a satellite domain. |
| Name | Type | Req | Description |
|---|---|---|---|
| domain | — | — | Updated Clerk domain from the Backend API. |
No examples provided.
clerk.update_email_address ~138
Update a Clerk email address by id. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated email address summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| email_address_id | string | yes | Clerk email address id (idn_...) to retrieve or modify. |
| primary | — | — | When true, set this email as the user's primary email address. |
| verified | — | — | When true, mark the email address as verified. |
| Name | Type | Req | Description |
|---|---|---|---|
| email_address | — | — | Updated Clerk email address summary. |
No examples provided.
clerk.update_enterprise_connection ~255
Update an enterprise SSO connection in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated enterprise_connection summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| active | — | — | Whether the connection is active. |
| allow_organization_account_linking | — | — | Whether account linking via organization membership is allowed. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| connection_id | string | yes | Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test. |
| custom_attributes | — | — | Updated custom attribute mappings. |
| disable_additional_identifications | — | — | Whether to block additional identifications for this connection. |
| domains | — | — | Updated domain list (replaces existing domains when provided). |
| name | — | — | Updated display name for the connection. |
| oidc | — | — | Updated OIDC client configuration. |
| organization_id | — | — | Clerk organization id (org_...) to link to this connection. |
| saml | — | — | Updated SAML IdP configuration. |
| sync_user_attributes | — | — | Whether to sync user attributes on each sign-in. |
| Name | Type | Req | Description |
|---|---|---|---|
| enterprise_connection | — | — | Updated enterprise SSO connection. |
No examples provided.
clerk.update_instance_communication_settings ~109
Update SMS communication settings for a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated communication settings. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| blocked_country_codes | — | — | ISO country codes to block from receiving SMS messages (up to 250). |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| Name | Type | Req | Description |
|---|---|---|---|
| communication_settings | — | — | Updated Clerk instance communication settings from the Backend API. |
No examples provided.
clerk.update_instance_oauth_settings ~123
Update OAuth settings for a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated OAuth settings. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| dynamic_oauth_client_registration | — | — | Whether dynamic OAuth client registration should be enabled. |
| oauth_jwt_access_tokens | — | — | Whether OAuth access tokens should be issued as JWTs. |
| Name | Type | Req | Description |
|---|---|---|---|
| oauth_settings | — | — | Updated Clerk instance OAuth settings from the Backend API. |
No examples provided.
clerk.update_instance_organization_settings ~214
Update organization feature settings for a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated organization settings. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| admin_delete_enabled | — | — | Whether organization admins can delete their organization. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| creator_role | — | — | Default role assigned to the organization creator. |
| domains_default_role | — | — | Default role for members who join via a verified organization domain. |
| domains_enabled | — | — | Whether organization domains should be enabled. |
| domains_enrollment_modes | — | — | Allowed organization domain enrollment modes: manual_invitation, automatic_invitation, or automatic_suggestion. |
| enabled | — | — | Whether organizations should be enabled for the instance. |
| initial_role_set_key | — | — | Initial role set key applied to new organizations. |
| max_allowed_memberships | — | — | Maximum organization memberships allowed per user. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization_settings | — | — | Updated Clerk instance organization settings from the Backend API. |
No examples provided.
clerk.update_instance_restrictions ~181
Update sign-up and sign-in restriction settings for a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated instance restrictions. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| allowlist | — | — | Whether the allowlist restriction should be enabled. |
| allowlist_blocklist_disabled_on_sign_in | — | — | Whether allowlist and blocklist checks should be skipped during sign-in. |
| block_disposable_email_domains | — | — | Whether disposable email domains should be blocked. |
| block_email_subaddresses | — | — | Whether email subaddresses (plus-addressing) should be blocked. |
| blocklist | — | — | Whether the blocklist restriction should be enabled. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| Name | Type | Req | Description |
|---|---|---|---|
| restrictions | — | — | Updated Clerk instance restrictions from the Backend API. |
No examples provided.
clerk.update_instance_settings ~215
Update core settings for a connected Clerk application instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated instance settings. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| allowed_origins | — | — | Allowed browser origins for the instance. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| clerk_js_version | — | — | Pinned Clerk.js version for the instance. |
| development_origin | — | — | Development origin URL for local testing. |
| hibp | — | — | Whether Have I Been Pwned password checking should be enabled. |
| preferred_sign_in_strategy_when_password_required | — | — | Preferred sign-in strategy when a password is required: "password" or "otp". |
| support_email | — | — | Support email address shown to end users. |
| test_mode | — | — | Whether the instance should run in test mode. |
| url_based_session_syncing | — | — | Whether URL-based session syncing should be enabled. |
| Name | Type | Req | Description |
|---|---|---|---|
| instance_settings | — | — | Updated Clerk instance settings from the Backend API. |
No examples provided.
clerk.update_jwt_template ~211
Update an existing JWT template in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated template summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| allowed_clock_skew | — | — | Optional new allowed clock skew in seconds (0–300). |
| claims | — | — | Optional new JWT claims template as a JSON object. |
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| custom_signing_key | — | — | Optional flag to enable or disable a custom signing key. |
| lifetime | — | — | Optional new token lifetime in seconds (30–315360000). |
| name | — | — | Optional new unique template name. |
| signing_algorithm | — | — | Optional custom signing algorithm. |
| signing_key | — | — | Optional custom signing private key. |
| template_id | string | yes | Clerk JWT template id (jtmp_...) to retrieve, update, or delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| jwt_template | — | — | Updated Clerk JWT template summary. |
No examples provided.
clerk.update_machine ~129
Update a machine in a connected Clerk instance. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated machine. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| default_token_ttl | — | — | Updated default M2M token lifetime in seconds. |
| machine_id | string | yes | Clerk machine id (mch_...) to retrieve or modify. |
| name | — | — | Updated machine display name. |
| Name | Type | Req | Description |
|---|---|---|---|
| machine | — | — | Updated machine object from the Backend API. |
No examples provided.
clerk.update_oauth_application ~192
Update an OAuth application in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated OAuth application summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| consent_screen_enabled | — | — | Whether to show the OAuth consent screen during authorization. |
| name | — | — | New display name for the OAuth application. |
| oauth_application_id | string | yes | Clerk OAuth application id (oa_...) to retrieve, update, or delete. |
| public | — | — | Whether this is a public OAuth client (no client secret; PKCE-capable). |
| redirect_uris | — | — | Replacement list of allowed redirect URIs. |
| scopes | — | — | Space-delimited scopes (e.g. profile email public_metadata). |
| Name | Type | Req | Description |
|---|---|---|---|
| oauth_application | — | — | Updated Clerk OAuth application summary. |
No examples provided.
clerk.update_organization ~166
Update fields for a Clerk organization. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated organization summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| max_allowed_memberships | — | — | Optional new maximum number of memberships allowed. |
| name | — | — | Optional new display name for the organization. |
| organization_id | string | yes | Clerk organization id (org_...) to operate on. |
| private_metadata | — | — | Optional private metadata to merge into the organization. |
| public_metadata | — | — | Optional public metadata to merge into the organization. |
| slug | — | — | Optional new URL-friendly slug. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization | — | — | Updated Clerk organization summary. |
No examples provided.
clerk.update_organization_domain ~146
Update enrollment mode or verification status for an organization domain. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated domain summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| domain_id | string | yes | Clerk organization domain id (dmn_...) to update, delete, or verify. |
| enrollment_mode | — | — | Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion. |
| verified | — | — | Whether the domain is verified. |
| Name | Type | Req | Description |
|---|---|---|---|
| domain | — | — | Updated organization domain summary. |
No examples provided.
clerk.update_organization_membership ~147
Change the role of a Clerk organization member. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated membership. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| organization_id | string | yes | Clerk organization id (org_...) containing the member. |
| role | string | yes | New role for the member (e.g. org:member, org:admin). |
| user_id | string | yes | Clerk user id (user_...) of the member to update. |
| Name | Type | Req | Description |
|---|---|---|---|
| membership | — | — | Updated organization membership. |
No examples provided.
clerk.update_organization_membership_metadata ~151
Merge public or private metadata on a Clerk organization membership. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated membership. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| organization_id | string | yes | Clerk organization id (org_...) containing the membership. |
| private_metadata | — | — | Private metadata to merge into the membership. |
| public_metadata | — | — | Public metadata to merge into the membership. |
| user_id | string | yes | Clerk user id (user_...) of the member. |
| Name | Type | Req | Description |
|---|---|---|---|
| membership | — | — | Updated organization membership. |
No examples provided.
clerk.update_organization_metadata ~138
Merge metadata into a Clerk organization (deep merge — existing keys are preserved unless overwritten). Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated organization summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| organization_id | string | yes | Clerk organization id (org_...) to operate on. |
| private_metadata | — | — | Private metadata to merge into the organization. |
| public_metadata | — | — | Public metadata to merge into the organization. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization | — | — | Updated Clerk organization summary. |
No examples provided.
clerk.update_organization_permission ~120
Update an organization permission in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated permission summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| description | — | — | Updated permission description. |
| name | — | — | Updated permission display name. |
| permission_id | string | yes | Clerk organization permission id to update or delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization_permission | — | — | Updated organization permission summary. |
No examples provided.
clerk.update_organization_role ~152
Update an organization role in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated role summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| description | — | — | Updated role description. |
| is_creator_eligible | — | — | Whether this role may be assigned as organization creator. |
| name | — | — | Updated role display name. |
| permissions | — | — | Permission keys to assign to the role. |
| role_id | string | yes | Clerk organization role id to retrieve, update, or delete. |
| Name | Type | Req | Description |
|---|---|---|---|
| organization_role | — | — | Updated organization role summary. |
No examples provided.
clerk.update_phone_number ~156
Update a Clerk phone number by id. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated phone number summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| phone_number_id | string | yes | Clerk phone number id (idn_... or phn_...) to retrieve or modify. |
| primary | — | — | Whether this should be the user's primary phone number. |
| reserved_for_second_factor | — | — | Whether to reserve this number for multi-factor authentication. |
| verified | — | — | Whether the phone number should be marked verified. |
| Name | Type | Req | Description |
|---|---|---|---|
| phone_number | — | — | Updated Clerk phone number object from the Backend API. |
No examples provided.
clerk.update_user ~137
Update profile fields for a Clerk user. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated user summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| external_id | — | — | Optional external id for the user. |
| first_name | — | — | Optional first name. |
| last_name | — | — | Optional last name. |
| user_id | string | yes | Clerk user id (user_...) to update. |
| username | — | — | Optional username. |
| Name | Type | Req | Description |
|---|---|---|---|
| user | — | — | Updated Clerk user summary. |
No examples provided.
clerk.update_user_metadata ~165
Merge metadata fields for a Clerk user. Only the provided metadata keys are updated. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated user summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| private_metadata | — | — | Private metadata fields to merge. Existing keys not listed are preserved. |
| public_metadata | — | — | Public metadata fields to merge. Existing keys not listed are preserved. |
| unsafe_metadata | — | — | Unsafe metadata fields to merge. Existing keys not listed are preserved. |
| user_id | string | yes | Clerk user id (user_...) whose metadata to update. |
| Name | Type | Req | Description |
|---|---|---|---|
| user | — | — | Updated Clerk user object after the metadata merge. |
No examples provided.
clerk.upload_oauth_application_logo ~161
Upload or replace the logo image for an OAuth application in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated OAuth application summary. Cost = 8 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| file_name | string | yes | Stored file name from files.list_uploaded_files. Upload with files.upload_file first. |
| oauth_application_id | string | yes | Clerk OAuth application id (oa_...) to retrieve, update, or delete. |
| uploader_user_id | — | — | Clerk user id (user_...) credited with the image upload. |
| Name | Type | Req | Description |
|---|---|---|---|
| oauth_application | — | — | OAuth application summary with updated client_image_url. |
No examples provided.
clerk.verify_organization_domain_ownership ~125
Mark an organization domain's DNS ownership as verified via manual override. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Idempotent when ownership is already verified. Returns the updated domain summary. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| clerk_instance_id | — | — | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
| domain_id | string | yes | Clerk organization domain id (dmn_...) to update, delete, or verify. |
| Name | Type | Req | Description |
|---|---|---|---|
| domain | — | — | Organization domain summary after ownership verification. |
No examples provided.
domains.check_availability ~76
Check domain name availability for up to ten domains in one request. Returns a JSON object whose keys are the requested domain names and whose values are booleans: true if the domain appears available, false if it is taken. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| domains | array | yes | Domain names to check (maximum 10). |
Structured output declared, but exposes no named fields.
No examples provided.
domains.dns_records ~121
Fetch DNS records for a domain. Returns an array of records. Each record includes name, ttl, type (for example A, AAAA, CNAME, MX, NS, SOA, TXT), and data (record value). Optionally pass subdomain to include records for a host under the domain (for example blog for blog.example.com). Cost = 2 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| domain | string | yes | Domain name to look up (for example example.com). |
| subdomain | — | — | Optional subdomain label to include (for example www or blog). |
| Name | Type | Req | Description |
|---|---|---|---|
| records | — | — | DNS records returned for the domain. |
No examples provided.
domains.list_tlds ~209
List or search top-level domains (TLDs) with registry metadata. Filter by substring search, availability phase, TLD category, and paginate with limit and page. limit defaults to 100 when omitted. Each result includes the TLD suffix, type, availability phase, WHOIS server, domain counts when known, registry organization details, and created/changed timestamps. availability values: general-availability (open for normal registration) or sunrise (trademark sunrise period before general availability). Cost = 2 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| availability | — | — | Filter by registration phase: general-availability (normal public registration) or sunrise (early trademark-holder period). |
| limit | — | — | Maximum number of TLDs to return. Defaults to 100 when omitted. |
| page | — | — | Page number for paginated results. |
| search | — | — | Return TLDs whose suffix contains this substring. |
| tld_type | — | — | Filter by TLD category: country-code, generic, generic-restricted, infrastructure, or sponsored. |
| Name | Type | Req | Description |
|---|---|---|---|
| tlds | — | — | Matching top-level domain records. |
No examples provided.
domains.lookup ~107
Look up a domain and return normalized registration details. Combines registry and registrar RDAP and WHOIS sources to return the most accurate normalized fields across TLDs: availability, domain status, created/updated/expiry dates, registrar data, contact records, and nameservers. Use this when you need registrant-oriented summary data rather than raw WHOIS or RDAP payloads. Cost = 5 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| domain | string | yes | Domain name to look up (for example example.com). |
| Name | Type | Req | Description |
|---|---|---|---|
| availability | — | — | Availability state (for example registered or available). |
| contacts | — | — | Registrant, admin, tech, and billing contact records. |
| dates | — | — | Registration lifecycle dates. |
| domain | — | — | Looked-up domain name. |
| keyword | — | — | Second-level domain label without the TLD. |
| nameservers | — | — | Authoritative nameserver host names. |
| registrar | — | — | Registrar summary data. |
| source | — | — | Primary data source used for the normalized response. |
| status | — | — | Normalized EPP status codes. |
| tld | — | — | Top-level domain suffix. |
No examples provided.
domains.metrics ~128
Analyze a domain with comprehensive SEO metrics, backlink data, and social signals. Returns authority metrics (Moz domain/page authority, Ahrefs domain rating, Majestic trust and citation flow), backlink profile counts (total backlinks, referring domains, EDU/GOV links), traffic and keyword estimates (organic traffic, traffic value, organic keywords, Ahrefs rank), social signals (Facebook shares/comments, Pinterest pins, StumbleUpon), and technical data (IP addresses, subnets, topical trust flow categories). Cost = 40 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| domain | string | yes | Domain name to analyze (for example example.com). |
| Name | Type | Req | Description |
|---|---|---|---|
| FB_comments | — | — | Total Facebook comments. |
| FB_shares | — | — | Total Facebook shares. |
| ahrefsBacklinks | — | — | Total number of backlinks from Ahrefs. |
| ahrefsDR | — | — | Ahrefs domain rating (0-100). |
| ahrefsOrganicKeywords | — | — | Number of ranking organic keywords. |
| ahrefsRank | — | — | Global website ranking from Ahrefs. |
| ahrefsRefDomains | — | — | Number of unique referring domains from Ahrefs. |
| ahrefsTraffic | — | — | Estimated monthly organic traffic. |
| ahrefsTrafficValue | — | — | Estimated value of organic traffic. |
| domain | — | — | Analyzed domain name. |
| last_updated | — | — | When the metrics snapshot was last updated. |
| majesticCF | — | — | Majestic citation flow score (0-100). |
| majesticLinks | — | — | Total links from the Majestic database. |
| majesticTF | — | — | Majestic trust flow score (0-100). |
| mozDA | — | — | Moz domain authority score (0-100). |
| mozPA | — | — | Moz page authority score (0-100). |
| pinterest_pins | — | — | Total Pinterest saves. |
| stumbles | — | — | Total StumbleUpon shares. |
No examples provided.
domains.rdap ~79
Look up raw RDAP (Registration Data Access Protocol) data for a domain. Returns registrar entities, domain status codes, registration and expiration events, nameservers, DNSSEC delegation data, RDAP conformance labels, and registry notices. Cost = 3 tokens.
| Name | Type | Req | Description |
|---|---|---|---|
| domain | string | yes | Domain name to look up (for example example.com). |
| Name | Type | Req | Description |
|---|---|---|---|
| entities | — | — | Registrar, registrant, and related RDAP entities. |
| events | — | — | Registration, expiration, and last-changed timestamps. |
| ldhName | — | — | Domain name in LDH form. |
| nameservers | — | — | Authoritative nameservers for the domain. |
| objectClassName | — | — | RDAP object class (for example domain). |
| secureDNS | — | — | DNSSEC delegation and DS record data. |
| status | — | — | EPP status codes for the domain. |
No examples provided.
domains.tld_details ~106
Look up detailed registry information for a single top-level domain (TLD). Returns status, TLD type, availability phase, WHOIS and RDAP servers, registry URL, domain counts, delegation dates, registry organization, administrative/technical contacts, and remarks. Pass the TLD suffix without a leading dot (for example io or com). Cost = 1 token.
| Name | Type | Req | Description |
|---|---|---|---|
| tld | string | yes | TLD suffix to look up without a leading dot (for example io). |
| Name | Type | Req | Description |
|---|---|---|---|
| availability | — | — | Registration phase for the TLD. |
| changed | — | — | TLD record last changed timestamp. |
| contacts | — | — | Registry contact records. |
| created | — | — | TLD delegation created timestamp. |
| domains_count | — | — | Approximate registered domain count when reported by the registry. |
| level | — | — | TLD level (1 for standard TLDs). |
| organization | — | — | Registry operator contact details. |
| rdap_server | — | — | Authoritative RDAP server URL. |
| registry_url | — | — | Registry web site URL. |
| remarks | — | — | Additional registry notes or links. |
| status | — | — | Delegation status (for example ACTIVE). |
| tld | — | — | TLD suffix without a leading dot. |
| type | — | — | TLD category (for example country-code or generic). |
| whois_server | — | — | Authoritative WHOIS server host name. |
No examples provided.