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 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 address block id string required address block id output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id string unique identifier space string output field space address string output field address protocol string output field protocol comment string output field comment parent string output field parent range object output field range interface string output field interface state string output field state usage array output field usage dhcp info object output field dhcp info names array name of the resource file name string name of the resource file string output field file host object output field host hwaddr string output field hwaddr tags object output field tags created at string output field created at updated at string output field updated at discovery attrs object output field discovery attrs discovery metadata object response data disable dhcp boolean output field disable dhcp example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "results" \[] } } ] 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 range id string required range id output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id string unique identifier space string output field space address string output field address protocol string output field protocol comment string output field comment parent string output field parent range string output field range interface string output field interface state string output field state usage array output field usage dhcp info object output field dhcp info names array name of the resource file name string name of the resource file string output field file host object output field host hwaddr string output field hwaddr tags object output field tags created at string output field created at updated at string output field updated at discovery attrs object output field discovery attrs discovery metadata object response data disable dhcp boolean output field disable dhcp example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "results" \[] } } ] 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 subnet id string required subnet id output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id string unique identifier space string output field space address string output field address protocol string output field protocol comment string output field comment parent string output field parent range object output field range interface string output field interface state string output field state usage array output field usage dhcp info object output field dhcp info names array name of the resource file name string name of the resource file string output field file host object output field host hwaddr string output field hwaddr tags object output field tags created at string output field created at updated at string output field updated at discovery attrs object output field discovery attrs discovery metadata object response data disable dhcp boolean output field disable dhcp 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 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation description string output field description id string unique identifier job id string unique identifier example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 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 required 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation description string output field description id string unique identifier job id string unique identifier 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" {} } } ] 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 required 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 required the resource identifier output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation job id string unique identifier id string unique identifier description string output field description errors array error message if any file name string name of the resource file string output field file 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 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 required the resource identifier output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation description string output field description id string unique identifier job id string unique identifier 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" {} } } ] 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 required 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 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 enable boolean optional indicates if automated scope management is enabled enable notification boolean optional indicates if asm should send notifications to the user forecast period number optional the forecast period in days growth factor number optional indicates the growth in the number or percentage of ip addresses growth type string optional the type of factor to use are percent or count history number optional the minimum amount of history needed before asm can run on this subnet min total number optional the minimum size of range needed for asm to run on this subnet 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 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 required 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 share fingerprint object optional the inheritance configuration for a field of type bool 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 source string optional the resource identifier name string required 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 prl array optional the value to use to match the parameter request list option (option 55) a string of intergers prefix string optional the value to use to match the first three bytes of the hardware address vendor string optional the value to use to match the vendor class id option (option 60) 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation class string output field class comment string output field comment created at string output field created at defined by string output field defined by id string unique identifier inheritance sources object output field inheritance sources name string name of the resource precedence number output field precedence rules array output field rules file name string name of the resource file string output field file share fingerprint boolean output field share fingerprint tags object output field tags updated at string output field updated at 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" {} } } ] 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 required 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 name string required the name expressed as a single label or fqdn 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 required the resource identifier output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation address string output field address comment string output field comment compartment id string unique identifier created at string output field created at dhcp info object output field dhcp info disable dhcp boolean output field disable dhcp discovery attrs object output field discovery attrs discovery metadata object response data host object output field host hwaddr string output field hwaddr id string unique identifier interface string output field interface names array name of the resource file name string name of the resource file string output field file parent string output field parent protocol string output field protocol range object output field range space string output field space state string output field state tags object output field tags updated at string output field updated at example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 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 enable boolean optional indicates if automated scope management is enabled enable notification boolean optional indicates if asm should send notifications to the user forecast period number optional the forecast period in days growth factor number optional indicates the growth in the number or percentage of ip addresses growth type string optional the type of factor to use are percent or count history number optional the minimum amount of history needed before asm can run on this subnet min total number optional the minimum size of range needed for asm to run on this subnet 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 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 abandoned reclaim time number optional the abandoned reclaim time in seconds for ipv4 clients output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix ddns send updates boolean output field ddns send updates ddns ttl percent number output field ddns ttl percent example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 address string required field usage depends on the operation ref string required the resource identifier 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 alias boolean optional when true, the name is treated as an alias name string required a name for the host primary name boolean optional when true, the name field is treated as primary name zone string required the resource identifier name string required 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation addresses array output field addresses file name string name of the resource file string output field file auto generate records boolean output field auto generate records comment string output field comment created at string output field created at host names array name of the resource file name string name of the resource file string output field file id string unique identifier name string name of the resource tags object output field tags updated at string output field updated at 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" {} } } ] 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 required the ip address for the dhcp lease in the format “a b c d” within the ip space specified by space field command string required 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 required parameter for create lease command 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 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 address block id string required address block id output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "results" \[] } } ] 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 address block id string required address block id output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "results" \[] } } ] 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 group string optional the resource identifier option code string optional the resource identifier option value string optional the option value type string optional the type of item disable dhcp boolean optional a disabled object is effectively non existent when generating configuration end string required the end ip address of the range exclusion ranges array optional the exclusionrange object represents an exclusion range inside a dhcp range comment string optional the description for the exclusion range may contain 0 to 1024 characters can include utf 8 end string required the end address of the exclusion range 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 access string optional the access type of dhcp filter (allow or deny) hardware filter id string optional the resource identifier 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 dhcp options object optional the inheritance configuration for a field that contains list of optionitem action string optional the inheritance setting value array optional the inherited dhcp option values action string optional the inheritance setting source string optional the resource identifier 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation comment string output field comment compartment id string unique identifier created at string output field created at dhcp host object output field dhcp host dhcp options array output field dhcp options file name string name of the resource file string output field file disable dhcp boolean output field disable dhcp end string output field end exclusion ranges array output field exclusion ranges file name string name of the resource file string output field file filters array output field filters file name string name of the resource file string output field file id string unique identifier inheritance assigned hosts array output field inheritance assigned hosts file name string name of the resource file string output field file inheritance parent string output field inheritance parent inheritance sources object output field inheritance sources name string name of the resource example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 required 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 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 enable boolean optional indicates if automated scope management is enabled enable notification boolean optional indicates if asm should send notifications to the user forecast period number optional the forecast period in days growth factor number optional indicates the growth in the number or percentage of ip addresses growth type string optional the type of factor to use are percent or count history number optional the minimum amount of history needed before asm can run on this subnet min total number optional the minimum size of range needed for asm to run on this subnet 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 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 address block id string required address block id output parameter type description status code number http status code of the response reason string response reason phrase 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 fingerprint id string required fingerprint id output parameter type description status code number http status code of the response reason string response reason phrase 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 address id string required address id output parameter type description status code number http status code of the response reason string response reason phrase 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 ip space id string required ip space id output parameter type description status code number http status code of the response reason string response reason phrase 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 host id string required ipam host id output parameter type description status code number http status code of the response reason string response reason phrase 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 range id string required range id output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok" } ] 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 subnet id string required subnet id output parameter type description status code number http status code of the response reason string response reason phrase 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 fingerprint id string required fingerprint id 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation class string output field class comment string output field comment created at string output field created at defined by string output field defined by id string unique identifier inheritance sources object output field inheritance sources name string name of the resource precedence number output field precedence rules array output field rules file name string name of the resource file string output field file share fingerprint boolean output field share fingerprint tags object output field tags updated at string output field updated at 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" {} } } ] 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 address block id string required address block id 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 address block id string optional address block id contiguous boolean optional indicates whether the ip addresses should belong to a contiguous block count number optional the number of ip addresses requested output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id string unique identifier space string output field space address string output field address protocol string output field protocol comment string output field comment parent string output field parent range object output field range interface string output field interface state string output field state usage array output field usage file name string name of the resource file string output field file dhcp info object output field dhcp info names array name of the resource file name string name of the resource file string output field file host object output field host hwaddr string output field hwaddr tags object output field tags created at string output field created at updated at string output field updated at discovery attrs object output field discovery attrs 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 asm id string required asm id 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation id string unique identifier subnet id string unique identifier range id object unique identifier range start string output field range start range end string output field range end update string date value utilization number output field utilization threshold utilization number output field threshold utilization lookahead number output field lookahead growth number output field growth front start string output field front start front end string output field front end back start string output field back start back end string output field back end both start string output field both start both end string output field both end subnet direction string output field subnet direction subnet address string output field subnet address subnet cidr number unique identifier subnet range object output field subnet range subnet range start string output field subnet range start subnet range end string output field subnet range end 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" {} } } ] 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 fingerprint class id string required fingerprint class 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 id string unique identifier name string name of the resource 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" {} } } ] 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 system fingerprint id string required system fingerprint id 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation id string unique identifier name string name of the resource rules array output field rules prl array output field prl prefix string output field prefix vendor string output field vendor vendor compare string output field vendor compare class string output field class created at object output field created at updated at object output field updated at 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" {} } } ] 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 dns usage id string required dns usage id 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation absolute name string name of the resource address string output field address dns rdata string response data id string unique identifier name string name of the resource record string output field record space string output field space type string type of the resource view string output field view zone string output field zone 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" {} } } ] 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 global lease id string required global lease id 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation id string unique identifier share fingerprint boolean output field share fingerprint 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" {} } } ] 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 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation id string unique identifier share fingerprint boolean output field share fingerprint 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" {} } } ] 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 address id string optional address id 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation address string output field address comment string output field comment compartment id string unique identifier created at string output field created at dhcp info object output field dhcp info disable dhcp boolean output field disable dhcp discovery attrs object output field discovery attrs discovery metadata object response data host object output field host hwaddr string output field hwaddr id string unique identifier interface string output field interface names array name of the resource file name string name of the resource file string output field file parent string output field parent protocol string output field protocol range object output field range space string output field space state string output field state tags object output field tags updated at string output field updated at 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" {} } } ] 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 ip space id string required ip space id 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix ddns send updates boolean output field ddns send updates ddns ttl percent number output field ddns ttl percent 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" {} } } ] 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 host id string required ipam host id 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 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation addresses array output field addresses file name string name of the resource file string output field file auto generate records boolean output field auto generate records comment string output field comment created at string output field created at host names array name of the resource file name string name of the resource file string output field file id string unique identifier name string name of the resource tags object output field tags updated at string output field updated at 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" {} } } ] 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 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 https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/address/addresslist 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 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 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page torder by string optional this parameter is used for sorting by tags tfilter string optional this parameter is used for filtering by tags output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "results" \[] } } ] 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 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 https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/address/addresslist 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 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 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page scope string optional parameter for get list ip addresses address state string optional parameter for get list ip addresses torder by string optional this parameter is used for sorting by tags tfilter string optional this parameter is used for filtering by tags output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation address string output field address comment string output field comment compartment id string unique identifier created at string output field created at dhcp info object output field dhcp info disable dhcp boolean output field disable dhcp discovery attrs object output field discovery attrs discovery metadata object response data host object output field host hwaddr string output field hwaddr id string unique identifier interface string output field interface names array name of the resource file name string name of the resource file string output field file parent string output field parent protocol string output field protocol range object output field range space string output field space state string output field state tags object output field tags updated at string output field updated at 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 address block id string required address block id output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id string unique identifier address string output field address cidr number unique identifier parent object output field parent federated realms array output field federated realms file name string name of the resource file string output field file space string output field space 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 subnet id string required subnet id 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 output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id object unique identifier subnet id string unique identifier range id object unique identifier range start string output field range start range end string output field range end update string date value utilization number output field utilization threshold utilization number output field threshold utilization lookahead number output field lookahead growth number output field growth front start string output field front start front end string output field front end back start string output field back start back end string output field back end both start string output field both start both end string output field both end subnet direction string output field subnet direction subnet address string output field subnet address subnet cidr number unique identifier subnet range object output field subnet range subnet range start string output field subnet range start subnet range end string output field subnet range end 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 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 https //csp infoblox com/apidoc/?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fdhcpleases#/fingerprint class/fingerprint classlist 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 order by string optional a collection of response resources can be sorted by their json tags 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id string unique identifier name string name of the resource 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" \[] } } ] 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 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 https //csp infoblox com/apidoc/?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fdhcpleases#/fingerprint/fingerprintlist 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 order by string optional a collection of response resources can be sorted by their json tags 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page torder by string optional this parameter is used for sorting by tags tfilter string optional this parameter is used for filtering by tags output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation class string output field class comment string output field comment created at string output field created at defined by string output field defined by id string unique identifier inheritance sources object output field inheritance sources name string name of the resource precedence number output field precedence rules array output field rules file name string name of the resource file string output field file share fingerprint boolean output field share fingerprint tags object output field tags updated at string output field updated at 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 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 https //csp infoblox com/apidoc/?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fdhcpleases#/lease/leaselist 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 order by string optional a collection of response resources can be sorted by their json tags 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page torder by string optional this parameter is used for sorting by tags tfilter string optional this parameter is used for filtering by tags output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation file name string name of the resource file string output field file 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 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 https //csp infoblox com/apidoc/?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fdhcpleases#/lease/leaselist 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 order by string optional a collection of response resources can be sorted by their json tags 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page torder by string optional this parameter is used for sorting by tags tfilter string optional this parameter is used for filtering by tags output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id string unique identifier name string name of the resource rules array output field rules prl array output field prl prefix string output field prefix vendor string output field vendor vendor compare string output field vendor compare class string output field class created at object output field created at updated at object output field updated at 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 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 https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/dns usage/dns usagelist 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 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 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation absolute name string name of the resource address string output field address dns rdata string response data id string unique identifier name string name of the resource record string output field record space string output field space type string type of the resource view string output field view zone string output field zone 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 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 https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/ip space/ip spacelist 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 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 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page torder by string optional this parameter is used for sorting by tags tfilter string optional this parameter is used for filtering by tags output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix ddns send updates boolean output field ddns send updates ddns ttl percent number output field ddns ttl percent 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 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 https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/address/addresslist 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 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 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page torder by string optional this parameter is used for sorting by tags tfilter string optional this parameter is used for filtering by tags output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation addresses array output field addresses file name string name of the resource file string output field file auto generate records boolean output field auto generate records comment string output field comment created at string output field created at host names array name of the resource file name string name of the resource file string output field file id string unique identifier name string name of the resource tags object output field tags updated at string output field updated at 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 address block id string required unique identifier cidr number optional the cidr value of subnets to be created count number optional number of subnets to generate name string optional name of next available address blocks comment string optional comment of next available address blocks federated realms array optional reserved for future use compartment id string optional the compartment id of the address blocks to be created output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "results" \[] } } ] 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 address block id string required address block id cidr number optional the cidr value of subnets to be created count number optional number of subnets to generate name string optional name of next available subnets comment string optional comment of next available subnets dhcp host string optional reference of onprem host associated with the next available subnets to be created federated realms array optional reserved for future use output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "results" \[] } } ] 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 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 https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/range/rangelist 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 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 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page torder by string optional this parameter is used for sorting by tags tfilter string optional this parameter is used for filtering by tags output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation comment string output field comment compartment id string unique identifier created at string output field created at dhcp host object output field dhcp host dhcp options array output field dhcp options file name string name of the resource file string output field file disable dhcp boolean output field disable dhcp end string output field end exclusion ranges array output field exclusion ranges file name string name of the resource file string output field file filters array output field filters file name string name of the resource file string output field file id string unique identifier inheritance assigned hosts array output field inheritance assigned hosts file name string name of the resource file string output field file inheritance parent string output field inheritance parent inheritance sources object output field inheritance sources name string name of the resource 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 subnet id string required subnet id output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id string unique identifier address string output field address cidr number unique identifier parent object output field parent federated realms array output field federated realms file name string name of the resource file string output field file space string output field space 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 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 https //csp infoblox com/apidoc?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc#/subnet/subnetlist 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 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 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' 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 page token string optional the service defined string used to identify a page of resources a null value indicates the first page torder by string optional this parameter is used for sorting by tags tfilter string optional this parameter is used for filtering by tags output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "results" \[] } } ] 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 range id string required range id 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation comment string output field comment compartment id string unique identifier created at string output field created at dhcp host object output field dhcp host dhcp options array output field dhcp options file name string name of the resource file string output field file disable dhcp boolean output field disable dhcp end string output field end exclusion ranges array output field exclusion ranges file name string name of the resource file string output field file filters array output field filters file name string name of the resource file string output field file id string unique identifier inheritance assigned hosts array output field inheritance assigned hosts file name string name of the resource file string output field file inheritance parent string output field inheritance parent inheritance sources object output field inheritance sources name string name of the resource example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 range id string required range id contiguous boolean optional indicates whether the ip addresses should belong to a contiguous block count number optional the number of ip addresses requested output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id string unique identifier space string output field space address string output field address protocol string output field protocol comment string output field comment parent string output field parent range string output field range interface string output field interface state string output field state usage array output field usage file name string name of the resource file string output field file dhcp info object output field dhcp info names array name of the resource file name string name of the resource file string output field file host object output field host hwaddr string output field hwaddr tags object output field tags created at string output field created at updated at string output field updated at discovery attrs object output field discovery attrs 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 subnet id string required subnet id 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 subnet id string required subnet id contiguous boolean optional indicates whether the ip addresses should belong to a contiguous block count number optional the number of ip addresses requested defaults to 1 output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation id string unique identifier space string output field space address string output field address protocol string output field protocol comment string output field comment parent string output field parent range object output field range interface string output field interface state string output field state usage array output field usage file name string name of the resource file string output field file dhcp info object output field dhcp info names array name of the resource file name string name of the resource file string output field file host object output field host hwaddr string output field hwaddr tags object output field tags created at string output field created at updated at string output field updated at discovery attrs object output field discovery attrs 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 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 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 enable boolean optional indicates if automated scope management is enabled enable notification boolean optional indicates if asm should send notifications to the user forecast period number optional the forecast period in days growth factor number optional indicates the growth in the number or percentage of ip addresses growth type string optional the type of factor to use are percent or count history number optional the minimum amount of history needed before asm can run on this subnet min total number optional the minimum size of range needed for asm to run on this subnet 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 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 required 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation id string unique identifier subnet id string unique identifier range id object unique identifier range start string output field range start range end string output field range end update string date value utilization number output field utilization threshold utilization number output field threshold utilization lookahead number output field lookahead growth number output field growth front start string output field front start front end string output field front end back start string output field back start back end string output field back end both start string output field both start both end string output field both end subnet direction string output field subnet direction subnet address string output field subnet address subnet cidr number unique identifier subnet range object output field subnet range subnet range start string output field subnet range start subnet range end string output field subnet range end 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" {} } } ] 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 fingerprint id string required unique identifier class string required 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 share fingerprint object optional the inheritance configuration for a field of type bool 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 source string optional the resource identifier name string required 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 prl array optional the value to use to match the parameter request list option (option 55) a string of intergers prefix string optional the value to use to match the first three bytes of the hardware address vendor string optional the value to use to match the vendor class id option (option 60) 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation class string output field class comment string output field comment created at string output field created at defined by string output field defined by id string unique identifier inheritance sources object output field inheritance sources name string name of the resource precedence number output field precedence rules array output field rules file name string name of the resource file string output field file share fingerprint boolean output field share fingerprint tags object output field tags updated at string output field updated at 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" {} } } ] 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 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation id string unique identifier share fingerprint boolean output field share fingerprint 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" {} } } ] 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 address id string required address id address string required 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 name string required the name expressed as a single label or fqdn 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 required the resource identifier output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation address string output field address comment string output field comment compartment id string unique identifier created at string output field created at dhcp info object output field dhcp info disable dhcp boolean output field disable dhcp discovery attrs object output field discovery attrs discovery metadata object response data host object output field host hwaddr string output field hwaddr id string unique identifier interface string output field interface names array name of the resource file name string name of the resource file string output field file parent string output field parent protocol string output field protocol range object output field range space string output field space state string output field state tags object output field tags updated at string output field updated at 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" {} } } ] 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 ip space id string required ip space id asm config object optional the asmconfig object represents automated scope management configuration 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 enable boolean optional indicates if automated scope management is enabled enable notification boolean optional indicates if asm should send notifications to the user forecast period number optional the forecast period in days growth factor number optional indicates the growth in the number or percentage of ip addresses growth type string optional the type of factor to use are percent or count history number optional the minimum amount of history needed before asm can run on this subnet min total number optional the minimum size of range needed for asm to run on this subnet 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 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix ddns send updates boolean output field ddns send updates ddns ttl percent number output field ddns ttl percent example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 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 address string required field usage depends on the operation ref string required the resource identifier 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 alias boolean optional when true, the name is treated as an alias name string required a name for the host primary name boolean optional when true, the name field is treated as primary name 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation addresses array output field addresses file name string name of the resource file string output field file auto generate records boolean output field auto generate records comment string output field comment created at string output field created at host names array name of the resource file name string name of the resource file string output field file id string unique identifier name string name of the resource tags object output field tags updated at string output field updated at 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" {} } } ] 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 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 group string optional the resource identifier option code string optional the resource identifier option value string optional the option value 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 comment string optional the description for the exclusion range may contain 0 to 1024 characters can include utf 8 end string required the end address of the exclusion range 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 access string optional the access type of dhcp filter (allow or deny) hardware filter id string optional the resource identifier 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 dhcp options object optional the inheritance configuration for a field that contains list of optionitem action string optional the inheritance setting value array optional the inherited dhcp option values action string optional the inheritance setting source string optional the resource identifier output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation comment string output field comment compartment id string unique identifier created at string output field created at dhcp host object output field dhcp host dhcp options array output field dhcp options file name string name of the resource file string output field file disable dhcp boolean output field disable dhcp end string output field end exclusion ranges array output field exclusion ranges file name string name of the resource file string output field file filters array output field filters file name string name of the resource file string output field file id string unique identifier inheritance assigned hosts array output field inheritance assigned hosts file name string name of the resource file string output field file inheritance parent string output field inheritance parent inheritance sources object output field inheritance sources name string name of the resource example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 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 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 enable boolean optional indicates if automated scope management is enabled enable notification boolean optional indicates if asm should send notifications to the user forecast period number optional the forecast period in days growth factor number optional indicates the growth in the number or percentage of ip addresses growth type string optional the type of factor to use are percent or count history number optional the minimum amount of history needed before asm can run on this subnet min total number optional the minimum size of range needed for asm to run on this subnet 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 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 output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation address string output field address asm config object output field asm config asm threshold number output field asm threshold enable boolean output field enable enable notification boolean output field enable notification forecast period number output field forecast period growth factor number output field growth factor growth type string type of the resource history number output field history min total number output field min total min unused number output field min unused reenable date string date value asm scope flag number output field asm scope flag cidr number unique identifier comment string output field comment compartment id string unique identifier created at string output field created at ddns client update string date value ddns conflict resolution mode string output field ddns conflict resolution mode ddns domain string output field ddns domain ddns generate name boolean name of the resource ddns generated prefix string output field ddns generated prefix example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "result" {} } } ] 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 1862 content type the media type of the resource application/json date the date and time at which the message was originated tue, 28 may 2024 06 46 31 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 notes api documentation https //csp infoblox com/apidoc/?url=https%3a%2f%2fcsp infoblox com%2fapidoc%2fdocs%2fipamsvc