Dedicated IPs

Manage dedicated IP inventory, authorization, deletion, and domain assignments.

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.authorize

dedicated_ips.authorize(account_id: str, dedicated_ip_id: str, reissue?: bool) -> DedicatedIP

Authorize dedicated ips.

Property	Value	Property	Value
Requires permission	proxy.authorize	Auth required	yes
Execution mode	sync	Capability	proxy.authorize
Resource type	account	Resource ID field	account_id
Public API route	POST /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}/authorize

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
dedicated_ip_id	str	yes	Dedicated IP UUID from the route path
reissue	bool	no	Force reissue of setup key even if one exists

Returns

Field	Type	Required	Description
id	str	yes	Dedicated IP UUID
name	str	yes	Customer-visible dedicated IP name
status	str	yes	Provisioning or lifecycle status
type	str	yes	Dedicated IP allocation type
asn	int | null	no	Autonomous system number for the allocation
country_code	str | null	no	ISO country code for the allocation
created_at	str | null	no	Creation timestamp
ip_addresses	[{"ip": str, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}]	no	Public addresses in this allocation
updated_at	str | null	no	Last update timestamp

A2A example

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
}

MCP example

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.available_options

dedicated_ips.available_options(account_id: str, asn?: str | null, country_code?: str | null) -> list[DedicatedIP]

List available dedicated ips.

Property	Value	Property	Value
Requires permission	proxy.create	Auth required	yes
Execution mode	sync	Capability	proxy.create
Resource type	account	Resource ID field	account_id
Public API route	GET /v1/public/accounts/{account_id}/dedicated-ips/available-options

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
asn	str | null	no	Filter inventory options by ASN
country_code	str | null	no	Filter inventory options by ISO country code

Returns

Field	Type	Required	Description
id	str	yes	Inventory option UUID
name	str	yes	Customer-visible inventory option name
asn	int | null	no	Autonomous system number for the option
country_code	str | null	no	ISO country code for the option
ip_addresses	[{"ip": str, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}]	no	Public addresses included in this option

A2A example

Request:

{
  "request_id": "example",
  "session_id": "session_123",
  "code": "dedicated_ips.available_options(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", asn=\"<string>\", country_code=\"<string>\")"
}

Response:

{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "dedicated_ips.available_options",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}

MCP example

Request:

{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "dedicated_ips.available_options(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", asn=\"<string>\", country_code=\"<string>\")"
    }
  }
}

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.available_options\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

dedicated_ips.claim

dedicated_ips.claim(account_id: str, option_id?: str | null) -> DedicatedIP

Claim dedicated ips.

Property	Value	Property	Value
Requires permission	proxy.create	Auth required	yes
Execution mode	sync	Capability	proxy.create
Resource type	account	Resource ID field	account_id
Public API route	POST /v1/public/accounts/{account_id}/dedicated-ips/claim

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
option_id	str | null	no

Returns

Field	Type	Required	Description
id	str	yes	Dedicated IP UUID
name	str	yes	Customer-visible dedicated IP name
status	str	yes	Provisioning or lifecycle status
type	str	yes	Dedicated IP allocation type
asn	int | null	no	Autonomous system number for the allocation
country_code	str | null	no	ISO country code for the allocation
created_at	str | null	no	Creation timestamp
ip_addresses	[{"ip": str, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}]	no	Public addresses in this allocation
updated_at	str | null	no	Last update timestamp

A2A example

Request:

{
  "request_id": "example",
  "session_id": "session_123",
  "code": "dedicated_ips.claim(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", option_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
}

MCP example

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\", option_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.

Property	Value	Property	Value
Requires permission	proxy.delete	Auth required	yes
Execution mode	sync	Capability	proxy.delete
Resource type	account	Resource ID field	account_id
Public API route	DELETE /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
dedicated_ip_id	str	yes	Dedicated IP UUID from the route path
force	bool	no	Force removal when the dedicated IP has assignments

Returns

Field	Type	Required	Description
dedicated_ip_id	str	yes
domain_ids	[str]	yes

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	domain.proxy.assign	Auth required	yes
Execution mode	sync	Capability	domain.proxy.assign
Resource type	account	Resource ID field	account_id
Public API route	POST /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}/domains/assign

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
dedicated_ip_id	str	yes	Dedicated IP UUID from the route path
domain_ids	[str]	no	Domain UUIDs or domain names to assign or unassign.

Returns

Field	Type	Required	Description
dedicated_ip_id	str	yes
domain_ids	[str]	yes

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	domain.proxy.assign	Auth required	yes
Execution mode	sync	Capability	domain.proxy.assign
Resource type	account	Resource ID field	account_id
Public API route	POST /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}/domains/unassign

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
dedicated_ip_id	str	yes	Dedicated IP UUID from the route path
domain_ids	[str]	no	Domain UUIDs or domain names to assign or unassign.

Returns

Field	Type	Required	Description
dedicated_ip_id	str	yes
domain_ids	[str]	yes

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	proxy.view	Auth required	yes
Execution mode	sync	Capability	proxy.view
Resource type	account	Resource ID field	account_id
Public API route	GET /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
dedicated_ip_id	str	yes	Dedicated IP UUID from the route path

Returns

Field	Type	Required	Description
id	str	yes	Dedicated IP UUID
name	str	yes	Customer-visible dedicated IP name
status	str	yes	Provisioning or lifecycle status
type	str	yes	Dedicated IP allocation type
asn	int | null	no	Autonomous system number for the allocation
country_code	str | null	no	ISO country code for the allocation
created_at	str | null	no	Creation timestamp
ip_addresses	[{"ip": str, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}]	no	Public addresses in this allocation
updated_at	str | null	no	Last update timestamp

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	proxy.view	Auth required	yes
Execution mode	sync	Capability	proxy.view
Resource type	account	Resource ID field	account_id
Public API route	GET /v1/public/accounts/{account_id}/dedicated-ips

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
page	int	no	One-based dedicated IP page number
page_size	int	no	Maximum dedicated IPs per page

Returns

Field	Type	Required	Description
items	[{"id": str, "name": str, "status": str, "type": str, "asn"?: int | null, "country_code"?: str | null, "created_at"?: str | null, "ip_addresses"?: [{"ip": str, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}], "updated_at"?: str | null}]	yes	Dedicated IPs on this page
page	int	yes	Current one-based page number
page_size	int	yes	Maximum items per page
total	int	yes	Total matching dedicated IPs

A2A example

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
}

MCP example

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
  }
}