Infoblox Bloxone Ddi

the infoblox bloxone ddi connector streamlines network management by automating ddi operations and integrating them into security workflows infoblox bloxone ddi is a cloud managed network services platform that simplifies and automates critical network tasks this connector enables seamless integration with infoblox bloxone ddi, allowing users to automate ip address management, dns, and dhcp services by leveraging this integration, security teams can enhance network visibility, reduce manual tasks, and strengthen their security posture within the swimlane turbine platform prerequisites to effectively utilize the infoblox bloxone ddi connector within the swimlane platform, ensure you have the following prerequisites api key authentication with the following parameters url endpoint for the infoblox bloxone ddi api service api key unique identifier to authenticate requests to the infoblox bloxone ddi api capabilities this infoblox bloxone ddi connector has following capabilities address create ip address delete ip address get ip address get list ip addresses update ip address address block allocate address block next available ip address copy address block create address block create next available address block create next available subnet for address block delete address block get address block next available ip address get address block get list address blocks get list of address block ancestors get list of next available address blocks get list of next available subnet update address block asm get asm by id get list of asm update asm dns usage get dns usage by id get list of dns usage fingerprint create dhcp fingerprint delete dhcp fingerprint get a dhcp fingerprint get list of dhcp fingerprints update dhcp fingerprint fingerprint class get list of dhcp fingerprint classes get dhcp fingerprint class global lease get globallease get global lease by id update global lease ipam host create ipam host delete ipam host by id get ipam host by id get list of ipam host update ipam host ip space copy ip space bulk copy copy ip space create ip space delete ip space get ip space by id get list of ip spaces update ip space lease get list of dhcp leases lease command create lease command range allocate range next available ip address create range delete range get list of ranges get range next available ip address get range update range subnet allocate subnet next available ip address copy subnet create subnet delete subnet get list of subnet ancestors get list of subnets get subnet next available ip address get subnet update subnet system fingerprint get dhcp system fingerprint get list of dhcp system fingerprints notes https //csp infoblox com/apidoc/?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc configurations infoblox api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required apikey api key string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions allocate address block next available ip address allocates the next available ip from a specified address block in infoblox bloxone ddi using the 'address block id' endpoint url /api/ddi/v1/ipam/address block/{{address block id}}/nextavailableip method post input argument name type required description path parameters address block id string required address block id input example {"path parameters" {"address block id" "fdb56d82 1dd6 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results space string result of the operation results address string result of the operation results protocol string result of the operation results comment string result of the operation results parent string result of the operation results range object result of the operation results interface string result of the operation results state string result of the operation results usage array result of the operation results dhcp info object result of the operation results names array name of the resource results names file name string name of the resource results names file string name of the resource results host object result of the operation results hwaddr string result of the operation results tags object result of the operation results created at string result of the operation results updated at string result of the operation results discovery attrs object result of the operation results discovery metadata object response data results disable dhcp boolean result of the operation output example {"results" \[{"id" "12345678 1234 1234 1234 123456789abc","space" "string","address" "string","protocol" "string","comment" "string","parent" "string","range" {},"interface" "string","state" "string","usage" \[],"dhcp info" {},"names" \[],"host" {},"hwaddr" "string","tags" {}}]} allocate range next available ip address allocates the next available ip address within a specified range in infoblox bloxone ddi using the range id endpoint url /api/ddi/v1/ipam/range/{{range id}}/nextavailableip method post input argument name type required description path parameters range id string required range id input example {"path parameters" {"range id" "b8d8af38 1d88 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results space string result of the operation results address string result of the operation results protocol string result of the operation results comment string result of the operation results parent string result of the operation results range string result of the operation results interface string result of the operation results state string result of the operation results usage array result of the operation results dhcp info object result of the operation results names array name of the resource results names file name string name of the resource results names file string name of the resource results host object result of the operation results hwaddr string result of the operation results tags object result of the operation results created at string result of the operation results updated at string result of the operation results discovery attrs object result of the operation results discovery metadata object response data results disable dhcp boolean result of the operation output example {"results" \[{"id" "12345678 1234 1234 1234 123456789abc","space" "string","address" "string","protocol" "string","comment" "string","parent" "string","range" "string","interface" "string","state" "string","usage" \[],"dhcp info" {},"names" \[],"host" {},"hwaddr" "string","tags" {}}]} allocate subnet next available ip address allocates the next available ip address within a specified subnet in infoblox bloxone ddi using the subnet id endpoint url /api/ddi/v1/ipam/subnet/{{subnet id}}/nextavailableip method post input argument name type required description path parameters subnet id string required subnet id input example {"path parameters" {"subnet id" "4b96eb17 00c8 11ef af8c 82dcd2cac46c"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results space string result of the operation results address string result of the operation results protocol string result of the operation results comment string result of the operation results parent string result of the operation results range object result of the operation results interface string result of the operation results state string result of the operation results usage array result of the operation results dhcp info object result of the operation results names array name of the resource results names file name string name of the resource results names file string name of the resource results host object result of the operation results hwaddr string result of the operation results tags object result of the operation results created at string result of the operation results updated at string result of the operation results discovery attrs object result of the operation results discovery metadata object response data results disable dhcp boolean result of the operation output example {"status code" 200,"response headers" {"date" "tue, 28 may 2024 06 46 31 gmt","content type" "application/json","content length" "553","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}]}} copy address block creates a duplicate of an addressblock object within infoblox bloxone ddi for streamlined ip address management endpoint url /api/ddi/v1/ipam/address block/{{address block id}}/copy method post input argument name type required description path parameters address block id string optional address block id comment string optional the description for the copied address block may contain 0 to 1024 characters can include utf 8 copy dhcp options boolean optional indicates whether dhcp options should be copied or not when ipam/address block object is copied name string optional the name for the copied address block may contain 1 to 256 characters can include utf 8 recursive boolean optional indicate whether child objects should be copied or not skip on error boolean optional indicates whether copying should skip object in case of error and continue with next, or abort copying in case of error space string optional the resource identifier input example {"json body" {"comment" "string","copy dhcp options"\ true,"name" "string","recursive"\ true,"skip on error"\ true,"space" "ipam/ip space/2ec8e03c d27c 11ee 9595 e6ac2ebb2f62"},"path parameters" {"address block id" "2d1bbb08 00c8 11ef 8c72 d2db0cedb6eb"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result description string result of the operation result id string unique identifier result job id string unique identifier output example {"result" {"description" "string","id" "12345678 1234 1234 1234 123456789abc","job id" "string"}} copy ip space copy an ipspace object the ipspace object represents an entire address space endpoint url /api/ddi/v1/ipam/ip space/{{ip space id}}/copy method post input argument name type required description path parameters ip space id string required ip space id comment string optional the description for the copied ip space may contain 0 to 1024 characters can include utf 8 copy dhcp options boolean optional indicates whether dhcp options should be copied or not when ipam/ip space object is copied name string optional the name for the copied ip space must contain 1 to 256 characters can include utf 8 skip on error boolean optional indicates whether copying should skip an object in case of error and continue with next, or abort copying in case of error input example {"json body" {"comment" "comment","copy dhcp options"\ false,"name" "test copy space 2","skip on error"\ false},"path parameters" {"ip space id" "2ec8e03c d27c 11ee 9595 e6ac2ebb2f62"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result description string result of the operation result id string unique identifier result job id string unique identifier output example {"status code" 200,"response headers" {"date" "mon, 10 jun 2024 07 43 59 gmt","content type" "application/json","content length" "212","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"description" "ip space jeantest","id" "ipam/ip space/2ec8e03c d27c 11ee 9595 e6ac2ebb2f62","job id" "blox0 ipam operation ivmfiurvguytcmrrgiys2njrgfqs2nbxgjsc2odbmmzc copy ip space bulk copy bulk copy addressblock and subnet objects from one ip space object to another ipspace object endpoint url /api/ddi/v1/ipam/ip space/bulk copy method post input argument name type required description copy dhcp options boolean optional indicates whether dhcp options for ipv4 should be copied or not when objects (ipam/address block and ipam/subnet only) are copied copy objects array optional the resource identifier recursive boolean optional indicates whether child objects should be copied or not skip on error boolean optional indicates whether copying should skip object in case of error and continue with next, or abort copying in case of error target string optional the resource identifier input example {"json body" {"copy dhcp options"\ true,"copy objects" \["ipam/subnet/4b96eb17 00c8 11ef af8c 82dcd2cac46c"],"recursive"\ true,"skip on error"\ true,"target" "ipam/ip space/4fbd578f 1668 11ef 88ae 02b76caeb543"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results job id string unique identifier results id string unique identifier results description string result of the operation errors array error message if any errors file name string name of the resource errors file string error message if any output example {"status code" 200,"response headers" {"date" "mon, 10 jun 2024 09 55 02 gmt","content type" "application/json","content length" "226","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}],"errors" \[]}} copy subnet creates a duplicate of a specified subnet object within infoblox bloxone ddi, requiring the subnet id and space for execution endpoint url /api/ddi/v1/ipam/subnet/{{subnet id}}/copy method post input argument name type required description path parameters subnet id string required subnet id comment string optional the description for the copied subnet may contain 0 to 1024 characters can include utf 8 copy dhcp options boolean optional indicates whether dhcp options should be copied or not when ipam/subnet object is copied name string optional the name for the copied subnet may contain 1 to 256 characters can include utf 8 recursive boolean optional indicates whether child objects should be copied or not skip on error boolean optional indicates whether copying should skip object in case of error and continue with next, or abort copying in case of error space string optional the resource identifier input example {"json body" {"comment" "subnet copy","copy dhcp options"\ false,"name" "test subnet copy 1","recursive"\ false,"skip on error"\ false,"space" "ipam/ip space/8ae90580 d1d1 11ee b311 4225b3276a4c"},"path parameters" {"subnet id" "79aecbe4 1b57 11ef 8447 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result description string result of the operation result id string unique identifier result job id string unique identifier output example {"status code" 200,"response headers" {"date" "tue, 28 may 2024 06 27 13 gmt","content type" "application/json","content length" "214","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"description" "subnet 192 168 1 0/32","id" "ipam/subnet/79aecbe4 1b57 11ef 8447 2ad8f1f3d115","job id" "blox0 ipam operation ivmfiutggy2wimlggzrc2zrvg42s2nbsmjss2yjqgu create address block generates an addressblock object in infoblox bloxone ddi, enabling address space management and supporting administrative functions endpoint url /api/ddi/v1/ipam/address block method post input argument name type required description address string optional the address field in form “a b c d/n” where the “/n” may be omitted in this case, the cidr value must be defined in the cidr field when reading, the address field is always in the form “a b c d” asm config object optional the asmconfig object represents automated scope management configuration asm config asm threshold number optional asm shows the number of addresses forecast to be used forecast period days in the future, if it is greater than asm threshold percent dhcp total (see dhcp utilization) then the subnet is flagged asm config enable boolean optional indicates if automated scope management is enabled asm config enable notification boolean optional indicates if asm should send notifications to the user asm config forecast period number optional the forecast period in days asm config growth factor number optional indicates the growth in the number or percentage of ip addresses asm config growth type string optional the type of factor to use are percent or count asm config history number optional the minimum amount of history needed before asm can run on this subnet asm config min total number optional the minimum size of range needed for asm to run on this subnet asm config min unused number optional the minimum percentage of addresses that must be available outside of the dhcp ranges and fixed addresses when making a suggested change asm config reenable date string optional date value cidr number optional the cidr of the address block this is required, if address does not specify it in its input maximum is 128 and minimum is 1 comment string optional the description for the address block may contain 0 to 1024 characters can include utf 8 compartment id string optional reserved for future use ddns client update string optional controls who does the ddns updates ddns conflict resolution mode string optional the mode used for resolving conflicts while performing ddns updates ddns domain string optional the domain suffix for ddns updates fqdn, may be empty ddns generate name boolean optional indicates if ddns needs to generate a hostname when not supplied by the client ddns generated prefix string optional the prefix used in the generation of an fqdn when generating a name, dhcp server will construct the name in the format is \[ddns generated prefix] \[address text] \[ddns qualifying suffix] where address text is simply the lease ip address converted to a hyphenated string ddns send updates boolean optional determines if ddns updates are enabled at the address block level ddns ttl percent number optional ddns ttl value to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage it is specified as a percentage (e g 25, 75) ddns update on renew boolean optional instructs the dhcp server to always update the dns information when a lease is renewed even if its dns information has not changed ddns use conflict resolution boolean optional when true, dhcp server will apply conflict resolution, as described in rfc 4703, when attempting to fulfill the update request when false, dhcp server will simply attempt to update the dns entries per the request, regardless of whether or not they conflict with existing entries owned by other dhcp4 clients dhcp config object optional a dhcp config object (dhcp/dhcp config) represents a shared dhcp configuration that controls how leases are issued input example {"address" "string","asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"cidr" 123,"comment" "string","compartment id" "string","ddns client update" "client","ddns conflict resolution mode" "check with dhcid","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "myhost","ddns send updates"\ true,"ddns ttl percent" 123,"ddns update on renew"\ true,"ddns use conflict resolution"\ true,"dhcp config" {"abandoned reclaim time" 123,"abandoned reclaim time v6" 123,"allow unknown"\ true,"allow unknown v6"\ true,"echo client id"\ true,"filters" \["string"],"filters large selection" \["string"],"filters v6" \["string"],"ignore client uid"\ true,"ignore list" \[{"type" "string","value" "string"}],"lease time" 123,"lease time v6" 123},"dhcp options" \[{"group" "string","option code" "string","option value" "string","type" "string"}],"discovery attrs" {},"discovery metadata" {},"federated realms" \["string"],"header option filename" "example name","header option server address" "string","header option server name" "example name","hostname rewrite char" "example name","hostname rewrite enabled"\ true,"hostname rewrite regex" "example name","inheritance parent" "string","inheritance sources" {"asm config" {"asm enable block" {"action" "string","source" "string","value" {}},"asm growth block" {"action" "inherit","source" "string","value" {}},"asm threshold" {"action" "inherit","source" "string"},"forecast period" {"action" "inherit","source" "string"},"history" {"action" "inherit","source" "string"},"min total" {"action" "inherit","source" "string"},"min unused" {"action" "inherit","source" "string"}},"ddns client update" {"action" "inherit","source" "string"},"ddns conflict resolution mode" {"action" "inherit","source" "string"},"ddns enabled" {"action" "inherit","source" "string"},"ddns hostname block" {"action" "inherit","source" "string","value" {"ddns generate name"\ true,"ddns generated prefix" "string"}},"ddns ttl percent" {"action" "inherit","source" "string"},"ddns update block" {"action" "inherit","source" "string","value" {"ddns domain" "string","ddns send updates"\ true}},"ddns update on renew" {"action" "inherit","source" "string"},"ddns use conflict resolution" {"action" "inherit","source" "string"},"dhcp config" {"abandoned reclaim time" {"action" "inherit","source" "string"},"abandoned reclaim time v6" {"action" "inherit","source" "string"},"allow unknown" {"action" "inherit","source" "string"},"allow unknown v6" {"action" "inherit","source" "string"},"echo client id" {"action" "inherit","source" "string"},"filters" {"action" "inherit","source" "string","value" \["string"]},"filters v6" {"action" "inherit","source" "string","value" \["string"]},"ignore client uid" {"action" "inherit","source" "string"},"ignore list" {"action" "inherit","source" "string"},"lease time" {"action" "inherit","source" "string"},"lease time v6" {"action" "inherit","source" "string"}},"dhcp options" {"action" "inherit","value" \[{"action" "inherit","source" "string","value" {}}]},"header option filename" {"action" "inherit","source" "string"},"header option server address" {"action" "inherit","source" "string"},"header option server name" {"action" "inherit","source" "string"},"hostname rewrite block" {"action" "inherit","source" "string","value" {"hostname rewrite char" "example name","hostname rewrite enabled"\ true,"hostname rewrite regex" "example name"}}},"name" "example name","parent" "string","space" "string","tags" {},"threshold" {"enabled"\ true,"high" 123,"low" 123},"utilization v6" {"abandoned" {"raw value" "string"},"dynamic" {"raw value" "string"},"static" {"raw value" "string"},"total" {"raw value" "string"},"used" {"raw value" "string"}}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result address string result of the operation result asm config object result of the operation result asm config asm threshold number result of the operation result asm config enable boolean result of the operation result asm config enable notification boolean result of the operation result asm config forecast period number result of the operation result asm config growth factor number result of the operation result asm config growth type string type of the resource result asm config history number result of the operation result asm config min total number result of the operation result asm config min unused number result of the operation result asm config reenable date string result of the operation result asm scope flag number result of the operation result cidr number unique identifier result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result ddns client update string result of the operation result ddns conflict resolution mode string result of the operation result ddns domain string result of the operation result ddns generate name boolean name of the resource result ddns generated prefix string result of the operation output example {"result" {"address" "string","asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns create dhcp fingerprint creates a dhcp fingerprint object in infoblox bloxone ddi with specified rules for client identification endpoint url /api/ddi/v1/dhcp/fingerprint method post input argument name type required description class string optional dhcp fingerprint class id comment string optional the description for the dhcp fingerprint may contain 0 to 1024 characters can include utf 8 inheritance sources object optional the inheritance configuration specifies how share fingerprint is inherited inheritance sources share fingerprint object optional the inheritance configuration for a field of type bool inheritance sources share fingerprint action string optional the inheritance setting for a field valid values are inherit,override inherit use the inherited value override use the value set in the object inheritance sources share fingerprint source string optional the resource identifier name string optional the name of the dhcp fingerprint must contain 1 to 256 characters can include utf 8 precedence number optional integer (1 n) defining priority order of dhcp fingerprints; smaller means higher precedence maximum is 2147483647 rules array optional the collection of fingerprint rules for the dhcp fingerprint a fingerprintrule object (dhcp/fingerprint rule) represents a dhcp fingerprint rule a lease matches a fingerprint rule if all of the sub rules evaluate to true if a sub rule doesn’t include a value (it has been left empty) it evaluates to true rules prl array optional the value to use to match the parameter request list option (option 55) a string of intergers rules prefix string optional the value to use to match the first three bytes of the hardware address rules vendor string optional the value to use to match the vendor class id option (option 60) rules vendor compare string optional the operation to use when matching the vendor class id share fingerprint boolean optional indicates if the dhcp fingerprint should be shared with infoblox this is only applicable for custom fingerprints defaults to true for custom fingerprints tags object optional the tags for the dhcp fingerprint in json format input example {"json body" {"class" "dhcp/fingerprint class/0acf3996 6f31 47b6 8c57 4666df9743b2","comment" "cool","inheritance sources" {"share fingerprint" {"action" "inherit","source" "string"}},"name" "testing fingerprint 1 2","precedence" 1,"rules" \[{"prl" \["1","3","6","42","12","15","31","33","43"],"prefix" "","vendor" "0acf3996 6f31 47b6 8c57 4666df9743b2","vendor compare" "equals"}],"share fingerprint"\ true,"tags" {}}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result class string result of the operation result comment string result of the operation result created at string result of the operation result defined by string result of the operation result id string unique identifier result inheritance sources object result of the operation result name string name of the resource result precedence number result of the operation result rules array result of the operation result rules file name string name of the resource result rules file string result of the operation result share fingerprint boolean result of the operation result tags object result of the operation result updated at string result of the operation output example {"status code" 200,"response headers" {"date" "mon, 20 may 2024 05 42 13 gmt","content type" "application/json","content length" "392","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"class" "dhcp/fingerprint class/0acf3996 6f31 47b6 8c57 4666df9743b2","comment" "","created at" "2024 05 20t05 42 13 167635567z","defined by" "user","id" "dhcp/fingerprin create ip address creates an address object in infoblox bloxone ddi, representing a single ip within a specified space requires 'address' and 'space' parameters endpoint url /api/ddi/v1/ipam/address method post input argument name type required description address string optional the address in form "a b c d" comment string optional the description for the address object may contain 0 to 1024 characters can include utf 8 discovery attrs object optional the discovery attributes for this address in json format discovery metadata object optional the discovery metadata for this address in json format host string optional the resource identifier hwaddr string optional the hardware address associated with this ip address interface string optional the name of the network interface card (nic) associated with the address, if any names array optional the list of all names associated with this address names name string required the name expressed as a single label or fqdn names type string required the origin of the name parent string optional the resource identifier range string optional the resource identifier tags object optional parameter for create ip address space string optional the resource identifier input example {"json body" {"address" "192 168 1 0","comment" "string","discovery attrs" {},"discovery metadata" {},"host" "string","hwaddr" "string","interface" "string","names" \[{"name" "string","type" "string"}],"parent" "string","range" "string","tags" {},"space" "ipam/ip space/2ec8e03c d27c 11ee 9595 e6ac2ebb2f62"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result address string result of the operation result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result dhcp info object result of the operation result disable dhcp boolean result of the operation result discovery attrs object result of the operation result discovery metadata object response data result host object result of the operation result hwaddr string result of the operation result id string unique identifier result interface string result of the operation result names array name of the resource result names file name string name of the resource result names file string name of the resource result parent string result of the operation result protocol string result of the operation result range object result of the operation result space string result of the operation result state string result of the operation result tags object result of the operation result updated at string result of the operation output example {"result" {"address" "string","comment" "string","compartment id" "string","created at" "string","dhcp info" {},"disable dhcp"\ true,"discovery attrs" {},"discovery metadata" {},"host" {},"hwaddr" "string","id" "12345678 1234 1234 1234 123456789abc","interface" "string","names" \[{}],"parent" "string","protocol" "string"}} create ip space create an ipspace object the ipspace object represents an entire address space endpoint url /api/ddi/v1/ipam/ip space method post input argument name type required description asm config object optional the asmconfig object represents automated scope management configuration asm config asm threshold number optional asm shows the number of addresses forecast to be used forecast period days in the future, if it is greater than asm threshold percent dhcp total (see dhcp utilization) then the subnet is flagged asm config enable boolean optional indicates if automated scope management is enabled asm config enable notification boolean optional indicates if asm should send notifications to the user asm config forecast period number optional the forecast period in days asm config growth factor number optional indicates the growth in the number or percentage of ip addresses asm config growth type string optional the type of factor to use are percent or count asm config history number optional the minimum amount of history needed before asm can run on this subnet asm config min total number optional the minimum size of range needed for asm to run on this subnet asm config min unused number optional the minimum percentage of addresses that must be available outside of the dhcp ranges and fixed addresses when making a suggested change asm config reenable date string optional date value comment string optional the description for the ip space may contain 0 to 1024 characters can include utf 8 compartment id string optional reserved for future use ddns client update string optional controls who does the ddns updates ddns conflict resolution mode string optional the mode used for resolving conflicts while performing ddns updates ddns domain string optional the domain suffix for ddns updates fqdn, may be empty ddns generate name boolean optional indicates if ddns needs to generate a hostname when not supplied by the client ddns generated prefix string optional the prefix used in the generation of an fqdn when generating a name, dhcp server will construct the name in the format is \[ddns generated prefix] \[address text] \[ddns qualifying suffix] where address text is simply the lease ip address converted to a hyphenated string ddns send updates boolean optional determines if ddns updates are enabled at the ip space level ddns ttl percent number optional ddns ttl value to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage it is specified as a percentage (e g 25, 75) ddns update on renew boolean optional instructs the dhcp server to always update the dns information when a lease is renewed even if its dns information has not changed ddns use conflict resolution boolean optional when true, dhcp server will apply conflict resolution, as described in rfc 4703, when attempting to fulfill the update request when false, dhcp server will simply attempt to update the dns entries per the request, regardless of whether or not they conflict with existing entries owned by other dhcp4 clients default realms array optional reserved for future use dhcp config object optional a dhcp config object (dhcp/dhcp config) represents a shared dhcp configuration that controls how leases are issued dhcp config abandoned reclaim time number optional the abandoned reclaim time in seconds for ipv4 clients input example {"asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"comment" "string","compartment id" "string","ddns client update" "client","ddns conflict resolution mode" "check with dhcid","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "myhost","ddns send updates"\ true,"ddns ttl percent" 123,"ddns update on renew"\ true,"ddns use conflict resolution"\ true,"default realms" \["string"],"dhcp config" {"abandoned reclaim time" 123,"abandoned reclaim time v6" 123,"allow unknown"\ true,"allow unknown v6"\ true,"echo client id"\ true,"filters" \["string"],"filters large selection" \["string"],"filters v6" \["string"],"ignore client uid"\ true,"ignore list" \[{"type" "string","value" "string"}],"lease time" 123,"lease time v6" 123},"dhcp options" \[{"group" "string","option code" "string","option value" "string","type" "string"}],"dhcp options v6" \[{"group" "string","option code" "string","option value" "string","type" "string"}],"header option filename" "example name","header option server address" "string","header option server name" "example name","hostname rewrite char" "example name","hostname rewrite enabled"\ true,"hostname rewrite regex" "example name","inheritance parent" "string","inheritance sources" {"asm config" {"asm enable block" {"action" "string","source" "string","value" {}},"asm growth block" {"action" "inherit","source" "string","value" {}},"asm threshold" {"action" "inherit","source" "string"},"forecast period" {"action" "inherit","source" "string"},"history" {"action" "inherit","source" "string"},"min total" {"action" "inherit","source" "string"},"min unused" {"action" "inherit","source" "string"}},"ddns client update" {"action" "inherit","source" "string"},"ddns conflict resolution mode" {"action" "inherit","source" "string"},"ddns enabled" {"action" "inherit","source" "string"},"ddns hostname block" {"action" "inherit","source" "string","value" {"ddns generate name"\ true,"ddns generated prefix" "string"}},"ddns ttl percent" {"action" "inherit","source" "string"},"ddns update block" {"action" "inherit","source" "string","value" {"ddns domain" "string","ddns send updates"\ true}},"ddns update on renew" {"action" "inherit","source" "string"},"ddns use conflict resolution" {"action" "inherit","source" "string"},"dhcp config" {"abandoned reclaim time" {"action" "inherit","source" "string"},"abandoned reclaim time v6" {"action" "inherit","source" "string"},"allow unknown" {"action" "inherit","source" "string"},"allow unknown v6" {"action" "inherit","source" "string"},"echo client id" {"action" "inherit","source" "string"},"filters" {"action" "inherit","source" "string","value" \["string"]},"filters v6" {"action" "inherit","source" "string","value" \["string"]},"ignore client uid" {"action" "inherit","source" "string"},"ignore list" {"action" "inherit","source" "string"},"lease time" {"action" "inherit","source" "string"},"lease time v6" {"action" "inherit","source" "string"}},"dhcp options" {"action" "inherit","value" \[{"action" "inherit","source" "string","value" {}}]},"dhcp options v6" {"action" "inherit","value" \[{"action" "inherit","source" "string","value" {}}]},"header option filename" {"action" "inherit","source" "string"},"header option server address" {"action" "inherit","source" "string"},"header option server name" {"action" "inherit","source" "string"},"hostname rewrite block" {"action" "inherit","source" "string","value" {"hostname rewrite char" "example name","hostname rewrite enabled"\ true,"hostname rewrite regex" "example name"}},"vendor specific option option space" {"action" "inherit","source" "string","value" "string"}},"name" "example name","tags" {},"threshold" {"enabled"\ true,"high" 123,"low" 123},"utilization v6" {"abandoned" {"raw value" "string"},"dynamic" {"raw value" "string"},"static" {"raw value" "string"},"total" {"raw value" "string"},"used" {"raw value" "string"}},"vendor specific option option space" "string"} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result asm config object result of the operation result asm config asm threshold number result of the operation result asm config enable boolean result of the operation result asm config enable notification boolean result of the operation result asm config forecast period number result of the operation result asm config growth factor number result of the operation result asm config growth type string type of the resource result asm config history number result of the operation result asm config min total number result of the operation result asm config min unused number result of the operation result asm config reenable date string result of the operation result asm scope flag number result of the operation result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result ddns client update string result of the operation result ddns conflict resolution mode string result of the operation result ddns domain string result of the operation result ddns generate name boolean name of the resource result ddns generated prefix string result of the operation result ddns send updates boolean result of the operation result ddns ttl percent number result of the operation output example {"result" {"asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"asm scope flag" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns send updates"\ true,"ddns ttl create ipam host create an ipamhost object the ipamhost object (ipam/host) represents any network connected equipment that is assigned one or more ip addresses endpoint url /api/ddi/v1/ipam/host method post input argument name type required description addresses array optional the list of all addresses associated with the ipam host, which may be in different ip spaces addresses address string required field usage depends on the operation addresses ref string required the resource identifier addresses space string required the resource identifier auto generate records boolean optional this flag specifies if resource records have to be auto generated for the host comment string optional the description for the ipam host may contain 0 to 1024 characters can include utf 8 host names array optional the name records to be generated for the host host names alias boolean optional when true, the name is treated as an alias host names name string required a name for the host host names primary name boolean optional when true, the name field is treated as primary name host names zone string required the resource identifier name string optional the name of the ipam host must contain 1 to 256 characters can include utf 8 tags object optional the tags for the ipam host in json format input example {"json body" {"addresses" \[{"address" "address","ref" "ipam/ip space/a8d3f3dc 1d7f 11ef 8de7 2ad8f1f3d115","space" "ipam/ip space/a8d3f3dc 1d7f 11ef 8de7 2ad8f1f3d115"}],"auto generate records"\ true,"comment" "commented","host names" \[{"alias"\ true,"name" "string","primary name"\ true,"zone" "ipam/host/a8d3f3dc 1d7f 11ef 8de7 2ad8f1f3d115"}],"name" "test ipam host 1 5","tags" {}}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result addresses array result of the operation result addresses file name string name of the resource result addresses file string result of the operation result auto generate records boolean result of the operation result comment string result of the operation result created at string result of the operation result host names array name of the resource result host names file name string name of the resource result host names file string name of the resource result id string unique identifier result name string name of the resource result tags object result of the operation result updated at string result of the operation output example {"status code" 200,"response headers" {"date" "fri, 07 jun 2024 06 54 19 gmt","content type" "application/json","content length" "270","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"addresses" \[],"auto generate records"\ false,"comment" "","created at" "2024 06 07t06 54 19 107977510z","host names" \[],"id" "ipam/host/c33fb6e8 249a 11ef 9448 02b8a458f3 create lease command executes a specified command on a dhcp lease within infoblox bloxone ddi, requiring an address, command, and space endpoint url /api/ddi/v1/dhcp/lease command method post input argument name type required description address string optional the ip address for the dhcp lease in the format “a b c d” within the ip space specified by space field command string optional the command to perform on the lease valid values clear and resend ddns clear means removes the lease defined by (space, address) from the dhcp server(s) this will not affect the client that issued the lease resend ddns means resends a request to kea dhcp ddns to update dns for an existing lease defined by (space, address) space string optional parameter for create lease command input example {"json body" {"address" "string","command" "string","space" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase success string whether the operation was successful output example {"status code" 200,"response headers" {"date" "sun, 19 may 2024 16 41 46 gmt","content type" "application/json","content length" "773","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"success" "string"}} create next available address block allocates a new ipam address block from available resources in infoblox bloxone ddi using the specified address block id endpoint url /api/ddi/v1/ipam/address block/{{address block id}}/nextavailableaddressblock method post input argument name type required description path parameters address block id string required address block id input example {"path parameters" {"address block id" "fdb56d82 1dd6 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results address string result of the operation results asm config object result of the operation results asm config asm threshold number result of the operation results asm config enable boolean result of the operation results asm config enable notification boolean result of the operation results asm config forecast period number result of the operation results asm config growth factor number result of the operation results asm config growth type string type of the resource results asm config history number result of the operation results asm config min total number result of the operation results asm config min unused number result of the operation results asm config reenable date string result of the operation results asm scope flag number result of the operation results cidr number unique identifier results comment string result of the operation results compartment id string unique identifier results created at string result of the operation results ddns client update string result of the operation results ddns conflict resolution mode string result of the operation results ddns domain string result of the operation results ddns generate name boolean name of the resource results ddns generated prefix string result of the operation output example {"results" \[{"address" "string","asm config" {},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns send updates"\ true,"ddns ttl percent" 123,"ddns update on renew"\ true}]} create next available subnet for address block allocates a new ipam/subnet resource from available subnets within a specified address block in infoblox bloxone ddi endpoint url /api/ddi/v1/ipam/address block/{{address block id}}/nextavailablesubnet method post input argument name type required description path parameters address block id string required address block id input example {"path parameters" {"address block id" "fdb56d82 1dd6 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results address string result of the operation results asm config object result of the operation results asm config asm threshold number result of the operation results asm config enable boolean result of the operation results asm config enable notification boolean result of the operation results asm config forecast period number result of the operation results asm config growth factor number result of the operation results asm config growth type string type of the resource results asm config history number result of the operation results asm config min total number result of the operation results asm config min unused number result of the operation results asm config reenable date string result of the operation results asm scope flag number result of the operation results cidr number unique identifier results comment string result of the operation results compartment id string unique identifier results created at string result of the operation results ddns client update string result of the operation results ddns conflict resolution mode string result of the operation results ddns domain string result of the operation results ddns generate name boolean name of the resource results ddns generated prefix string result of the operation output example {"results" \[{"address" "string","asm config" {},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns send updates"\ true,"ddns ttl percent" 123,"ddns update on renew"\ true}]} create range creates a contiguous range of ip addresses within a specified ip space in infoblox bloxone ddi, defined by start and end parameters endpoint url /api/ddi/v1/ipam/range method post input argument name type required description comment string optional the description for the range may contain 0 to 1024 characters can include utf 8 dhcp host string optional the resource identifier dhcp options array optional an item (dhcp/option item) in a list of dhcp options may be either a specific option or a group of options dhcp options group string optional the resource identifier dhcp options option code string optional the resource identifier dhcp options option value string optional the option value dhcp options type string optional the type of item disable dhcp boolean optional a disabled object is effectively non existent when generating configuration end string optional the end ip address of the range exclusion ranges array optional the exclusionrange object represents an exclusion range inside a dhcp range exclusion ranges comment string optional the description for the exclusion range may contain 0 to 1024 characters can include utf 8 exclusion ranges end string required the end address of the exclusion range exclusion ranges start string required the start address of the exclusion range filters array optional the accessfilter object represents an allow/deny filter for a dhcp range filters access string optional the access type of dhcp filter (allow or deny) filters hardware filter id string optional the resource identifier filters option filter id string optional the resource identifier inheritance parent string optional the resource identifier inheritance sources object optional the inheritance configuration that specifies how the dhcp options field is inherited from the parent object inheritance sources dhcp options object optional the inheritance configuration for a field that contains list of optionitem inheritance sources dhcp options action string optional the inheritance setting inheritance sources dhcp options value array optional the inherited dhcp option values inheritance sources dhcp options value action string optional the inheritance setting inheritance sources dhcp options value source string optional the resource identifier inheritance sources dhcp options value value object optional a wrapper of item (dhcp/option item) in a list of inherited dhcp options it contains extra fields not covered by optionitem input example {"comment" "string","dhcp host" "string","dhcp options" \[{"group" "string","option code" "string","option value" "string","type" "string"}],"disable dhcp"\ true,"end" "string","exclusion ranges" \[{"comment" "string","end" "string","start" "string"}],"filters" \[{"access" "allow","hardware filter id" "string","option filter id" "string"}],"inheritance parent" "string","inheritance sources" {"dhcp options" {"action" "inherit","value" \[{"action" "inherit","source" "string","value" {}}]}},"name" "example name","parent" "string","space" "string","start" "string","tags" {},"threshold" {"enabled"\ true,"high" 123,"low" 123},"utilization v6" {"abandoned" {"raw value" "string"},"dynamic" {"raw value" "string"},"static" {"raw value" "string"},"total" {"raw value" "string"},"used" {"raw value" "string"}}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result dhcp host object result of the operation result dhcp options array result of the operation result dhcp options file name string name of the resource result dhcp options file string result of the operation result disable dhcp boolean result of the operation result end string result of the operation result exclusion ranges array result of the operation result exclusion ranges file name string name of the resource result exclusion ranges file string result of the operation result filters array result of the operation result filters file name string name of the resource result filters file string result of the operation result id string unique identifier result inheritance assigned hosts array result of the operation result inheritance assigned hosts file name string name of the resource result inheritance assigned hosts file string result of the operation result inheritance parent string result of the operation result inheritance sources object result of the operation result name string name of the resource output example {"result" {"comment" "string","compartment id" "string","created at" "string","dhcp host" {},"dhcp options" \[{}],"disable dhcp"\ true,"end" "string","exclusion ranges" \[{}],"filters" \[{}],"id" "12345678 1234 1234 1234 123456789abc","inheritance assigned hosts" \[{}],"inheritance parent" "string","inheritance sources" {},"name" "example name","parent" "string"}} create subnet generates a new subnet object in infoblox bloxone ddi using specified address and space parameters endpoint url /api/ddi/v1/ipam/subnet method post input argument name type required description address string optional the address of the subnet in the form “a b c d/n” where the “/n” may be omitted in this case, the cidr value must be defined in the cidr field when reading, the address field is always in the form “a b c d” asm config object optional the asmconfig object represents automated scope management configuration asm config asm threshold number optional asm shows the number of addresses forecast to be used forecast period days in the future, if it is greater than asm threshold percent dhcp total (see dhcp utilization) then the subnet is flagged asm config enable boolean optional indicates if automated scope management is enabled asm config enable notification boolean optional indicates if asm should send notifications to the user asm config forecast period number optional the forecast period in days asm config growth factor number optional indicates the growth in the number or percentage of ip addresses asm config growth type string optional the type of factor to use are percent or count asm config history number optional the minimum amount of history needed before asm can run on this subnet asm config min total number optional the minimum size of range needed for asm to run on this subnet asm config min unused number optional the minimum percentage of addresses that must be available outside of the dhcp ranges and fixed addresses when making a suggested change asm config reenable date string optional date value cidr number optional the cidr of the subnet this is required, if address does not specify it in its input maximum is 128 and minimum is 1 comment string optional the description for the subnet may contain 0 to 1024 characters can include utf 8 compartment id string optional reserved for future use ddns client update string optional controls who does the ddns updates ddns conflict resolution mode string optional the mode used for resolving conflicts while performing ddns updates ddns domain string optional the domain suffix for ddns updates fqdn, may be empty ddns generate name boolean optional indicates if ddns needs to generate a hostname when not supplied by the client ddns generated prefix string optional the prefix used in the generation of an fqdn when generating a name, dhcp server will construct the name in the format is \[ddns generated prefix] \[address text] \[ddns qualifying suffix] where address text is simply the lease ip address converted to a hyphenated string ddns send updates boolean optional determines if ddns updates are enabled at the subnet level ddns ttl percent number optional ddns ttl value to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage it is specified as a percentage (e g 25, 75) ddns update on renew boolean optional instructs the dhcp server to always update the dns information when a lease is renewed even if its dns information has not changed ddns use conflict resolution boolean optional when true, dhcp server will apply conflict resolution, as described in rfc 4703, when attempting to fulfill the update request when false, dhcp server will simply attempt to update the dns entries per the request, regardless of whether or not they conflict with existing entries owned by other dhcp4 clients dhcp config object optional a dhcp config object (dhcp/dhcp config) represents a shared dhcp configuration that controls how leases are issued input example {"address" "string","asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"cidr" 123,"comment" "string","compartment id" "string","ddns client update" "client","ddns conflict resolution mode" "check with dhcid","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "myhost","ddns send updates"\ true,"ddns ttl percent" 123,"ddns update on renew"\ true,"ddns use conflict resolution"\ true,"dhcp config" {"abandoned reclaim time" 123,"abandoned reclaim time v6" 123,"allow unknown"\ true,"allow unknown v6"\ true,"echo client id"\ true,"filters" \["string"],"filters large selection" \["string"],"filters v6" \["string"],"ignore client uid"\ true,"ignore list" \[{"type" "string","value" "string"}],"lease time" 123,"lease time v6" 123},"dhcp options" \[{"group" "string","option code" "string","option value" "string","type" "string"}],"discovery attrs" {},"discovery metadata" {},"federated realms" \["string"],"header option filename" "example name","header option server address" "string","header option server name" "example name","hostname rewrite char" "example name","hostname rewrite enabled"\ true,"hostname rewrite regex" "example name","inheritance parent" "string","inheritance sources" {"asm config" {"asm enable block" {"action" "string","source" "string","value" {}},"asm growth block" {"action" "inherit","source" "string","value" {}},"asm threshold" {"action" "inherit","source" "string"},"forecast period" {"action" "inherit","source" "string"},"history" {"action" "inherit","source" "string"},"min total" {"action" "inherit","source" "string"},"min unused" {"action" "inherit","source" "string"}},"ddns client update" {"action" "inherit","source" "string"},"ddns conflict resolution mode" {"action" "inherit","source" "string"},"ddns enabled" {"action" "inherit","source" "string"},"ddns hostname block" {"action" "inherit","source" "string","value" {"ddns generate name"\ true,"ddns generated prefix" "string"}},"ddns ttl percent" {"action" "inherit","source" "string"},"ddns update block" {"action" "inherit","source" "string","value" {"ddns domain" "string","ddns send updates"\ true}},"ddns update on renew" {"action" "inherit","source" "string"},"ddns use conflict resolution" {"action" "inherit","source" "string"},"dhcp config" {"abandoned reclaim time" {"action" "inherit","source" "string"},"abandoned reclaim time v6" {"action" "inherit","source" "string"},"allow unknown" {"action" "inherit","source" "string"},"allow unknown v6" {"action" "inherit","source" "string"},"echo client id" {"action" "inherit","source" "string"},"filters" {"action" "inherit","source" "string","value" \["string"]},"filters v6" {"action" "inherit","source" "string","value" \["string"]},"ignore client uid" {"action" "inherit","source" "string"},"ignore list" {"action" "inherit","source" "string"},"lease time" {"action" "inherit","source" "string"},"lease time v6" {"action" "inherit","source" "string"}},"dhcp options" {"action" "inherit","value" \[{"action" "inherit","source" "string","value" {}}]},"header option filename" {"action" "inherit","source" "string"},"header option server address" {"action" "inherit","source" "string"},"header option server name" {"action" "inherit","source" "string"},"hostname rewrite block" {"action" "inherit","source" "string","value" {"hostname rewrite char" "example name","hostname rewrite enabled"\ true,"hostname rewrite regex" "example name"}}},"name" "example name","parent" "string","rebind time" 123,"renew time" 123,"space" "string","tags" {},"threshold" {"enabled"\ true,"high" 123,"low" 123},"utilization v6" {"abandoned" {"raw value" "string"},"dynamic" {"raw value" "string"},"static" {"raw value" "string"},"total" {"raw value" "string"},"used" {"raw value" "string"}}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result address string result of the operation result asm config object result of the operation result asm config asm threshold number result of the operation result asm config enable boolean result of the operation result asm config enable notification boolean result of the operation result asm config forecast period number result of the operation result asm config growth factor number result of the operation result asm config growth type string type of the resource result asm config history number result of the operation result asm config min total number result of the operation result asm config min unused number result of the operation result asm config reenable date string result of the operation result asm scope flag number result of the operation result cidr number unique identifier result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result ddns client update string result of the operation result ddns conflict resolution mode string result of the operation result ddns domain string result of the operation result ddns generate name boolean name of the resource result ddns generated prefix string result of the operation output example {"result" {"address" "string","asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns delete address block moves an addressblock object to the recycle bin in infoblox bloxone ddi, requiring the address block id as a path parameter endpoint url /api/ddi/v1/ipam/address block/{{address block id}} method delete input argument name type required description path parameters address block id string required address block id input example {"path parameters" {"address block id" "73f7dc78 1c07 11ef a128 beacc4e9494e"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"date" "fri, 31 may 2024 04 22 25 gmt","content type" "application/json","content length" "2","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {}} delete dhcp fingerprint moves the specified dhcp fingerprint to the recycle bin in infoblox bloxone ddi using the fingerprint id endpoint url /api/ddi/v1/dhcp/fingerprint/{{fingerprint id}} method delete input argument name type required description path parameters fingerprint id string required fingerprint id input example {"path parameters" {"fingerprint id" "10837136 166a 11ef 8c5e 7e4e2209b4ae"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"date" "mon, 20 may 2024 06 36 41 gmt","content type" "application/json","content length" "2","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {}} delete ip address moves a specified ip address to the recycle bin in infoblox bloxone ddi using the address id endpoint url /api/ddi/v1/ipam/address/{{address id}} method delete input argument name type required description path parameters address id string required address id input example {"path parameters" {"address id" "a44c65fa 1b4c 11ef 8447 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"date" "sun, 26 may 2024 14 50 41 gmt","content type" "application/json","content length" "2","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {}} delete ip space move an ipspace object to the recycle bin the ipspace object represents an entire address space endpoint url /api/ddi/v1/ipam/ip space/{{ip space id}} method delete input argument name type required description path parameters ip space id string required ip space id input example {"path parameters" {"ip space id" "2ec8e03c d27c 11ee 9595 e6ac2ebb2f62"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"date" "mon, 10 jun 2024 07 47 04 gmt","content type" "application/json","content length" "2","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {}} delete ipam host by id move an ipamhost object to the recycle bin the ipamhost object (ipam/host) represents any network connected equipment that is assigned one or more ip addresses endpoint url /api/ddi/v1/ipam/host/{{host id}} method delete input argument name type required description path parameters host id string required ipam host id input example {"path parameters" {"host id" "c33fb6e8 249a 11ef 9448 02b8a458f3ca"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"date" "fri, 07 jun 2024 06 57 24 gmt","content type" "application/json","content length" "2","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {}} delete range moves a specified range object to the recycle bin in infoblox bloxone ddi, requiring the range id of the target ip address set endpoint url /api/ddi/v1/ipam/range/{{range id}} method delete input argument name type required description path parameters range id string required range id input example {"path parameters" {"range id" "78ac54f8 1d89 11ef 8a41 02b8a458f3ca"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {} delete subnet move a specified subnet object to the recycle bin in infoblox bloxone ddi using the subnet id endpoint url /api/ddi/v1/ipam/subnet/{{subnet id}} method delete input argument name type required description path parameters subnet id string required subnet id input example {"path parameters" {"subnet id" "4aaf5a2d 1c83 11ef b68d 02b8a458f3ca"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"date" "tue, 28 may 2024 06 06 50 gmt","content type" "application/json","content length" "2","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {}} get a dhcp fingerprint retrieve a specific dhcp fingerprint object by its id in infoblox bloxone ddi, including its name and associated rules endpoint url /api/ddi/v1/dhcp/fingerprint/{{fingerprint id}} method get input argument name type required description path parameters fingerprint id string required fingerprint id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id"},"path parameters" {"fingerprint id" "b5595b96 166b 11ef b908 262f6a930816"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result class string result of the operation result comment string result of the operation result created at string result of the operation result defined by string result of the operation result id string unique identifier result inheritance sources object result of the operation result name string name of the resource result precedence number result of the operation result rules array result of the operation result rules file name string name of the resource result rules file string result of the operation result share fingerprint boolean result of the operation result tags object result of the operation result updated at string result of the operation output example {"status code" 200,"response headers" {"date" "mon, 20 may 2024 06 16 57 gmt","content type" "application/json","content length" "386","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"class" "dhcp/fingerprint class/0acf3996 6f31 47b6 8c57 4666df9743b2","comment" "","created at" "2024 05 20t05 42 13 167636z","defined by" "user","id" "dhcp/fingerprint/b get address block retrieves an addressblock object by id, supporting administrative grouping and routing aggregation in infoblox bloxone ddi endpoint url /api/ddi/v1/ipam/address block/{{address block id}} method get input argument name type required description path parameters address block id string required address block id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id,name"},"path parameters" {"address block id" "2d1bbb08 00c8 11ef 8c72 d2db0cedb6eb"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result address string result of the operation result asm config object result of the operation result asm config asm threshold number result of the operation result asm config enable boolean result of the operation result asm config enable notification boolean result of the operation result asm config forecast period number result of the operation result asm config growth factor number result of the operation result asm config growth type string type of the resource result asm config history number result of the operation result asm config min total number result of the operation result asm config min unused number result of the operation result asm config reenable date string result of the operation result asm scope flag number result of the operation result cidr number unique identifier result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result ddns client update string result of the operation result ddns conflict resolution mode string result of the operation result ddns domain string result of the operation result ddns generate name boolean name of the resource result ddns generated prefix string result of the operation output example {"result" {"address" "string","asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns get address block next available ip address retrieve the next available ip address from infoblox bloxone ddi's address block for dynamic allocation endpoint url /api/ddi/v1/ipam/address block/{{address block id}}/nextavailableip method get input argument name type required description path parameters address block id string optional address block id parameters contiguous boolean optional indicates whether the ip addresses should belong to a contiguous block parameters count number optional the number of ip addresses requested input example {"parameters" {"contiguous"\ false,"count" 2},"path parameters" {"address block id" "fdb56d82 1dd6 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results space string result of the operation results address string result of the operation results protocol string result of the operation results comment string result of the operation results parent string result of the operation results range object result of the operation results interface string result of the operation results state string result of the operation results usage array result of the operation results usage file name string name of the resource results usage file string result of the operation results dhcp info object result of the operation results names array name of the resource results names file name string name of the resource results names file string name of the resource results host object result of the operation results hwaddr string result of the operation results tags object result of the operation results created at string result of the operation results updated at string result of the operation results discovery attrs object result of the operation output example {"status code" 200,"response headers" {"date" "thu, 30 may 2024 07 13 18 gmt","content type" "application/json","content length" "540","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}]}} get asm by id retrieve an asm object for automated scope management the asm object returns the suggested updates for the subnet from the asm suggestion engine and allows for updating the subnet and range information endpoint url /api/ddi/v1/ipam/asm/{{asm id}} method get input argument name type required description path parameters asm id string required asm id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id,growth"},"path parameters" {"asm id" "a9cd96e5 1d88 11ef 8a41 02b8a458f3ca"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result id string unique identifier result subnet id string unique identifier result range id object unique identifier result range start string result of the operation result range end string result of the operation result update string result of the operation result utilization number result of the operation result threshold utilization number result of the operation result lookahead number result of the operation result growth number result of the operation result front start string result of the operation result front end string result of the operation result back start string result of the operation result back end string result of the operation result both start string result of the operation result both end string result of the operation result subnet direction string result of the operation result subnet address string result of the operation result subnet cidr number unique identifier result subnet range object result of the operation result subnet range start string result of the operation result subnet range end string result of the operation output example {"status code" 200,"response headers" {"date" "tue, 11 jun 2024 04 46 19 gmt","content type" "application/json","content length" "15","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"id" "ipam/asm","subnet id" "ipam/subnet/4b96eb17 00c8 11ef af8c 82dcd2cac46c","range id"\ null,"range start" "","range end" get dhcp fingerprint class retrieve a specific dhcp fingerprint class by its id for device classification within infoblox bloxone ddi endpoint url /api/ddi/v1/dhcp/fingerprint class/{{fingerprint class id}} method get input argument name type required description path parameters fingerprint class id string required fingerprint class id input example {"path parameters" {"fingerprint class id" "0129e6ee 81fa 4d78 9923 756b2556dc48"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result id string unique identifier result name string name of the resource output example {"status code" 200,"response headers" {"date" "sun, 19 may 2024 11 26 15 gmt","content type" "application/json","content length" "122","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"id" "dhcp/fingerprint class/0129e6ee 81fa 4d78 9923 756b2556dc48","name" "router, access point or femtocell"}}} get dhcp system fingerprint retrieve a specific dhcp system fingerprint by id from infoblox bloxone ddi, including its name and associated rules endpoint url /api/ddi/v1/dhcp/system fingerprint/{{system fingerprint id}} method get input argument name type required description path parameters system fingerprint id string required system fingerprint id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id,name"},"path parameters" {"system fingerprint id" "010ca6dc ec7e 4eec 8812 fc056b8d87a6"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result id string unique identifier result name string name of the resource result rules array result of the operation result rules prl array result of the operation result rules prefix string result of the operation result rules vendor string result of the operation result rules vendor compare string result of the operation result class string result of the operation result created at object result of the operation result updated at object result of the operation output example {"status code" 200,"response headers" {"date" "sun, 19 may 2024 12 11 22 gmt","content type" "application/json","content length" "329","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"id" "dhcp/system fingerprint/010ca6dc ec7e 4eec 8812 fc056b8d87a6","name" "pcs revenue control systems","rules" \[],"class get dns usage by id retrieve a dnsusage object endpoint url /api/ddi/v1/ipam/dns usage/{{dns usage id}} method get input argument name type required description path parameters dns usage id string required dns usage id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id,name"},"path parameters" {"dns usage id" "4b96eb17 00c8 11ef af8c 82dcd2cac46c"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result absolute name string name of the resource result address string result of the operation result dns rdata string response data result id string unique identifier result name string name of the resource result record string result of the operation result space string result of the operation result type string type of the resource result view string result of the operation result zone string result of the operation output example {"status code" 200,"response headers" {"date" "tue, 11 jun 2024 05 16 51 gmt","content type" "application/json","content length" "42","connection" "keep alive","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"absolute name" "string","address" "string","dns rdata" "string","id" "string","name" "string","record" "string","space" "string","type" "string","view" "string","zone" "string"}}} get global lease by id retrieve the globallease object by its unique identifier from infoblox bloxone ddi endpoint url /api/ddi/v1/dhcp/global lease/{{global lease id}} method get input argument name type required description path parameters global lease id string required global lease id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id"},"path parameters" {"global lease id" "ab37d2fc 85ee 4edb 8ac4 9485cb67a95c"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result id string unique identifier result share fingerprint boolean result of the operation output example {"status code" 200,"response headers" {"date" "mon, 20 may 2024 04 36 02 gmt","content type" "application/json","content length" "99","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"id" "dhcp/global lease/ab37d2fc 85ee 4edb 8ac4 9485cb67a95c","share fingerprint"\ true}}} get globallease retrieve the global dhcp lease configuration from infoblox bloxone ddi, including parent settings for inheritance endpoint url /api/ddi/v1/dhcp/global lease method get input argument name type required description parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result id string unique identifier result share fingerprint boolean result of the operation output example {"status code" 200,"response headers" {"date" "sun, 19 may 2024 11 33 03 gmt","content type" "application/json","content length" "99","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"id" "dhcp/global lease/ab37d2fc 85ee 4edb 8ac4 9485cb67a95c","share fingerprint"\ true}}} get ip address retrieves a single ip address object from infoblox bloxone ddi, representing an ip within a specified space endpoint url /api/ddi/v1/ipam/address/{{address id}} method get input argument name type required description path parameters address id string optional address id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id,state"},"path parameters" {"address id" "a44c65fa 1b4c 11ef 8447 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result address string result of the operation result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result dhcp info object result of the operation result disable dhcp boolean result of the operation result discovery attrs object result of the operation result discovery metadata object response data result host object result of the operation result hwaddr string result of the operation result id string unique identifier result interface string result of the operation result names array name of the resource result names file name string name of the resource result names file string name of the resource result parent string result of the operation result protocol string result of the operation result range object result of the operation result space string result of the operation result state string result of the operation result tags object result of the operation result updated at string result of the operation output example {"status code" 200,"response headers" {"date" "sun, 26 may 2024 13 55 37 gmt","content type" "application/json","content length" "553","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"address" "192 168 0 1","comment" "","compartment id" "","created at" "2024 05 26t10 42 25 973780z","dhcp info"\ null,"disable dhcp"\ false,"discovery attrs"\ null,"discover get ip space by id retrieve an ipspace object the ipspace object represents an entire address space endpoint url /api/ddi/v1/ipam/ip space/{{ip space id}} method get input argument name type required description path parameters ip space id string required ip space id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id,name"},"path parameters" {"ip space id" "2ec8e03c d27c 11ee 9595 e6ac2ebb2f62"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result asm config object result of the operation result asm config asm threshold number result of the operation result asm config enable boolean result of the operation result asm config enable notification boolean result of the operation result asm config forecast period number result of the operation result asm config growth factor number result of the operation result asm config growth type string type of the resource result asm config history number result of the operation result asm config min total number result of the operation result asm config min unused number result of the operation result asm config reenable date string result of the operation result asm scope flag number result of the operation result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result ddns client update string result of the operation result ddns conflict resolution mode string result of the operation result ddns domain string result of the operation result ddns generate name boolean name of the resource result ddns generated prefix string result of the operation result ddns send updates boolean result of the operation result ddns ttl percent number result of the operation output example {"status code" 200,"response headers" {"date" "mon, 10 jun 2024 07 09 11 gmt","content type" "application/json","content length" "1648","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"asm config" {},"asm scope flag" 0,"comment" "some comment","compartment id" "","created at" "2024 02 23t18 48 49 777030z","ddns client update" "client","ddns conflict r get ipam host by id retrieve an ipamhost object the ipamhost object (ipam/host) represents any network connected equipment that is assigned one or more ip addresses endpoint url /api/ddi/v1/ipam/host/{{host id}} method get input argument name type required description path parameters host id string required ipam host id parameters order by string optional a collection of response resources can be sorted by their json tags the sort direction can be specified by a suffix separated by whitespace before the tag name the suffix 'asc' sorts the data in ascending order the suffix 'desc' sorts the data in descending order parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" order by" "name desc"," fields" "id,name"},"path parameters" {"host id" "e5a5411d 2497 11ef 9448 02b8a458f3ca"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result addresses array result of the operation result addresses file name string name of the resource result addresses file string result of the operation result auto generate records boolean result of the operation result comment string result of the operation result created at string result of the operation result host names array name of the resource result host names file name string name of the resource result host names file string name of the resource result id string unique identifier result name string name of the resource result tags object result of the operation result updated at string result of the operation output example {"status code" 200,"response headers" {"date" "fri, 07 jun 2024 06 38 07 gmt","content type" "application/json","content length" "264","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"addresses" \[],"auto generate records"\ false,"comment" "","created at" "2024 06 07t06 33 48 326138z","host names" \[],"id" "ipam/host/e5a5411d 2497 11ef 9448 02b8a458f3ca" get list address blocks retrieve addressblock objects in infoblox bloxone ddi, representing address space segmentation for functions like grouping and routing endpoint url /api/ddi/v1/ipam/address block method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/address/addresslist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags the sort direction can be specified by a suffix separated by whitespace before the tag name the suffix 'asc' sorts the data in ascending order the suffix 'desc' sorts the data in descending order parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page parameters torder by string optional this parameter is used for sorting by tags parameters tfilter string optional this parameter is used for filtering by tags input example {"parameters" {" filter" "name=='pcs revenue control systems'"," fields" "id,name"," order by" "name desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd"," torder by" "cool"," tfilter" "cool"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results address string result of the operation results asm config object result of the operation results asm config asm threshold number result of the operation results asm config enable boolean result of the operation results asm config enable notification boolean result of the operation results asm config forecast period number result of the operation results asm config growth factor number result of the operation results asm config growth type string type of the resource results asm config history number result of the operation results asm config min total number result of the operation results asm config min unused number result of the operation results asm config reenable date string result of the operation results asm scope flag number result of the operation results cidr number unique identifier results comment string result of the operation results compartment id string unique identifier results created at string result of the operation results ddns client update string result of the operation results ddns conflict resolution mode string result of the operation results ddns domain string result of the operation results ddns generate name boolean name of the resource results ddns generated prefix string result of the operation output example {"results" \[{"address" "string","asm config" {},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns send updates"\ true,"ddns ttl percent" 123,"ddns update on renew"\ true}]} get list ip addresses retrieve a list of address objects representing individual ip addresses within a specified ip space in infoblox bloxone ddi endpoint url /api/ddi/v1/ipam/address method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/address/addresslist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags the sort direction can be specified by a suffix separated by whitespace before the tag name the suffix 'asc' sorts the data in ascending order the suffix 'desc' sorts the data in descending order parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page parameters scope string optional parameters for the get list ip addresses action parameters address state string optional parameters for the get list ip addresses action parameters torder by string optional this parameter is used for sorting by tags parameters tfilter string optional this parameter is used for filtering by tags input example {"parameters" {" filter" "name=='pcs revenue control systems'"," fields" "id,name"," order by" "name desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd","scope" "testscope","address state" "address state"," torder by" "cool"," tfilter" "cool"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results address string result of the operation results comment string result of the operation results compartment id string unique identifier results created at string result of the operation results dhcp info object result of the operation results disable dhcp boolean result of the operation results discovery attrs object result of the operation results discovery metadata object response data results host object result of the operation results hwaddr string result of the operation results id string unique identifier results interface string result of the operation results names array name of the resource results names file name string name of the resource results names file string name of the resource results parent string result of the operation results protocol string result of the operation results range object result of the operation results space string result of the operation results state string result of the operation results tags object result of the operation results updated at string result of the operation output example {"status code" 200,"response headers" {"date" "sun, 26 may 2024 11 27 27 gmt","content type" "application/json","content length" "1638","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{},{},{}]}} get list of address block ancestors retrieve a list of ancestor details for a specified addressblock object in infoblox bloxone ddi using the 'address block id' endpoint url /api/ddi/v1/ipam/address block/{{address block id}}/ancestor method get input argument name type required description path parameters address block id string required address block id input example {"path parameters" {"address block id" "2d1bbb08 00c8 11ef 8c72 d2db0cedb6eb"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results address string result of the operation results cidr number unique identifier results parent object result of the operation results federated realms array result of the operation results federated realms file name string name of the resource results federated realms file string result of the operation results space string result of the operation output example {"status code" 200,"response headers" {"date" "thu, 30 may 2024 04 28 42 gmt","content type" "application/json","content length" "14","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}]}} get list of asm retrieve asm objects for automated scope management the asm object returns the suggested updates for the subnet from the asm suggestion engine and allows for updating the subnet and range information endpoint url /api/ddi/v1/ipam/asm method get input argument name type required description parameters subnet id string required subnet id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {"subnet id" "ipam/subnet/4b96eb17 00c8 11ef af8c 82dcd2cac46c"," fields" "growth,update"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id object unique identifier results subnet id string unique identifier results range id object unique identifier results range start string result of the operation results range end string result of the operation results update string result of the operation results utilization number result of the operation results threshold utilization number result of the operation results lookahead number result of the operation results growth number result of the operation results front start string result of the operation results front end string result of the operation results back start string result of the operation results back end string result of the operation results both start string result of the operation results both end string result of the operation results subnet direction string result of the operation results subnet address string result of the operation results subnet cidr number unique identifier results subnet range object result of the operation results subnet range start string result of the operation results subnet range end string result of the operation output example {"status code" 200,"response headers" {"date" "mon, 10 jun 2024 10 32 38 gmt","content type" "application/json","content length" "475","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}]}} get list of dhcp fingerprint classes retrieve a list of device classes for dhcp fingerprinting from infoblox bloxone ddi endpoint url /api/ddi/v1/dhcp/fingerprint class method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc/?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fdhcpleases#/fingerprint class/fingerprint classlist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page input example {"parameters" {" filter" "name=='pcs revenue control systems'"," fields" "id,name"," order by" "name desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results name string name of the resource output example {"status code" 200,"response headers" {"date" "sun, 19 may 2024 11 21 03 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{"id" "dhcp/fingerprint class/0129e6ee 81fa 4d78 9923 756b2556dc48","name" "router, access point or femtocell"},{"id" "dhcp/fingerprint class/0312d734 db5e 4a92 9 get list of dhcp fingerprints retrieve a list of dhcp fingerprint objects from infoblox bloxone ddi, each specifying a unique name and associated rules endpoint url /api/ddi/v1/dhcp/fingerprint method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc/?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fdhcpleases#/fingerprint/fingerprintlist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page parameters torder by string optional this parameter is used for sorting by tags parameters tfilter string optional this parameter is used for filtering by tags input example {"parameters" {" filter" "name=='pcs revenue control systems'"," fields" "id,name"," order by" "name desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd"," torder by" "cool"," tfilter" "cool"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results class string result of the operation results comment string result of the operation results created at string result of the operation results defined by string result of the operation results id string unique identifier results inheritance sources object result of the operation results name string name of the resource results precedence number result of the operation results rules array result of the operation results rules file name string name of the resource results rules file string result of the operation results share fingerprint boolean result of the operation results tags object result of the operation results updated at string result of the operation output example {"status code" 200,"response headers" {"date" "mon, 20 may 2024 05 50 07 gmt","content type" "application/json","content length" "763","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{},{}]}} get list of dhcp leases retrieve a list of dhcp lease objects from infoblox bloxone ddi, representing active leases on addresses endpoint url /api/ddi/v1/dhcp/lease method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc/?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fdhcpleases#/lease/leaselist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page parameters torder by string optional this parameter is used for sorting by tags parameters tfilter string optional this parameter is used for filtering by tags input example {"parameters" {" filter" "name=='pcs revenue control systems'"," fields" "id,name"," order by" "name desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd"," torder by" "cool"," tfilter" "cool"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results file name string name of the resource results file string result of the operation output example {"status code" 200,"response headers" {"date" "sun, 19 may 2024 17 40 04 gmt","content type" "application/json","content length" "14","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[]}} get list of dhcp system fingerprints retrieve a list of dhcp system fingerprints, each specifying a name and associated rules as defined by infoblox endpoint url /api/ddi/v1/dhcp/system fingerprint method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc/?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fdhcpleases#/lease/leaselist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page parameters torder by string optional this parameter is used for sorting by tags parameters tfilter string optional this parameter is used for filtering by tags input example {"parameters" {" filter" "name=='pcs revenue control systems'"," fields" "id,name"," order by" "name desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd"," torder by" "cool"," tfilter" "cool"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results name string name of the resource results rules array result of the operation results rules prl array result of the operation results rules prefix string result of the operation results rules vendor string result of the operation results rules vendor compare string result of the operation results class string result of the operation results created at object result of the operation results updated at object result of the operation output example {"status code" 200,"response headers" {"date" "sun, 19 may 2024 16 41 46 gmt","content type" "application/json","content length" "773","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{},{}]}} get list of dns usage retrieve dnsusage objects endpoint url /api/ddi/v1/ipam/dns usage method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/dns usage/dns usagelist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags the sort direction can be specified by a suffix separated by whitespace before the tag name the suffix 'asc' sorts the data in ascending order the suffix 'desc' sorts the data in descending order parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page input example {"parameters" {" filter" "name=='test 1'"," fields" "id,name"," order by" "name desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd"," torder by" "cool"," tfilter" "cool"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results absolute name string name of the resource results address string result of the operation results dns rdata string response data results id string unique identifier results name string name of the resource results record string result of the operation results space string result of the operation results type string type of the resource results view string result of the operation results zone string result of the operation output example {"status code" 200,"response headers" {"date" "tue, 11 jun 2024 04 59 23 gmt","content type" "application/json","content length" "14","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}]}} get list of ip spaces retrieve ipspace objects the ipspace object represents an entire address space endpoint url /api/ddi/v1/ipam/ip space method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/ip space/ip spacelist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags the sort direction can be specified by a suffix separated by whitespace before the tag name the suffix 'asc' sorts the data in ascending order the suffix 'desc' sorts the data in descending order parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page parameters torder by string optional this parameter is used for sorting by tags parameters tfilter string optional this parameter is used for filtering by tags input example {"parameters" {" filter" "name=='test 1'"," fields" "id,name"," order by" "name desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd"," torder by" "cool"," tfilter" "cool"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results asm config object result of the operation results asm config asm threshold number result of the operation results asm config enable boolean result of the operation results asm config enable notification boolean result of the operation results asm config forecast period number result of the operation results asm config growth factor number result of the operation results asm config growth type string type of the resource results asm config history number result of the operation results asm config min total number result of the operation results asm config min unused number result of the operation results asm config reenable date string result of the operation results asm scope flag number result of the operation results comment string result of the operation results compartment id string unique identifier results created at string result of the operation results ddns client update string result of the operation results ddns conflict resolution mode string result of the operation results ddns domain string result of the operation results ddns generate name boolean name of the resource results ddns generated prefix string result of the operation results ddns send updates boolean result of the operation results ddns ttl percent number result of the operation output example {"status code" 200,"response headers" {"date" "mon, 10 jun 2024 06 36 09 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}]}} get list of ipam host retrieve ipamhost objects the ipamhost object (ipam/host) represents any network connected equipment that is assigned one or more ip addresses endpoint url /api/ddi/v1/ipam/host method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/address/addresslist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags the sort direction can be specified by a suffix separated by whitespace before the tag name the suffix 'asc' sorts the data in ascending order the suffix 'desc' sorts the data in descending order parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page parameters torder by string optional this parameter is used for sorting by tags parameters tfilter string optional this parameter is used for filtering by tags input example {"parameters" {" filter" "name=='pcs revenue control systems'"," fields" "id,name"," order by" "name desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd"," torder by" "cool"," tfilter" "cool"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results addresses array result of the operation results addresses file name string name of the resource results addresses file string result of the operation results auto generate records boolean result of the operation results comment string result of the operation results created at string result of the operation results host names array name of the resource results host names file name string name of the resource results host names file string name of the resource results id string unique identifier results name string name of the resource results tags object result of the operation results updated at string result of the operation output example {"status code" 200,"response headers" {"date" "fri, 07 jun 2024 06 34 58 gmt","content type" "application/json","content length" "267","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}]}} get list of next available address blocks generates a list of available ipam address blocks from infoblox bloxone ddi using a specified address block id endpoint url /api/ddi/v1/ipam/address block/{{address block id}}/nextavailableaddressblock method get input argument name type required description path parameters address block id string required parameters for the get list of next available address blocks action parameters cidr number optional the cidr value of subnets to be created parameters count number optional number of subnets to generate parameters name string optional name of next available address blocks parameters comment string optional comment of next available address blocks parameters federated realms array optional reserved for future use parameters compartment id string optional the compartment id of the address blocks to be created input example {"parameters" {"cidr" 10,"count" 2,"name" "test","comment" "list of subnets","federated realms" \[],"compartment id" "compartd id"},"path parameters" {"address block id" "fdb56d82 1dd6 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results address string result of the operation results asm config object result of the operation results asm config asm threshold number result of the operation results asm config enable boolean result of the operation results asm config enable notification boolean result of the operation results asm config forecast period number result of the operation results asm config growth factor number result of the operation results asm config growth type string type of the resource results asm config history number result of the operation results asm config min total number result of the operation results asm config min unused number result of the operation results asm config reenable date string result of the operation results asm scope flag number result of the operation results cidr number unique identifier results comment string result of the operation results compartment id string unique identifier results created at string result of the operation results ddns client update string result of the operation results ddns conflict resolution mode string result of the operation results ddns domain string result of the operation results ddns generate name boolean name of the resource results ddns generated prefix string result of the operation output example {"results" \[{"address" "string","asm config" {},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns send updates"\ true,"ddns ttl percent" 123,"ddns update on renew"\ true}]} get list of next available subnet retrieve a list of next available subnet objects within a specified address block id in infoblox bloxone ddi endpoint url /api/ddi/v1/ipam/address block/{{address block id}}/nextavailablesubnet method get input argument name type required description path parameters address block id string required address block id parameters cidr number optional the cidr value of subnets to be created parameters count number optional number of subnets to generate parameters name string optional name of next available subnets parameters comment string optional comment of next available subnets parameters dhcp host string optional reference of onprem host associated with the next available subnets to be created parameters federated realms array optional reserved for future use input example {"path parameters" {"address block id" "fdb56d82 1dd6 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results address string result of the operation results asm config object result of the operation results asm config asm threshold number result of the operation results asm config enable boolean result of the operation results asm config enable notification boolean result of the operation results asm config forecast period number result of the operation results asm config growth factor number result of the operation results asm config growth type string type of the resource results asm config history number result of the operation results asm config min total number result of the operation results asm config min unused number result of the operation results asm config reenable date string result of the operation results asm scope flag number result of the operation results cidr number unique identifier results comment string result of the operation results compartment id string unique identifier results created at string result of the operation results ddns client update string result of the operation results ddns conflict resolution mode string result of the operation results ddns domain string result of the operation results ddns generate name boolean name of the resource results ddns generated prefix string result of the operation output example {"results" \[{"address" "string","asm config" {},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns send updates"\ true,"ddns ttl percent" 123,"ddns update on renew"\ true}]} get list of ranges retrieves a list of contiguous ip address ranges within a subnet for administrative and protocol management in infoblox bloxone ddi endpoint url /api/ddi/v1/ipam/range method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/range/rangelist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags specify this parameter as a comma separated list of json tag names the sort direction can be specified by a suffix separated by whitespace before the tag name the suffix ‘asc’ sorts the data in ascending order the suffix ‘desc’ sorts the data in descending order if no suffix is specified the data is sorted in ascending order parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page parameters torder by string optional this parameter is used for sorting by tags parameters tfilter string optional this parameter is used for filtering by tags input example {"parameters" {" filter" "name=='test 1'"," fields" "id,name"," order by" "name desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd"," torder by" "cool"," tfilter" "cool"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results comment string result of the operation results compartment id string unique identifier results created at string result of the operation results dhcp host object result of the operation results dhcp options array result of the operation results dhcp options file name string name of the resource results dhcp options file string result of the operation results disable dhcp boolean result of the operation results end string result of the operation results exclusion ranges array result of the operation results exclusion ranges file name string name of the resource results exclusion ranges file string result of the operation results filters array result of the operation results filters file name string name of the resource results filters file string result of the operation results id string unique identifier results inheritance assigned hosts array result of the operation results inheritance assigned hosts file name string name of the resource results inheritance assigned hosts file string result of the operation results inheritance parent string result of the operation results inheritance sources object result of the operation results name string name of the resource output example {"status code" 200,"response headers" {"date" "wed, 29 may 2024 09 08 48 gmt","content type" "application/json","transfer encoding" "chunked","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{},{}]}} get list of subnet ancestors retrieve all ancestor details of a specified subnet in infoblox bloxone ddi using the subnet id endpoint url /api/ddi/v1/ipam/subnet/{{subnet id}}/ancestor method get input argument name type required description path parameters subnet id string required subnet id input example {"path parameters" {"subnet id" "4b96eb17 00c8 11ef af8c 82dcd2cac46c"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results address string result of the operation results cidr number unique identifier results parent object result of the operation results federated realms array result of the operation results federated realms file name string name of the resource results federated realms file string result of the operation results space string result of the operation output example {"status code" 200,"response headers" {"date" "tue, 28 may 2024 06 17 09 gmt","content type" "application/json","content length" "206","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}]}} get list of subnets retrieve a list of subnet objects representing address sets assigned to network interfaces in infoblox bloxone ddi endpoint url /api/ddi/v1/ipam/subnet method get input argument name type required description parameters filter string optional a collection of response resources can be filtered by a logical expression string that includes json tag references to values in each resource, literal values, and logical operators for operators refer api documentation https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/subnet/subnetlist parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names parameters order by string optional a collection of response resources can be sorted by their json tags specify this parameter as a comma separated list of json tag names the sort direction can be specified by a suffix separated by whitespace before the tag name the suffix ‘asc’ sorts the data in ascending order the suffix ‘desc’ sorts the data in descending order if no suffix is specified the data is sorted in ascending order parameters offset number optional the integer index (zero origin) of the offset into a collection of resources if omitted or null the value is assumed to be '0' parameters limit number optional the integer number of resources to be returned in the response the service may impose maximum value if omitted the service may impose a default value parameters page token string optional the service defined string used to identify a page of resources a null value indicates the first page parameters torder by string optional this parameter is used for sorting by tags parameters tfilter string optional this parameter is used for filtering by tags input example {"parameters" {" filter" "address=='235 128 0 0'"," fields" "id,comment"," order by" "comment desc"," offset" 10," limit" 5," page token" "afsatgfvfwgeffzawfeggehngwfdcbganehbgd"," torder by" "cool"," tfilter" "cool"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results address string result of the operation results asm config object result of the operation results asm config asm threshold number result of the operation results asm config enable boolean result of the operation results asm config enable notification boolean result of the operation results asm config forecast period number result of the operation results asm config growth factor number result of the operation results asm config growth type string type of the resource results asm config history number result of the operation results asm config min total number result of the operation results asm config min unused number result of the operation results asm config reenable date string result of the operation results asm scope flag number result of the operation results cidr number unique identifier results comment string result of the operation results compartment id string unique identifier results created at string result of the operation results ddns client update string result of the operation results ddns conflict resolution mode string result of the operation results ddns domain string result of the operation results ddns generate name boolean name of the resource results ddns generated prefix string result of the operation output example {"results" \[{"address" "string","asm config" {},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns send updates"\ true,"ddns ttl percent" 123,"ddns update on renew"\ true}]} get range retrieves a contiguous set of ip addresses within a subnet identified by the 'range id' parameter in infoblox bloxone ddi endpoint url /api/ddi/v1/ipam/range/{{range id}} method get input argument name type required description path parameters range id string required range id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id,name"},"path parameters" {"range id" "b8d8af38 1d88 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result dhcp host object result of the operation result dhcp options array result of the operation result dhcp options file name string name of the resource result dhcp options file string result of the operation result disable dhcp boolean result of the operation result end string result of the operation result exclusion ranges array result of the operation result exclusion ranges file name string name of the resource result exclusion ranges file string result of the operation result filters array result of the operation result filters file name string name of the resource result filters file string result of the operation result id string unique identifier result inheritance assigned hosts array result of the operation result inheritance assigned hosts file name string name of the resource result inheritance assigned hosts file string result of the operation result inheritance parent string result of the operation result inheritance sources object result of the operation result name string name of the resource output example {"result" {"comment" "string","compartment id" "string","created at" "string","dhcp host" {},"dhcp options" \[{}],"disable dhcp"\ true,"end" "string","exclusion ranges" \[{}],"filters" \[{}],"id" "12345678 1234 1234 1234 123456789abc","inheritance assigned hosts" \[{}],"inheritance parent" "string","inheritance sources" {},"name" "example name","parent" "string"}} get range next available ip address retrieve the next available ip address within a specified range from infoblox bloxone ddi, given the 'range id' endpoint url /api/ddi/v1/ipam/range/{{range id}}/nextavailableip method get input argument name type required description path parameters range id string required range id parameters contiguous boolean optional indicates whether the ip addresses should belong to a contiguous block parameters count number optional the number of ip addresses requested input example {"parameters" {"contiguous"\ false,"count" 1},"path parameters" {"range id" "b8d8af38 1d88 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results space string result of the operation results address string result of the operation results protocol string result of the operation results comment string result of the operation results parent string result of the operation results range string result of the operation results interface string result of the operation results state string result of the operation results usage array result of the operation results usage file name string name of the resource results usage file string result of the operation results dhcp info object result of the operation results names array name of the resource results names file name string name of the resource results names file string name of the resource results host object result of the operation results hwaddr string result of the operation results tags object result of the operation results created at string result of the operation results updated at string result of the operation results discovery attrs object result of the operation output example {"status code" 200,"response headers" {"date" "wed, 29 may 2024 12 38 58 gmt","content type" "application/json","content length" "587","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}]}} get subnet retrieves a specific subnet object by subnet id from infoblox bloxone ddi, representing a set of assignable network addresses endpoint url /api/ddi/v1/ipam/subnet/{{subnet id}} method get input argument name type required description path parameters subnet id string required subnet id parameters fields string optional a collection of response resources can be transformed by specifying a set of json tags to be returned specify this parameter as a comma separated list of json tag names input example {"parameters" {" fields" "id,comment"},"path parameters" {"subnet id" "4aaf5a2d 1c83 11ef b68d 02b8a458f3ca"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result address string result of the operation result asm config object result of the operation result asm config asm threshold number result of the operation result asm config enable boolean result of the operation result asm config enable notification boolean result of the operation result asm config forecast period number result of the operation result asm config growth factor number result of the operation result asm config growth type string type of the resource result asm config history number result of the operation result asm config min total number result of the operation result asm config min unused number result of the operation result asm config reenable date string result of the operation result asm scope flag number result of the operation result cidr number unique identifier result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result ddns client update string result of the operation result ddns conflict resolution mode string result of the operation result ddns domain string result of the operation result ddns generate name boolean name of the resource result ddns generated prefix string result of the operation output example {"result" {"address" "string","asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns get subnet next available ip address retrieve the next available ip address within a specified subnet by providing the subnet id endpoint url /api/ddi/v1/ipam/subnet/{{subnet id}}/nextavailableip method get input argument name type required description path parameters subnet id string required subnet id parameters contiguous boolean optional indicates whether the ip addresses should belong to a contiguous block parameters count number optional the number of ip addresses requested defaults to 1 input example {"parameters" {"contiguous"\ false,"count" 1},"path parameters" {"subnet id" "4b96eb17 00c8 11ef af8c 82dcd2cac46c"}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results id string unique identifier results space string result of the operation results address string result of the operation results protocol string result of the operation results comment string result of the operation results parent string result of the operation results range object result of the operation results interface string result of the operation results state string result of the operation results usage array result of the operation results usage file name string name of the resource results usage file string result of the operation results dhcp info object result of the operation results names array name of the resource results names file name string name of the resource results names file string name of the resource results host object result of the operation results hwaddr string result of the operation results tags object result of the operation results created at string result of the operation results updated at string result of the operation results discovery attrs object result of the operation output example {"status code" 200,"response headers" {"date" "tue, 28 may 2024 06 35 39 gmt","content type" "application/json","content length" "538","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"results" \[{}]}} update address block updates an addressblock object in infoblox bloxone ddi, requiring address block id and json body for segmentation and delegation functions endpoint url /api/ddi/v1/ipam/address block/{{address block id}} method patch input argument name type required description path parameters address block id string required address block id address string optional the address field in form “a b c d/n” where the “/n” may be omitted in this case, the cidr value must be defined in the cidr field when reading, the address field is always in the form “a b c d” asm config object optional the asmconfig object represents automated scope management configuration asm config asm threshold number optional asm shows the number of addresses forecast to be used forecast period days in the future, if it is greater than asm threshold percent dhcp total (see dhcp utilization) then the subnet is flagged asm config enable boolean optional indicates if automated scope management is enabled asm config enable notification boolean optional indicates if asm should send notifications to the user asm config forecast period number optional the forecast period in days asm config growth factor number optional indicates the growth in the number or percentage of ip addresses asm config growth type string optional the type of factor to use are percent or count asm config history number optional the minimum amount of history needed before asm can run on this subnet asm config min total number optional the minimum size of range needed for asm to run on this subnet asm config min unused number optional the minimum percentage of addresses that must be available outside of the dhcp ranges and fixed addresses when making a suggested change asm config reenable date string optional date value cidr number optional the cidr of the address block this is required, if address does not specify it in its input maximum is 128 and minimum is 1 comment string optional the description for the address block may contain 0 to 1024 characters can include utf 8 compartment id string optional reserved for future use ddns client update string optional controls who does the ddns updates ddns conflict resolution mode string optional the mode used for resolving conflicts while performing ddns updates ddns domain string optional the domain suffix for ddns updates fqdn, may be empty ddns generate name boolean optional indicates if ddns needs to generate a hostname when not supplied by the client ddns generated prefix string optional the prefix used in the generation of an fqdn when generating a name, dhcp server will construct the name in the format is \[ddns generated prefix] \[address text] \[ddns qualifying suffix] where address text is simply the lease ip address converted to a hyphenated string ddns send updates boolean optional determines if ddns updates are enabled at the address block level ddns ttl percent number optional ddns ttl value to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage it is specified as a percentage (e g 25, 75) ddns update on renew boolean optional instructs the dhcp server to always update the dns information when a lease is renewed even if its dns information has not changed ddns use conflict resolution boolean optional when true, dhcp server will apply conflict resolution, as described in rfc 4703, when attempting to fulfill the update request when false, dhcp server will simply attempt to update the dns entries per the request, regardless of whether or not they conflict with existing entries owned by other dhcp4 clients input example {"path parameters" {"address block id" "2a475199 1e59 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result address string result of the operation result asm config object result of the operation result asm config asm threshold number result of the operation result asm config enable boolean result of the operation result asm config enable notification boolean result of the operation result asm config forecast period number result of the operation result asm config growth factor number result of the operation result asm config growth type string type of the resource result asm config history number result of the operation result asm config min total number result of the operation result asm config min unused number result of the operation result asm config reenable date string result of the operation result asm scope flag number result of the operation result cidr number unique identifier result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result ddns client update string result of the operation result ddns conflict resolution mode string result of the operation result ddns domain string result of the operation result ddns generate name boolean name of the resource result ddns generated prefix string result of the operation output example {"result" {"address" "string","asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns update asm update the subnet and range for automated scope management the asm object generates and returns the suggestions from the asm suggestion engine and allows for updating the subnet and range endpoint url /api/ddi/v1/ipam/asm method post input argument name type required description range end string optional the end ip address of the range range id string optional the resource identifier range start string optional the start ip address of the range subnet id string optional the resource identifier subnet range string optional the resource identifier suppress string optional indicates if future notifications for this subnet should be suppressed suppress time number optional the time duration in days to suppress the notifications for this subnet update string optional the object to update input example {"json body" {"range end" "30 127 233 254","range id" "ipam/range/b8d8af38 1d88 11ef 8de7 2ad8f1f3d115","range start" "30 127 233 1","subnet id" "ipam/subnet/4b96eb17 00c8 11ef af8c 82dcd2cac46c","subnet range" "ipam/subnet/4b96eb17 00c8 11ef af8c 82dcd2cac46c","suppress" "time","suppress time" 0,"update" "range"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result id string unique identifier result subnet id string unique identifier result range id object unique identifier result range start string result of the operation result range end string result of the operation result update string result of the operation result utilization number result of the operation result threshold utilization number result of the operation result lookahead number result of the operation result growth number result of the operation result front start string result of the operation result front end string result of the operation result back start string result of the operation result back end string result of the operation result both start string result of the operation result both end string result of the operation result subnet direction string result of the operation result subnet address string result of the operation result subnet cidr number unique identifier result subnet range object result of the operation result subnet range start string result of the operation result subnet range end string result of the operation output example {"status code" 200,"response headers" {"date" "tue, 11 jun 2024 04 16 15 gmt","content type" "application/json","content length" "470","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"id" "ipam/asm","subnet id" "ipam/subnet/4b96eb17 00c8 11ef af8c 82dcd2cac46c","range id"\ null,"range start" "","range end update dhcp fingerprint updates a dhcp fingerprint in infoblox bloxone ddi by specifying a name and class rules for client matching endpoint url /api/ddi/v1/dhcp/fingerprint/{{fingerprint id}} method patch input argument name type required description path parameters fingerprint id string required parameters for the update dhcp fingerprint action class string optional the resource identifier comment string optional the description for the dhcp fingerprint may contain 0 to 1024 characters can include utf 8 inheritance sources object optional the inheritance configuration specifies how share fingerprint is inherited inheritance sources share fingerprint object optional the inheritance configuration for a field of type bool inheritance sources share fingerprint action string optional the inheritance setting for a field valid values are inherit,override inherit use the inherited value override use the value set in the object inheritance sources share fingerprint source string optional the resource identifier name string optional the name of the dhcp fingerprint must contain 1 to 256 characters can include utf 8 precedence number optional integer (1 n) defining priority order of dhcp fingerprints; smaller means higher precedence maximum is 2147483647 rules array optional the collection of fingerprint rules for the dhcp fingerprint a fingerprintrule object (dhcp/fingerprint rule) represents a dhcp fingerprint rule a lease matches a fingerprint rule if all of the sub rules evaluate to true if a sub rule doesn’t include a value (it has been left empty) it evaluates to true rules prl array optional the value to use to match the parameter request list option (option 55) a string of intergers rules prefix string optional the value to use to match the first three bytes of the hardware address rules vendor string optional the value to use to match the vendor class id option (option 60) rules vendor compare string optional the operation to use when matching the vendor class id share fingerprint boolean optional indicates if the dhcp fingerprint should be shared with infoblox this is only applicable for custom fingerprints defaults to true for custom fingerprints tags object optional the tags for the dhcp fingerprint in json format input example {"json body" {"class" "dhcp/fingerprint class/0acf3996 6f31 47b6 8c57 4666df9743b2","comment" "cool","inheritance sources" {"share fingerprint" {"action" "inherit","source" "string"}},"name" "testing fingerprint 1 2","precedence" 1,"rules" \[{"prl" \["1","3","6","42","12","15","31","33","43"],"prefix" "","vendor" "0acf3996 6f31 47b6 8c57 4666df9743b2","vendor compare" "equals"}],"share fingerprint"\ true,"tags" {}},"path parameters" {"fingerprint id" "b5595b96 166b 11ef b908 262f6a930816"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result class string result of the operation result comment string result of the operation result created at string result of the operation result defined by string result of the operation result id string unique identifier result inheritance sources object result of the operation result name string name of the resource result precedence number result of the operation result rules array result of the operation result rules file name string name of the resource result rules file string result of the operation result share fingerprint boolean result of the operation result tags object result of the operation result updated at string result of the operation output example {"status code" 200,"response headers" {"date" "mon, 20 may 2024 06 25 43 gmt","content type" "application/json","content length" "389","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"class" "dhcp/fingerprint class/0acf3996 6f31 47b6 8c57 4666df9743b2","comment" "","created at" "2024 05 20t05 42 13 167636z","defined by" "user","id" "dhcp/fingerprint/b update global lease updates the global dhcp lease configuration in infoblox bloxone ddi using a specified global lease id endpoint url /api/ddi/v1/dhcp/global lease/{{global lease id}} method patch input argument name type required description path parameters global lease id string required global lease id share fingerprint boolean optional indicates if dhcp fingerprint should be shared with infoblox this is only applicable for custom fingerprints defaults to true for custom dhcp fingerprints input example {"json body" {"share fingerprint"\ true},"path parameters" {"global lease id" "ab37d2fc 85ee 4edb 8ac4 9485cb67a95c"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result id string unique identifier result share fingerprint boolean result of the operation output example {"status code" 200,"response headers" {"date" "sun, 19 may 2024 11 53 48 gmt","content type" "application/json","content length" "99","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","grpc metadata content type" "application/grpc","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"id" "dhcp/global lease/ab37d2fc 85ee 4edb 8ac4 9485cb67a95c","share fingerprint"\ true}}} update ip address updates a specific ip address object within the designated ip space in infoblox bloxone ddi endpoint url /api/ddi/v1/ipam/address/{{address id}} method patch input argument name type required description path parameters address id string required address id address string optional the address in form "a b c d" comment string optional the description for the address object may contain 0 to 1024 characters can include utf 8 discovery attrs object optional the discovery attributes for this address in json format discovery metadata object optional the discovery metadata for this address in json format host string optional the resource identifier hwaddr string optional the hardware address associated with this ip address interface string optional the name of the network interface card (nic) associated with the address, if any names array optional the list of all names associated with this address names name string required the name expressed as a single label or fqdn names type string required the origin of the name parent string optional the resource identifier range string optional the resource identifier tags object optional parameter for update ip address space string optional the resource identifier input example {"json body" {"address" "192 168 1 0","comment" "updated the ip address comment 1 1","discovery attrs" {},"discovery metadata" {},"host" "string","hwaddr" "string","interface" "string","names" \[{"name" "string","type" "string"}],"parent" "string","range" "string","tags" {},"space" "ipam/ip space/2ec8e03c d27c 11ee 9595 e6ac2ebb2f62"},"path parameters" {"address id" "a44c65fa 1b4c 11ef 8447 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result address string result of the operation result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result dhcp info object result of the operation result disable dhcp boolean result of the operation result discovery attrs object result of the operation result discovery metadata object response data result host object result of the operation result hwaddr string result of the operation result id string unique identifier result interface string result of the operation result names array name of the resource result names file name string name of the resource result names file string name of the resource result parent string result of the operation result protocol string result of the operation result range object result of the operation result space string result of the operation result state string result of the operation result tags object result of the operation result updated at string result of the operation output example {"status code" 200,"response headers" {"date" "sun, 26 may 2024 14 12 27 gmt","content type" "application/json","content length" "586","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"address" "192 168 1 0","comment" "updated the ip address comment","compartment id" "","created at" "2024 05 26t10 42 25 973780z","dhcp info"\ null,"disable dhcp"\ false,"d update ip space update an ipspace object the ipspace object represents an entire address space endpoint url /api/ddi/v1/ipam/ip space/{{ip space id}} method patch input argument name type required description path parameters ip space id string required ip space id asm config object optional the asmconfig object represents automated scope management configuration asm config asm threshold number optional asm shows the number of addresses forecast to be used forecast period days in the future, if it is greater than asm threshold percent dhcp total (see dhcp utilization) then the subnet is flagged asm config enable boolean optional indicates if automated scope management is enabled asm config enable notification boolean optional indicates if asm should send notifications to the user asm config forecast period number optional the forecast period in days asm config growth factor number optional indicates the growth in the number or percentage of ip addresses asm config growth type string optional the type of factor to use are percent or count asm config history number optional the minimum amount of history needed before asm can run on this subnet asm config min total number optional the minimum size of range needed for asm to run on this subnet asm config min unused number optional the minimum percentage of addresses that must be available outside of the dhcp ranges and fixed addresses when making a suggested change asm config reenable date string optional date value comment string optional the description for the ip space may contain 0 to 1024 characters can include utf 8 compartment id string optional reserved for future use ddns client update string optional controls who does the ddns updates ddns conflict resolution mode string optional the mode used for resolving conflicts while performing ddns updates ddns domain string optional the domain suffix for ddns updates fqdn, may be empty ddns generate name boolean optional indicates if ddns needs to generate a hostname when not supplied by the client ddns generated prefix string optional the prefix used in the generation of an fqdn when generating a name, dhcp server will construct the name in the format is \[ddns generated prefix] \[address text] \[ddns qualifying suffix] where address text is simply the lease ip address converted to a hyphenated string ddns send updates boolean optional determines if ddns updates are enabled at the ip space level ddns ttl percent number optional ddns ttl value to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage it is specified as a percentage (e g 25, 75) ddns update on renew boolean optional instructs the dhcp server to always update the dns information when a lease is renewed even if its dns information has not changed ddns use conflict resolution boolean optional when true, dhcp server will apply conflict resolution, as described in rfc 4703, when attempting to fulfill the update request when false, dhcp server will simply attempt to update the dns entries per the request, regardless of whether or not they conflict with existing entries owned by other dhcp4 clients default realms array optional reserved for future use dhcp config object optional a dhcp config object (dhcp/dhcp config) represents a shared dhcp configuration that controls how leases are issued input example {"path parameters" {"ip space id" "7eb42207 27b4 11ef a715 729fd14e7c69"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result asm config object result of the operation result asm config asm threshold number result of the operation result asm config enable boolean result of the operation result asm config enable notification boolean result of the operation result asm config forecast period number result of the operation result asm config growth factor number result of the operation result asm config growth type string type of the resource result asm config history number result of the operation result asm config min total number result of the operation result asm config min unused number result of the operation result asm config reenable date string result of the operation result asm scope flag number result of the operation result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result ddns client update string result of the operation result ddns conflict resolution mode string result of the operation result ddns domain string result of the operation result ddns generate name boolean name of the resource result ddns generated prefix string result of the operation result ddns send updates boolean result of the operation result ddns ttl percent number result of the operation output example {"result" {"asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"asm scope flag" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns send updates"\ true,"ddns ttl update ipam host update an ipamhost object the ipamhost object (ipam/host) represents any network connected equipment that is assigned one or more ip addresses endpoint url /api/ddi/v1/ipam/host/{{host id}} method patch input argument name type required description path parameters host id string optional ipam host id addresses array optional the list of all addresses associated with the ipam host, which may be in different ip spaces addresses address string required field usage depends on the operation addresses ref string required the resource identifier addresses space string required the resource identifier auto generate records boolean optional this flag specifies if resource records have to be auto generated for the host comment string optional the description for the ipam host may contain 0 to 1024 characters can include utf 8 host names array optional the name records to be generated for the host host names alias boolean optional when true, the name is treated as an alias host names name string required a name for the host host names primary name boolean optional when true, the name field is treated as primary name host names zone string required the resource identifier name string optional the name of the ipam host must contain 1 to 256 characters can include utf 8 tags object optional the tags for the ipam host in json format input example {"json body" {"addresses" \[{"address" "address","ref" "ipam/ip space/a8d3f3dc 1d7f 11ef 8de7 2ad8f1f3d115","space" "ipam/ip space/a8d3f3dc 1d7f 11ef 8de7 2ad8f1f3d115"}],"auto generate records"\ true,"comment" "commented","host names" \[{"alias"\ true,"name" "string","primary name"\ true,"zone" "ipam/host/a8d3f3dc 1d7f 11ef 8de7 2ad8f1f3d115"}],"name" "test ipam host 1 5","tags" {}},"path parameters" {"host id" "e5a5411d 2497 11ef 9448 02b8a458f3ca"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result addresses array result of the operation result addresses file name string name of the resource result addresses file string result of the operation result auto generate records boolean result of the operation result comment string result of the operation result created at string result of the operation result host names array name of the resource result host names file name string name of the resource result host names file string name of the resource result id string unique identifier result name string name of the resource result tags object result of the operation result updated at string result of the operation output example {"status code" 200,"response headers" {"date" "mon, 10 jun 2024 05 48 53 gmt","content type" "application/json","content length" "277","connection" "keep alive","cache control" "no cache, no store, max age=0, must revalidate","strict transport security" "max age=31536000; includesubdomains"},"reason" "ok","json body" {"result" {"addresses" \[],"auto generate records"\ false,"comment" "","created at" "2024 06 07t06 33 48 326138z","host names" \[],"id" "ipam/host/e5a5411d 2497 11ef 9448 02b8a458f3ca" update range modifies a contiguous set of ip addresses within a subnet in infoblox bloxone ddi, identified by the 'range id' endpoint url /api/ddi/v1/ipam/range/{{range id}} method patch input argument name type required description path parameters range id string required range id comment string optional the description for the range may contain 0 to 1024 characters can include utf 8 dhcp host string optional the resource identifier dhcp options array optional an item (dhcp/option item) in a list of dhcp options may be either a specific option or a group of options dhcp options group string optional the resource identifier dhcp options option code string optional the resource identifier dhcp options option value string optional the option value dhcp options type string optional the type of item disable dhcp boolean optional a disabled object is effectively non existent when generating configuration end string optional the end ip address of the range exclusion ranges array optional the exclusionrange object represents an exclusion range inside a dhcp range exclusion ranges comment string optional the description for the exclusion range may contain 0 to 1024 characters can include utf 8 exclusion ranges end string required the end address of the exclusion range exclusion ranges start string required the start address of the exclusion range filters array optional the accessfilter object represents an allow/deny filter for a dhcp range filters access string optional the access type of dhcp filter (allow or deny) filters hardware filter id string optional the resource identifier filters option filter id string optional the resource identifier inheritance parent string optional the resource identifier inheritance sources object optional the inheritance configuration that specifies how the dhcp options field is inherited from the parent object inheritance sources dhcp options object optional the inheritance configuration for a field that contains list of optionitem inheritance sources dhcp options action string optional the inheritance setting inheritance sources dhcp options value array optional the inherited dhcp option values inheritance sources dhcp options value action string optional the inheritance setting inheritance sources dhcp options value source string optional the resource identifier input example {"path parameters" {"range id" "b8d8af38 1d88 11ef 8de7 2ad8f1f3d115"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result dhcp host object result of the operation result dhcp options array result of the operation result dhcp options file name string name of the resource result dhcp options file string result of the operation result disable dhcp boolean result of the operation result end string result of the operation result exclusion ranges array result of the operation result exclusion ranges file name string name of the resource result exclusion ranges file string result of the operation result filters array result of the operation result filters file name string name of the resource result filters file string result of the operation result id string unique identifier result inheritance assigned hosts array result of the operation result inheritance assigned hosts file name string name of the resource result inheritance assigned hosts file string result of the operation result inheritance parent string result of the operation result inheritance sources object result of the operation result name string name of the resource output example {"result" {"comment" "string","compartment id" "string","created at" "string","dhcp host" {},"dhcp options" \[{}],"disable dhcp"\ true,"end" "string","exclusion ranges" \[{}],"filters" \[{}],"id" "12345678 1234 1234 1234 123456789abc","inheritance assigned hosts" \[{}],"inheritance parent" "string","inheritance sources" {},"name" "example name","parent" "string"}} update subnet updates a subnet object in infoblox bloxone ddi using the specified subnet id this action requires a json body with updated details endpoint url /api/ddi/v1/ipam/subnet/{{subnet id}} method patch input argument name type required description path parameters subnet id string required subnet id address string optional the address of the subnet in the form “a b c d/n” where the “/n” may be omitted in this case, the cidr value must be defined in the cidr field when reading, the address field is always in the form “a b c d” asm config object optional the asmconfig object represents automated scope management configuration asm config asm threshold number optional asm shows the number of addresses forecast to be used forecast period days in the future, if it is greater than asm threshold percent dhcp total (see dhcp utilization) then the subnet is flagged asm config enable boolean optional indicates if automated scope management is enabled asm config enable notification boolean optional indicates if asm should send notifications to the user asm config forecast period number optional the forecast period in days asm config growth factor number optional indicates the growth in the number or percentage of ip addresses asm config growth type string optional the type of factor to use are percent or count asm config history number optional the minimum amount of history needed before asm can run on this subnet asm config min total number optional the minimum size of range needed for asm to run on this subnet asm config min unused number optional the minimum percentage of addresses that must be available outside of the dhcp ranges and fixed addresses when making a suggested change asm config reenable date string optional date value cidr number optional the cidr of the subnet this is required, if address does not specify it in its input maximum is 128 and minimum is 1 comment string optional the description for the subnet may contain 0 to 1024 characters can include utf 8 compartment id string optional reserved for future use ddns client update string optional controls who does the ddns updates ddns conflict resolution mode string optional the mode used for resolving conflicts while performing ddns updates ddns domain string optional the domain suffix for ddns updates fqdn, may be empty ddns generate name boolean optional indicates if ddns needs to generate a hostname when not supplied by the client ddns generated prefix string optional the prefix used in the generation of an fqdn when generating a name, dhcp server will construct the name in the format is \[ddns generated prefix] \[address text] \[ddns qualifying suffix] where address text is simply the lease ip address converted to a hyphenated string ddns send updates boolean optional determines if ddns updates are enabled at the subnet level ddns ttl percent number optional ddns ttl value to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage it is specified as a percentage (e g 25, 75) ddns update on renew boolean optional instructs the dhcp server to always update the dns information when a lease is renewed even if its dns information has not changed ddns use conflict resolution boolean optional when true, dhcp server will apply conflict resolution, as described in rfc 4703, when attempting to fulfill the update request when false, dhcp server will simply attempt to update the dns entries per the request, regardless of whether or not they conflict with existing entries owned by other dhcp4 clients input example {"path parameters" {"subnet id" "591d65cb 1f08 11ef 9e44 e26969575d2b"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result address string result of the operation result asm config object result of the operation result asm config asm threshold number result of the operation result asm config enable boolean result of the operation result asm config enable notification boolean result of the operation result asm config forecast period number result of the operation result asm config growth factor number result of the operation result asm config growth type string type of the resource result asm config history number result of the operation result asm config min total number result of the operation result asm config min unused number result of the operation result asm config reenable date string result of the operation result asm scope flag number result of the operation result cidr number unique identifier result comment string result of the operation result compartment id string unique identifier result created at string result of the operation result ddns client update string result of the operation result ddns conflict resolution mode string result of the operation result ddns domain string result of the operation result ddns generate name boolean name of the resource result ddns generated prefix string result of the operation output example {"result" {"address" "string","asm config" {"asm threshold" 123,"enable"\ true,"enable notification"\ true,"forecast period" 123,"growth factor" 123,"growth type" "string","history" 123,"min total" 123,"min unused" 123,"reenable date" "string"},"asm scope flag" 123,"cidr" 123,"comment" "string","compartment id" "string","created at" "string","ddns client update" "string","ddns conflict resolution mode" "string","ddns domain" "string","ddns generate name"\ true,"ddns generated prefix" "string","ddns response headers header description example cache control directives for caching mechanisms no cache, no store, max age=0, must revalidate connection http response header connection keep alive content length the length of the response body in bytes 1895 content type the media type of the resource application/json date the date and time at which the message was originated mon, 10 jun 2024 05 48 53 gmt grpc metadata content type http response header grpc metadata content type application/grpc strict transport security http response header strict transport security max age=31536000; includesubdomains transfer encoding http response header transfer encoding chunked