Dedicated IPs

Manage dedicated IP inventory, authorization, deletion, and domain assignments. The examples use A2A code mode. MCP exposes the same code mode through its execute tool.

Functions

dedicated_ips.addresses.enabled

dedicated_ips.addresses.enabled(account_id: str, dedicated_ip_id: str, enabled: bool, ip_address: str) -> DedicatedIP
Set dedicated IP address enablement.
PropertyValuePropertyValue
Requires permissionproxy.createAuth requiredyes
Execution modesyncCapabilityproxy.create
Resource typeaccountResource ID fieldaccount_id
Public API routePATCH /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}/ip-addresses/enabled
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
dedicated_ip_idstryesDedicated IP UUID from the route path
enabledboolyesWhether this address should be used for DNS and traffic
ip_addressstryesAssigned IPv4 or IPv6 address to update
FieldTypeRequiredDescription
dedicated_ip_idstryes
enabledboolyes
ip_addressstryes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "dedicated_ips.addresses.enabled(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", enabled=true, ip_address=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {
      "dedicated_ip_id": "<string>",
      "enabled": true,
      "ip_address": "<string>"
    }
  },
  "responses": [
    {
      "index": 0,
      "function": "dedicated_ips.addresses.enabled",
      "status": "completed",
      "result": {
        "dedicated_ip_id": "<string>",
        "enabled": true,
        "ip_address": "<string>"
      }
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "dedicated_ips.addresses.enabled(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", enabled=true, ip_address=\"<string>\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {\n      \"dedicated_ip_id\": \"<string>\",\n      \"enabled\": true,\n      \"ip_address\": \"<string>\"\n    }\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"dedicated_ips.addresses.enabled\",\n      \"status\": \"completed\",\n      \"result\": {\n        \"dedicated_ip_id\": \"<string>\",\n        \"enabled\": true,\n        \"ip_address\": \"<string>\"\n      }\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

dedicated_ips.authorize

dedicated_ips.authorize(account_id: str, dedicated_ip_id: str, reissue?: bool) -> DedicatedIP
Authorize dedicated ips.
PropertyValuePropertyValue
Requires permissionproxy.authorizeAuth requiredyes
Execution modesyncCapabilityproxy.authorize
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}/authorize
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
dedicated_ip_idstryesDedicated IP UUID from the route path
reissueboolnoForce reissue of setup key even if one exists
FieldTypeRequiredDescription
idstryesDedicated IP UUID
namestryesCustomer-visible dedicated IP name
statusstryesProvisioning or lifecycle status
typestryesDedicated IP allocation type
asnint | nullnoAutonomous system number for the allocation
country_codestr | nullnoISO country code for the allocation
created_atstr | nullnoCreation timestamp
ip_addresses[{"ip": str, "enabled"?: bool, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}]noPublic addresses in this allocation
updated_atstr | nullnoLast update timestamp
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "dedicated_ips.authorize(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", reissue=true)"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "dedicated_ips.authorize",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "dedicated_ips.authorize(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", reissue=true)"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"dedicated_ips.authorize\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

dedicated_ips.claim

dedicated_ips.claim(account_id: str) -> DedicatedIP
Claim dedicated ips.
PropertyValuePropertyValue
Requires permissionproxy.createAuth requiredyes
Execution modesyncCapabilityproxy.create
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/dedicated-ips/claim
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
payload{}yesRequest for automatically claiming a managed dedicated IP.
FieldTypeRequiredDescription
idstryesDedicated IP UUID
namestryesCustomer-visible dedicated IP name
statusstryesProvisioning or lifecycle status
typestryesDedicated IP allocation type
asnint | nullnoAutonomous system number for the allocation
country_codestr | nullnoISO country code for the allocation
created_atstr | nullnoCreation timestamp
ip_addresses[{"ip": str, "enabled"?: bool, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}]noPublic addresses in this allocation
updated_atstr | nullnoLast update timestamp
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "dedicated_ips.claim(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "dedicated_ips.claim",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "dedicated_ips.claim(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"dedicated_ips.claim\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

dedicated_ips.delete

dedicated_ips.delete(account_id: str, dedicated_ip_id: str, force?: bool) -> DedicatedIP
Delete dedicated ips.
PropertyValuePropertyValue
Requires permissionproxy.deleteAuth requiredyes
Execution modesyncCapabilityproxy.delete
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
dedicated_ip_idstryesDedicated IP UUID from the route path
forceboolnoForce removal when the dedicated IP has assignments
FieldTypeRequiredDescription
dedicated_ip_idstryes
domain_ids[str]yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "dedicated_ips.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", force=true)"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {
      "dedicated_ip_id": "<string>",
      "domain_ids": [
        "<string>"
      ]
    }
  },
  "responses": [
    {
      "index": 0,
      "function": "dedicated_ips.delete",
      "status": "completed",
      "result": {
        "dedicated_ip_id": "<string>",
        "domain_ids": [
          "<string>"
        ]
      }
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "dedicated_ips.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", force=true)"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {\n      \"dedicated_ip_id\": \"<string>\",\n      \"domain_ids\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"dedicated_ips.delete\",\n      \"status\": \"completed\",\n      \"result\": {\n        \"dedicated_ip_id\": \"<string>\",\n        \"domain_ids\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

dedicated_ips.domains.assign

dedicated_ips.domains.assign(account_id: str, dedicated_ip_id: str, domain_ids?: [str]) -> DedicatedIP
Assign domains.
PropertyValuePropertyValue
Requires permissiondomain.proxy.assignAuth requiredyes
Execution modesyncCapabilitydomain.proxy.assign
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}/domains/assign
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
dedicated_ip_idstryesDedicated IP UUID from the route path
domain_ids[str]noDomain UUIDs or domain names to assign or unassign.
FieldTypeRequiredDescription
dedicated_ip_idstryes
domain_ids[str]yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "dedicated_ips.domains.assign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {
      "dedicated_ip_id": "<string>",
      "domain_ids": [
        "<string>"
      ]
    }
  },
  "responses": [
    {
      "index": 0,
      "function": "dedicated_ips.domains.assign",
      "status": "completed",
      "result": {
        "dedicated_ip_id": "<string>",
        "domain_ids": [
          "<string>"
        ]
      }
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "dedicated_ips.domains.assign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {\n      \"dedicated_ip_id\": \"<string>\",\n      \"domain_ids\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"dedicated_ips.domains.assign\",\n      \"status\": \"completed\",\n      \"result\": {\n        \"dedicated_ip_id\": \"<string>\",\n        \"domain_ids\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

dedicated_ips.domains.unassign

dedicated_ips.domains.unassign(account_id: str, dedicated_ip_id: str, domain_ids?: [str]) -> DedicatedIP
Unassign domains.
PropertyValuePropertyValue
Requires permissiondomain.proxy.assignAuth requiredyes
Execution modesyncCapabilitydomain.proxy.assign
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}/domains/unassign
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
dedicated_ip_idstryesDedicated IP UUID from the route path
domain_ids[str]noDomain UUIDs or domain names to assign or unassign.
FieldTypeRequiredDescription
dedicated_ip_idstryes
domain_ids[str]yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "dedicated_ips.domains.unassign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {
      "dedicated_ip_id": "<string>",
      "domain_ids": [
        "<string>"
      ]
    }
  },
  "responses": [
    {
      "index": 0,
      "function": "dedicated_ips.domains.unassign",
      "status": "completed",
      "result": {
        "dedicated_ip_id": "<string>",
        "domain_ids": [
          "<string>"
        ]
      }
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "dedicated_ips.domains.unassign(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain_ids=\"example.com\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {\n      \"dedicated_ip_id\": \"<string>\",\n      \"domain_ids\": [\n        \"<string>\"\n      ]\n    }\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"dedicated_ips.domains.unassign\",\n      \"status\": \"completed\",\n      \"result\": {\n        \"dedicated_ip_id\": \"<string>\",\n        \"domain_ids\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

dedicated_ips.get

dedicated_ips.get(account_id: str, dedicated_ip_id: str) -> DedicatedIP
Get dedicated ips.
PropertyValuePropertyValue
Requires permissionproxy.viewAuth requiredyes
Execution modesyncCapabilityproxy.view
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
dedicated_ip_idstryesDedicated IP UUID from the route path
FieldTypeRequiredDescription
idstryesDedicated IP UUID
namestryesCustomer-visible dedicated IP name
statusstryesProvisioning or lifecycle status
typestryesDedicated IP allocation type
asnint | nullnoAutonomous system number for the allocation
country_codestr | nullnoISO country code for the allocation
created_atstr | nullnoCreation timestamp
ip_addresses[{"ip": str, "enabled"?: bool, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}]noPublic addresses in this allocation
updated_atstr | nullnoLast update timestamp
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "dedicated_ips.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "dedicated_ips.get",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "dedicated_ips.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", dedicated_ip_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"dedicated_ips.get\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

dedicated_ips.list

dedicated_ips.list(account_id: str, page?: int, page_size?: int) -> Page[DedicatedIP]
List dedicated ips.
PropertyValuePropertyValue
Requires permissionproxy.viewAuth requiredyes
Execution modesyncCapabilityproxy.view
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/dedicated-ips
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
pageintnoOne-based dedicated IP page number
page_sizeintnoMaximum dedicated IPs per page
FieldTypeRequiredDescription
items[{"id": str, "name": str, "status": str, "type": str, "asn"?: int | null, "country_code"?: str | null, "created_at"?: str | null, "ip_addresses"?: [{"ip": str, "enabled"?: bool, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}], "updated_at"?: str | null}]yesDedicated IPs on this page
pageintyesCurrent one-based page number
page_sizeintyesMaximum items per page
totalintyesTotal matching dedicated IPs
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "dedicated_ips.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "dedicated_ips.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "dedicated_ips.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"dedicated_ips.list\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}