Documentation Index Fetch the complete documentation index at: https://hybridbox.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
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.authorizededicated_ips.authorize(account_id: str, dedicated_ip_id: str, reissue?: bool) -> DedicatedIP
Authorize dedicated ips.
Property Value Property Value Requires permission proxy.authorizeAuth required yesExecution mode syncCapability proxy.authorizeResource type accountResource ID field account_idPublic API route POST /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}/authorize
Name Type Required Description account_idstryes Account UUID from the route path dedicated_ip_idstryes Dedicated IP UUID from the route path reissueboolno Force reissue of setup key even if one exists
Field Type Required Description idstryes Dedicated IP UUID namestryes Customer-visible dedicated IP name statusstryes Provisioning or lifecycle status typestryes Dedicated IP allocation type asnint | nullno Autonomous system number for the allocation country_codestr | nullno ISO country code for the allocation created_atstr | nullno Creation timestamp ip_addresses[{"ip": str, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}]no Public addresses in this allocation updated_atstr | nullno Last 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.available_optionsdedicated_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.createAuth required yesExecution mode syncCapability proxy.createResource type accountResource ID field account_idPublic API route GET /v1/public/accounts/{account_id}/dedicated-ips/available-options
Name Type Required Description account_idstryes Account UUID from the route path asnstr | nullno Filter inventory options by ASN country_codestr | nullno Filter inventory options by ISO country code
Field Type Required Description idstryes Inventory option UUID namestryes Customer-visible inventory option name asnint | nullno Autonomous system number for the option country_codestr | nullno 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
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 }
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.claimdedicated_ips.claim(account_id: str, option_id?: str | null) -> DedicatedIP
Claim dedicated ips.
Property Value Property Value Requires permission proxy.createAuth required yesExecution mode syncCapability proxy.createResource type accountResource ID field account_idPublic API route POST /v1/public/accounts/{account_id}/dedicated-ips/claim
Name Type Required Description account_idstryes Account UUID from the route path option_idstr | nullno
Field Type Required Description idstryes Dedicated IP UUID namestryes Customer-visible dedicated IP name statusstryes Provisioning or lifecycle status typestryes Dedicated IP allocation type asnint | nullno Autonomous system number for the allocation country_codestr | nullno ISO country code for the allocation created_atstr | nullno Creation timestamp ip_addresses[{"ip": str, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}]no Public addresses in this allocation updated_atstr | nullno Last update timestamp
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 }
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.deletededicated_ips.delete(account_id: str, dedicated_ip_id: str, force?: bool) -> DedicatedIP
Delete dedicated ips.
Property Value Property Value Requires permission proxy.deleteAuth required yesExecution mode syncCapability proxy.deleteResource type accountResource ID field account_idPublic API route DELETE /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}
Name Type Required Description account_idstryes Account UUID from the route path dedicated_ip_idstryes Dedicated IP UUID from the route path forceboolno Force removal when the dedicated IP has assignments
Field Type Required Description 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.assigndedicated_ips.domains.assign(account_id: str, dedicated_ip_id: str, domain_ids?: [str]) -> DedicatedIP
Assign domains.
Property Value Property Value Requires permission domain.proxy.assignAuth required yesExecution mode syncCapability domain.proxy.assignResource type accountResource ID field account_idPublic API route POST /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}/domains/assign
Name Type Required Description account_idstryes Account UUID from the route path dedicated_ip_idstryes Dedicated IP UUID from the route path domain_ids[str]no Domain UUIDs or domain names to assign or unassign.
Field Type Required Description 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.unassigndedicated_ips.domains.unassign(account_id: str, dedicated_ip_id: str, domain_ids?: [str]) -> DedicatedIP
Unassign domains.
Property Value Property Value Requires permission domain.proxy.assignAuth required yesExecution mode syncCapability domain.proxy.assignResource type accountResource ID field account_idPublic API route POST /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}/domains/unassign
Name Type Required Description account_idstryes Account UUID from the route path dedicated_ip_idstryes Dedicated IP UUID from the route path domain_ids[str]no Domain UUIDs or domain names to assign or unassign.
Field Type Required Description 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.getdedicated_ips.get(account_id: str, dedicated_ip_id: str) -> DedicatedIP
Get dedicated ips.
Property Value Property Value Requires permission proxy.viewAuth required yesExecution mode syncCapability proxy.viewResource type accountResource ID field account_idPublic API route GET /v1/public/accounts/{account_id}/dedicated-ips/{dedicated_ip_id}
Name Type Required Description account_idstryes Account UUID from the route path dedicated_ip_idstryes Dedicated IP UUID from the route path
Field Type Required Description idstryes Dedicated IP UUID namestryes Customer-visible dedicated IP name statusstryes Provisioning or lifecycle status typestryes Dedicated IP allocation type asnint | nullno Autonomous system number for the allocation country_codestr | nullno ISO country code for the allocation created_atstr | nullno Creation timestamp ip_addresses[{"ip": str, "fcrdns_confirmed"?: bool, "healthy"?: bool | null, "rdns"?: str | null}]no Public addresses in this allocation updated_atstr | nullno Last 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.listdedicated_ips.list(account_id: str, page?: int, page_size?: int) -> Page[DedicatedIP]
List dedicated ips.
Property Value Property Value Requires permission proxy.viewAuth required yesExecution mode syncCapability proxy.viewResource type accountResource ID field account_idPublic API route GET /v1/public/accounts/{account_id}/dedicated-ips
Name Type Required Description account_idstryes Account UUID from the route path pageintno One-based dedicated IP page number page_sizeintno Maximum dedicated IPs per page
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 pageintyes Current one-based page number page_sizeintyes Maximum items per page totalintyes Total 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 } }
