arcade-mcp/toolkits/vercel_api/arcade_vercel_api/wrapper_tools/UpdateApexDomain.json

{
  "name": "UpdateApexDomain",
  "fully_qualified_name": "VercelApi.UpdateApexDomain@0.1.0",
  "description": "Update or move the apex domain configuration.\n\nThis tool updates or moves the apex domain configuration. It is not used for updating auto-renew or nameservers, for which separate endpoints should be used.",
  "toolkit": {
    "name": "ArcadeVercelApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "apex_domain_name",
        "required": true,
        "description": "The apex domain to update or move. Accepts a string value representing the domain name (e.g., 'example.com').",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "domain"
      },
      {
        "name": "domain_update_details",
        "required": true,
        "description": "A JSON object detailing the specific updates or moves for the apex domain configuration.",
        "value_schema": {
          "val_type": "json",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "requestBody"
      },
      {
        "name": "team_identifier",
        "required": false,
        "description": "The unique identifier for the team to perform the domain update on behalf of. This allows the request to be associated with a specific team.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The Team identifier to perform the request on behalf of."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "teamId"
      },
      {
        "name": "team_slug",
        "required": false,
        "description": "The slug identifying the Team on whose behalf the request is made.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The Team slug to perform the request on behalf of."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "slug"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'patchDomain'.",
    "available_modes": [
      "value",
      "error",
      "null"
    ],
    "value_schema": {
      "val_type": "json",
      "inner_val_type": null,
      "enum": null,
      "properties": null,
      "inner_properties": null,
      "description": null
    }
  },
  "requirements": {
    "authorization": null,
    "secrets": [
      {
        "key": "VERCEL_ACCESS_TOKEN"
      }
    ],
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.1.0",
    "description": "Tools that enable LLMs to interact directly with the vercel API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.2.0",
      "description": ""
    },
    "url": "https://api.vercel.com/v3/domains/{domain}",
    "http_method": "PATCH",
    "headers": {
      "Content-Type": "application/json"
    },
    "parameters": [
      {
        "name": "teamId",
        "tool_parameter_name": "team_identifier",
        "description": "The Team identifier to perform the request on behalf of.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The Team identifier to perform the request on behalf of."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "slug",
        "tool_parameter_name": "team_slug",
        "description": "The Team slug to perform the request on behalf of.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The Team slug to perform the request on behalf of."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "domain",
        "tool_parameter_name": "apex_domain_name",
        "description": "",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "requestBody",
        "tool_parameter_name": "domain_update_details",
        "description": "",
        "value_schema": {
          "val_type": "json",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "accepted_as": "body",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "VERCEL_ACCESS_TOKEN",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "",
        "is_auth_token": false
      }
    ],
    "request_body_spec": "{\n  \"content\": {\n    \"application/json\": {\n      \"schema\": {\n        \"oneOf\": [\n          {\n            \"type\": \"object\",\n            \"description\": \"update\",\n            \"additionalProperties\": false,\n            \"properties\": {\n              \"op\": {\n                \"example\": \"update\",\n                \"type\": \"string\"\n              },\n              \"renew\": {\n                \"description\": \"This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/auto-renew instead.\",\n                \"type\": \"boolean\",\n                \"deprecated\": true\n              },\n              \"customNameservers\": {\n                \"description\": \"This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/nameservers instead.\",\n                \"items\": {\n                  \"type\": \"string\"\n                },\n                \"maxItems\": 4,\n                \"minItems\": 0,\n                \"type\": \"array\",\n                \"uniqueItems\": true,\n                \"deprecated\": true\n              },\n              \"zone\": {\n                \"description\": \"Specifies whether this is a DNS zone that intends to use Vercel's nameservers.\",\n                \"type\": \"boolean\"\n              }\n            }\n          },\n          {\n            \"type\": \"object\",\n            \"description\": \"move-out\",\n            \"additionalProperties\": false,\n            \"properties\": {\n              \"op\": {\n                \"example\": \"move-out\",\n                \"type\": \"string\"\n              },\n              \"destination\": {\n                \"description\": \"User or team to move domain to\",\n                \"type\": \"string\"\n              }\n            }\n          }\n        ]\n      }\n    }\n  },\n  \"required\": true\n}",
    "use_request_body_schema_mode": true,
    "validate_request_body_schema": true
  }
}