Infoblox Bloxone Ddi

The Infoblox BloxOne DDI connector streamlines network management by automating DDI operations and integrating them into security workflows.

Infoblox BloxOne DDI is a cloud-managed network services platform that simplifies and automates critical network tasks. This connector enables seamless integration with Infoblox BloxOne DDI, allowing users to automate IP address management, DNS, and DHCP services. By leveraging this integration, security teams can enhance network visibility, reduce manual tasks, and strengthen their security posture within the Swimlane Turbine platform.

Prerequisites

To effectively utilize the Infoblox BloxOne DDI connector within the Swimlane platform, ensure you have the following prerequisites:

API Key Authentication with the following parameters:

URL: Endpoint for the Infoblox BloxOne DDI API service.

API Key: Unique identifier to authenticate requests to the Infoblox BloxOne DDI API.

Capabilities

This Infoblox BloxOne DDI Connector has following capabilities:

Address

Create IP address

Delete IP Address

Get IP Address

Get List IP Addresses

Update IP Address

Address Block

Allocate Address Block Next Available IP Address

Copy Address Block

Create Address Block

Create Next Available Address Block

Create Next Available Subnet for Address Block

Delete Address Block

Get Address Block Next Available IP Address

Get Address Block

Get List Address Blocks

Get List of Address Block Ancestors

Get List of Next Available Address Blocks

Get List of Next Available Subnet

Update Address Block

ASM

Get ASM by ID

Get List of ASM

Update ASM

DNS Usage

Get DNS Usage by ID

Get List of DNS Usage

Fingerprint

Create DHCP Fingerprint

Delete DHCP Fingerprint

Get a DHCP Fingerprint

Get List of DHCP Fingerprints

Update DHCP Fingerprint

Fingerprint Class

Get List of DHCP Fingerprint Classes

Get DHCP Fingerprint Class

Global Lease

Get GlobalLease

Get Global Lease by ID

Update Global Lease

IPAM Host

Create IPAM Host

Delete IPAM Host by ID

Get IPAM Host by ID

Get List of IPAM Host

Update IPAM Host

IP Space

Copy IP Space Bulk Copy

Copy IP Space

Create IP Space

Delete IP Space

Get IP Space by ID

Get List of IP Spaces

Update IP Space

Lease

Get List of DHCP leases

Lease Command

Create Lease Command

Range

Allocate Range Next Available IP Address

Create Range

Delete Range

Get List of Ranges

Get Range Next Available IP Address

Get Range

Update Range

Subnet

Allocate Subnet Next Available IP Address

Copy Subnet

Create Subnet

Delete Subnet

Get List of Subnet Ancestors

Get List of Subnets

Get Subnet Next Available IP Address

Get Subnet

Update Subnet

System Fingerprint

Get DHCP System Fingerprint

Get List of DHCP System Fingerprints

Notes

API Documentation

Configurations

Infoblox API Key Authentication

Authenticates using an API Key

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
apikey	API key	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Allocate Address Block Next Available IP Address

Allocates the next available IP from a specified address block in Infoblox BloxOne DDI using the 'Address Block ID'.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}/nextavailableip

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Required	Address Block ID

Input Example

{"path_parameters":{"address_block_id":"fdb56d82-1dd6-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	string	Unique identifier
results.space	string	Result of the operation
results.address	string	Result of the operation
results.protocol	string	Result of the operation
results.comment	string	Result of the operation
results.parent	string	Result of the operation
results.range	object	Result of the operation
results.interface	string	Result of the operation
results.state	string	Result of the operation
results.usage	array	Result of the operation
results.dhcp_info	object	Result of the operation
results.names	array	Name of the resource
results.names.file_name	string	Name of the resource
results.names.file	string	Name of the resource
results.host	object	Result of the operation
results.hwaddr	string	Result of the operation
results.tags	object	Result of the operation
results.created_at	string	Result of the operation
results.updated_at	string	Result of the operation
results.discovery_attrs	object	Result of the operation
results.discovery_metadata	object	Response data
results.disable_dhcp	boolean	Result of the operation

Output Example

{"results":[{"id":"12345678-1234-1234-1234-123456789abc","space":"string","address":"string","protocol":"string","comment":"string","parent":"string","range":{},"interface":"string","state":"string","usage":[],"dhcp_info":{},"names":[],"host":{},"hwaddr":"string","tags":{}}]}

Allocate Range Next Available IP Address

Allocates the next available IP address within a specified range in Infoblox BloxOne DDI using the Range ID.

Endpoint

URL: /api/ddi/v1/ipam/range/{{range_id}}/nextavailableip

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.range_id	string	Required	Range ID.

Input Example

{"path_parameters":{"range_id":"b8d8af38-1d88-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	string	Unique identifier
results.space	string	Result of the operation
results.address	string	Result of the operation
results.protocol	string	Result of the operation
results.comment	string	Result of the operation
results.parent	string	Result of the operation
results.range	string	Result of the operation
results.interface	string	Result of the operation
results.state	string	Result of the operation
results.usage	array	Result of the operation
results.dhcp_info	object	Result of the operation
results.names	array	Name of the resource
results.names.file_name	string	Name of the resource
results.names.file	string	Name of the resource
results.host	object	Result of the operation
results.hwaddr	string	Result of the operation
results.tags	object	Result of the operation
results.created_at	string	Result of the operation
results.updated_at	string	Result of the operation
results.discovery_attrs	object	Result of the operation
results.discovery_metadata	object	Response data
results.disable_dhcp	boolean	Result of the operation

Output Example

{"results":[{"id":"12345678-1234-1234-1234-123456789abc","space":"string","address":"string","protocol":"string","comment":"string","parent":"string","range":"string","interface":"string","state":"string","usage":[],"dhcp_info":{},"names":[],"host":{},"hwaddr":"string","tags":{}}]}

Allocate Subnet Next Available IP Address

Allocates the next available IP address within a specified subnet in Infoblox BloxOne DDI using the Subnet ID.

Endpoint

URL: /api/ddi/v1/ipam/subnet/{{subnet_id}}/nextavailableip

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.subnet_id	string	Required	Subnet ID.

Input Example

{"path_parameters":{"subnet_id":"4b96eb17-00c8-11ef-af8c-82dcd2cac46c"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	string	Unique identifier
results.space	string	Result of the operation
results.address	string	Result of the operation
results.protocol	string	Result of the operation
results.comment	string	Result of the operation
results.parent	string	Result of the operation
results.range	object	Result of the operation
results.interface	string	Result of the operation
results.state	string	Result of the operation
results.usage	array	Result of the operation
results.dhcp_info	object	Result of the operation
results.names	array	Name of the resource
results.names.file_name	string	Name of the resource
results.names.file	string	Name of the resource
results.host	object	Result of the operation
results.hwaddr	string	Result of the operation
results.tags	object	Result of the operation
results.created_at	string	Result of the operation
results.updated_at	string	Result of the operation
results.discovery_attrs	object	Result of the operation
results.discovery_metadata	object	Response data
results.disable_dhcp	boolean	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 28 May 2024 06:46:31 GMT","Content-Type":"application/json","Content-Length":"553","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}]}}

Copy Address Block

Creates a duplicate of an AddressBlock object within Infoblox BloxOne DDI for streamlined IP address management.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}/copy

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Optional	Address Block ID.
comment	string	Optional	The description for the copied address block. May contain 0 to 1024 characters. Can include UTF-8.
copy_dhcp_options	boolean	Optional	Indicates whether dhcp options should be copied or not when ipam/address_block object is copied.
name	string	Optional	The name for the copied address block. May contain 1 to 256 characters. Can include UTF-8.
recursive	boolean	Optional	Indicate whether child objects should be copied or not.
skip_on_error	boolean	Optional	Indicates whether copying should skip object in case of error and continue with next, or abort copying in case of error.
space	string	Optional	The resource identifier.

Input Example

{"json_body":{"comment":"string","copy_dhcp_options":true,"name":"string","recursive":true,"skip_on_error":true,"space":"ipam/ip_space/2ec8e03c-d27c-11ee-9595-e6ac2ebb2f62"},"path_parameters":{"address_block_id":"2d1bbb08-00c8-11ef-8c72-d2db0cedb6eb"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.description	string	Result of the operation
result.id	string	Unique identifier
result.job_id	string	Unique identifier

Output Example

{"result":{"description":"string","id":"12345678-1234-1234-1234-123456789abc","job_id":"string"}}

Copy IP Space

Copy an IPSpace object. The IPSpace object represents an entire address space.

Endpoint

URL: /api/ddi/v1/ipam/ip_space/{{ip_space_id}}/copy

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.ip_space_id	string	Required	IP Space ID.
comment	string	Optional	The description for the copied IP space. May contain 0 to 1024 characters. Can include UTF-8.
copy_dhcp_options	boolean	Optional	Indicates whether dhcp options should be copied or not when ipam/ip_space object is copied.
name	string	Optional	The name for the copied IP space. Must contain 1 to 256 characters. Can include UTF-8.
skip_on_error	boolean	Optional	Indicates whether copying should skip an object in case of error and continue with next, or abort copying in case of error.

Input Example

{"json_body":{"comment":"Comment","copy_dhcp_options":false,"name":"Test Copy Space 2","skip_on_error":false},"path_parameters":{"ip_space_id":"2ec8e03c-d27c-11ee-9595-e6ac2ebb2f62"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.description	string	Result of the operation
result.id	string	Unique identifier
result.job_id	string	Unique identifier

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 10 Jun 2024 07:43:59 GMT","Content-Type":"application/json","Content-Length":"212","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"description":"IP Space - JeanTest","id":"ipam/ip_space/2ec8e03c-d27c-11ee-9595-e6ac2ebb2f62","job_id":"blox0.ipam.operation..ivmfiurvguytcmrrgiys2njrgfqs2nbxgjsc2odbmmzc...

Copy IP Space Bulk Copy

Bulk copy AddressBlock and Subnet objects from one IP Space object to another IPSpace object.

Endpoint

URL: /api/ddi/v1/ipam/ip_space/bulk_copy

Method: POST

Input

Argument Name	Type	Required	Description
copy_dhcp_options	boolean	Optional	Indicates whether dhcp options for IPv4 should be copied or not when objects (ipam/address_block and ipam/subnet only) are copied.
copy_objects	array	Optional	The resource identifier.
recursive	boolean	Optional	Indicates whether child objects should be copied or not.
skip_on_error	boolean	Optional	Indicates whether copying should skip object in case of error and continue with next, or abort copying in case of error.
target	string	Optional	The resource identifier.

Input Example

{"json_body":{"copy_dhcp_options":true,"copy_objects":["ipam/subnet/4b96eb17-00c8-11ef-af8c-82dcd2cac46c"],"recursive":true,"skip_on_error":true,"target":"ipam/ip_space/4fbd578f-1668-11ef-88ae-02b76caeb543"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.job_id	string	Unique identifier
results.id	string	Unique identifier
results.description	string	Result of the operation
errors	array	Error message if any
errors.file_name	string	Name of the resource
errors.file	string	Error message if any

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 10 Jun 2024 09:55:02 GMT","Content-Type":"application/json","Content-Length":"226","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}],"errors":[]}}

Copy Subnet

Creates a duplicate of a specified subnet object within Infoblox BloxOne DDI, requiring the Subnet ID and space for execution.

Endpoint

URL: /api/ddi/v1/ipam/subnet/{{subnet_id}}/copy

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.subnet_id	string	Required	Subnet ID.
comment	string	Optional	The description for the copied subnet. May contain 0 to 1024 characters. Can include UTF-8.
copy_dhcp_options	boolean	Optional	Indicates whether dhcp options should be copied or not when ipam/subnet object is copied.
name	string	Optional	The name for the copied subnet. May contain 1 to 256 characters. Can include UTF-8.
recursive	boolean	Optional	Indicates whether child objects should be copied or not.
skip_on_error	boolean	Optional	Indicates whether copying should skip object in case of error and continue with next, or abort copying in case of error.
space	string	Optional	The resource identifier.

Input Example

{"json_body":{"comment":"subnet copy","copy_dhcp_options":false,"name":"test subnet copy 1","recursive":false,"skip_on_error":false,"space":"ipam/ip_space/8ae90580-d1d1-11ee-b311-4225b3276a4c"},"path_parameters":{"subnet_id":"79aecbe4-1b57-11ef-8447-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.description	string	Result of the operation
result.id	string	Unique identifier
result.job_id	string	Unique identifier

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 28 May 2024 06:27:13 GMT","Content-Type":"application/json","Content-Length":"214","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"description":"Subnet - 192.168.1.0/32","id":"ipam/subnet/79aecbe4-1b57-11ef-8447-2ad8f1f3d115","job_id":"blox0.ipam.operation..ivmfiutggy2wimlggzrc2zrvg42s2nbsmjss2yjqgu...

Create Address Block

Generates an AddressBlock object in Infoblox BloxOne DDI, enabling address space management and supporting administrative functions.

Endpoint

URL: /api/ddi/v1/ipam/address_block

Method: POST

Input

Argument Name	Type	Required	Description
address	string	Optional	The address field in form “a.b.c.d/n” where the “/n” may be omitted. In this case, the CIDR value must be defined in the cidr field. When reading, the address field is always in the form “a.b.c.d”.
asm_config	object	Optional	The ASMConfig object represents Automated Scope Management configuration.
asm_config.asm_threshold	number	Optional	ASM shows the number of addresses forecast to be used forecast_period days in the future, if it is greater than asm_threshold percent * dhcp_total (see dhcp_utilization) then the subnet is flagged.
asm_config.enable	boolean	Optional	Indicates if Automated Scope Management is enabled.
asm_config.enable_notification	boolean	Optional	Indicates if ASM should send notifications to the user.
asm_config.forecast_period	number	Optional	The forecast period in days.
asm_config.growth_factor	number	Optional	Indicates the growth in the number or percentage of IP addresses.
asm_config.growth_type	string	Optional	The type of factor to use are percent or count.
asm_config.history	number	Optional	The minimum amount of history needed before ASM can run on this subnet.
asm_config.min_total	number	Optional	The minimum size of range needed for ASM to run on this subnet.
asm_config.min_unused	number	Optional	The minimum percentage of addresses that must be available outside of the DHCP ranges and fixed addresses when making a suggested change.
asm_config.reenable_date	string	Optional	Date value
cidr	number	Optional	The CIDR of the address block. This is required, if address does not specify it in its input. maximum is 128 and minimum is 1.
comment	string	Optional	The description for the address block. May contain 0 to 1024 characters. Can include UTF-8.
compartment_id	string	Optional	Reserved for future use.
ddns_client_update	string	Optional	Controls who does the DDNS updates.
ddns_conflict_resolution_mode	string	Optional	The mode used for resolving conflicts while performing DDNS updates.
ddns_domain	string	Optional	The domain suffix for DDNS updates. FQDN, may be empty.
ddns_generate_name	boolean	Optional	Indicates if DDNS needs to generate a hostname when not supplied by the client.
ddns_generated_prefix	string	Optional	The prefix used in the generation of an FQDN. When generating a name, DHCP server will construct the name in the format is [ddns-generated-prefix]-[address-text].[ddns-qualifying-suffix]. where address-text is simply the lease IP address converted to a hyphenated string.
ddns_send_updates	boolean	Optional	Determines if DDNS updates are enabled at the address block level.
ddns_ttl_percent	number	Optional	DDNS TTL value - to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage. It is specified as a percentage (e.g. 25, 75).
ddns_update_on_renew	boolean	Optional	Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed.
ddns_use_conflict_resolution	boolean	Optional	When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients.
dhcp_config	object	Optional	A DHCP Config object (dhcp/dhcp_config) represents a shared DHCP configuration that controls how leases are issued.

Input Example

{"address":"string","asm_config":{"asm_threshold":123,"enable":true,"enable_notification":true,"forecast_period":123,"growth_factor":123,"growth_type":"string","history":123,"min_total":123,"min_unused":123,"reenable_date":"string"},"cidr":123,"comment":"string","compartment_id":"string","ddns_client_update":"client","ddns_conflict_resolution_mode":"check_with_dhcid","ddns_domain":"string","ddns_generate_name":true,"ddns_generated_prefix":"myhost","ddns_send_updates":true,"ddns_ttl_percent":123,"ddns_update_on_renew":true,"ddns_use_conflict_resolution":true,"dhcp_config":{"abandoned_reclaim_time":123,"abandoned_reclaim_time_v6":123,"allow_unknown":true,"allow_unknown_v6":true,"echo_client_id":true,"filters":["string"],"filters_large_selection":["string"],"filters_v6":["string"],"ignore_client_uid":true,"ignore_list":[{"type":"string","value":"string"}],"lease_time":123,"lease_time_v6":123},"dhcp_options":[{"group":"string","option_code":"string","option_value":"string","type":"string"}],"discovery_attrs":{},"discovery_metadata":{},"federated_realms":["string"],"header_option_filename":"Example Name","header_option_server_address":"string","header_option_server_name":"Example Name","hostname_rewrite_char":"Example Name","hostname_rewrite_enabled":true,"hostname_rewrite_regex":"Example Name","inheritance_parent":"string","inheritance_sources":{"asm_config":{"asm_enable_block":{"action":"string","source":"string","value":{}},"asm_growth_block":{"action":"inherit","source":"string","value":{}},"asm_threshold":{"action":"inherit","source":"string"},"forecast_period":{"action":"inherit","source":"string"},"history":{"action":"inherit","source":"string"},"min_total":{"action":"inherit","source":"string"},"min_unused":{"action":"inherit","source":"string"}},"ddns_client_update":{"action":"inherit","source":"string"},"ddns_conflict_resolution_mode":{"action":"inherit","source":"string"},"ddns_enabled":{"action":"inherit","source":"string"},"ddns_hostname_block":{"action":"inherit","source":"string","value":{"ddns_generate_name":true,"ddns_generated_prefix":"string"}},"ddns_ttl_percent":{"action":"inherit","source":"string"},"ddns_update_block":{"action":"inherit","source":"string","value":{"ddns_domain":"string","ddns_send_updates":true}},"ddns_update_on_renew":{"action":"inherit","source":"string"},"ddns_use_conflict_resolution":{"action":"inherit","source":"string"},"dhcp_config":{"abandoned_reclaim_time":{"action":"inherit","source":"string"},"abandoned_reclaim_time_v6":{"action":"inherit","source":"string"},"allow_unknown":{"action":"inherit","source":"string"},"allow_unknown_v6":{"action":"inherit","source":"string"},"echo_client_id":{"action":"inherit","source":"string"},"filters":{"action":"inherit","source":"string","value":["string"]},"filters_v6":{"action":"inherit","source":"string","value":["string"]},"ignore_client_uid":{"action":"inherit","source":"string"},"ignore_list":{"action":"inherit","source":"string"},"lease_time":{"action":"inherit","source":"string"},"lease_time_v6":{"action":"inherit","source":"string"}},"dhcp_options":{"action":"inherit","value":[{"action":"inherit","source":"string","value":{}}]},"header_option_filename":{"action":"inherit","source":"string"},"header_option_server_address":{"action":"inherit","source":"string"},"header_option_server_name":{"action":"inherit","source":"string"},"hostname_rewrite_block":{"action":"inherit","source":"string","value":{"hostname_rewrite_char":"Example Name","hostname_rewrite_enabled":true,"hostname_rewrite_regex":"Example Name"}}},"name":"Example Name","parent":"string","space":"string","tags":{},"threshold":{"enabled":true,"high":123,"low":123},"utilization_v6":{"abandoned":{"raw_value":"string"},"dynamic":{"raw_value":"string"},"static":{"raw_value":"string"},"total":{"raw_value":"string"},"used":{"raw_value":"string"}}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.address	string	Result of the operation
result.asm_config	object	Result of the operation
result.asm_config.asm_threshold	number	Result of the operation
result.asm_config.enable	boolean	Result of the operation
result.asm_config.enable_notification	boolean	Result of the operation
result.asm_config.forecast_period	number	Result of the operation
result.asm_config.growth_factor	number	Result of the operation
result.asm_config.growth_type	string	Type of the resource
result.asm_config.history	number	Result of the operation
result.asm_config.min_total	number	Result of the operation
result.asm_config.min_unused	number	Result of the operation
result.asm_config.reenable_date	string	Result of the operation
result.asm_scope_flag	number	Result of the operation
result.cidr	number	Unique identifier
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.ddns_client_update	string	Result of the operation
result.ddns_conflict_resolution_mode	string	Result of the operation
result.ddns_domain	string	Result of the operation
result.ddns_generate_name	boolean	Name of the resource
result.ddns_generated_prefix	string	Result of the operation

Output Example

{"result":{"address":"string","asm_config":{"asm_threshold":123,"enable":true,"enable_notification":true,"forecast_period":123,"growth_factor":123,"growth_type":"string","history":123,"min_total":123,"min_unused":123,"reenable_date":"string"},"asm_scope_flag":123,"cidr":123,"comment":"string","compartment_id":"string","created_at":"string","ddns_client_update":"string","ddns_conflict_resolution_mode":"string","ddns_domain":"string","ddns_generate_name":true,"ddns_generated_prefix":"string","ddns...

Create DHCP Fingerprint

Creates a DHCP Fingerprint object in Infoblox BloxOne DDI with specified rules for client identification.

Endpoint

URL: /api/ddi/v1/dhcp/fingerprint

Method: POST

Input

Argument Name	Type	Required	Description
class	string	Optional	DHCP Fingerprint Class ID.
comment	string	Optional	The description for the DHCP fingerprint. May contain 0 to 1024 characters. Can include UTF-8.
inheritance_sources	object	Optional	The inheritance configuration specifies how share_fingerprint is inherited.
inheritance_sources.share_fingerprint	object	Optional	The inheritance configuration for a field of type Bool.
inheritance_sources.share_fingerprint.action	string	Optional	The inheritance setting for a field. Valid values are inherit,override. Inherit - Use the inherited value. Override - Use the value set in the object.
inheritance_sources.share_fingerprint.source	string	Optional	The resource identifier.
name	string	Optional	The name of the DHCP fingerprint. Must contain 1 to 256 characters. Can include UTF-8.
precedence	number	Optional	Integer (1-N) defining priority order of DHCP fingerprints; smaller means higher precedence. Maximum is 2147483647
rules	array	Optional	The collection of fingerprint rules for the DHCP fingerprint. A FingerprintRule object (dhcp/fingerprint_rule) represents a DHCP fingerprint rule. A lease matches a fingerprint rule if all of the sub-rules evaluate to true. If a sub-rule doesn’t include a value (it has been left empty) it evaluates to true.
rules.prl	array	Optional	The value to use to match the parameter request list option (option 55). A string of intergers.
rules.prefix	string	Optional	The value to use to match the first three bytes of the hardware address.
rules.vendor	string	Optional	The value to use to match the vendor class ID option (option 60).
rules.vendor_compare	string	Optional	The operation to use when matching the vendor class ID.
share_fingerprint	boolean	Optional	Indicates if the DHCP fingerprint should be shared with Infoblox. This is only applicable for custom fingerprints. Defaults to true for custom fingerprints.
tags	object	Optional	The tags for the DHCP fingerprint in JSON format.

Input Example

{"json_body":{"class":"dhcp/fingerprint_class/0acf3996-6f31-47b6-8c57-4666df9743b2","comment":"cool","inheritance_sources":{"share_fingerprint":{"action":"inherit","source":"string"}},"name":"Testing Fingerprint 1.2","precedence":1,"rules":[{"prl":["1","3","6","42","12","15","31","33","43"],"prefix":"","vendor":"0acf3996-6f31-47b6-8c57-4666df9743b2","vendor_compare":"equals"}],"share_fingerprint":true,"tags":{}}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.class	string	Result of the operation
result.comment	string	Result of the operation
result.created_at	string	Result of the operation
result.defined_by	string	Result of the operation
result.id	string	Unique identifier
result.inheritance_sources	object	Result of the operation
result.name	string	Name of the resource
result.precedence	number	Result of the operation
result.rules	array	Result of the operation
result.rules.file_name	string	Name of the resource
result.rules.file	string	Result of the operation
result.share_fingerprint	boolean	Result of the operation
result.tags	object	Result of the operation
result.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 20 May 2024 05:42:13 GMT","Content-Type":"application/json","Content-Length":"392","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"class":"dhcp/fingerprint_class/0acf3996-6f31-47b6-8c57-4666df9743b2","comment":"","created_at":"2024-05-20T05:42:13.167635567Z","defined_by":"user","id":"dhcp/fingerprin...

Create IP address

Creates an Address object in Infoblox BloxOne DDI, representing a single IP within a specified space. Requires 'address' and 'space' parameters.

Endpoint

URL: /api/ddi/v1/ipam/address

Method: POST

Input

Argument Name	Type	Required	Description
address	string	Optional	The address in form "a.b.c.d".
comment	string	Optional	The description for the address object. May contain 0 to 1024 characters. Can include UTF-8.
discovery_attrs	object	Optional	The discovery attributes for this address in JSON format.
discovery_metadata	object	Optional	The discovery metadata for this address in JSON format.
host	string	Optional	The resource identifier.
hwaddr	string	Optional	The hardware address associated with this IP address.
interface	string	Optional	The name of the network interface card (NIC) associated with the address, if any.
names	array	Optional	The list of all names associated with this address.
names.name	string	Required	The name expressed as a single label or FQDN.
names.type	string	Required	The origin of the name.
parent	string	Optional	The resource identifier.
range	string	Optional	The resource identifier.
tags	object	Optional	Parameter for Create IP address
space	string	Optional	The resource identifier.

Input Example

{"json_body":{"address":"192.168.1.0","comment":"string","discovery_attrs":{},"discovery_metadata":{},"host":"string","hwaddr":"string","interface":"string","names":[{"name":"string","type":"string"}],"parent":"string","range":"string","tags":{},"space":"ipam/ip_space/2ec8e03c-d27c-11ee-9595-e6ac2ebb2f62"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.address	string	Result of the operation
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.dhcp_info	object	Result of the operation
result.disable_dhcp	boolean	Result of the operation
result.discovery_attrs	object	Result of the operation
result.discovery_metadata	object	Response data
result.host	object	Result of the operation
result.hwaddr	string	Result of the operation
result.id	string	Unique identifier
result.interface	string	Result of the operation
result.names	array	Name of the resource
result.names.file_name	string	Name of the resource
result.names.file	string	Name of the resource
result.parent	string	Result of the operation
result.protocol	string	Result of the operation
result.range	object	Result of the operation
result.space	string	Result of the operation
result.state	string	Result of the operation
result.tags	object	Result of the operation
result.updated_at	string	Result of the operation

Output Example

{"result":{"address":"string","comment":"string","compartment_id":"string","created_at":"string","dhcp_info":{},"disable_dhcp":true,"discovery_attrs":{},"discovery_metadata":{},"host":{},"hwaddr":"string","id":"12345678-1234-1234-1234-123456789abc","interface":"string","names":[{}],"parent":"string","protocol":"string"}}

Create IP Space

Create an IPSpace object. The IPSpace object represents an entire address space.

Endpoint

URL: /api/ddi/v1/ipam/ip_space

Method: POST

Input

Argument Name	Type	Required	Description
asm_config	object	Optional	The ASMConfig object represents Automated Scope Management configuration.
asm_config.asm_threshold	number	Optional	ASM shows the number of addresses forecast to be used forecast_period days in the future, if it is greater than asm_threshold percent * dhcp_total (see dhcp_utilization) then the subnet is flagged.
asm_config.enable	boolean	Optional	Indicates if Automated Scope Management is enabled.
asm_config.enable_notification	boolean	Optional	Indicates if ASM should send notifications to the user.
asm_config.forecast_period	number	Optional	The forecast period in days.
asm_config.growth_factor	number	Optional	Indicates the growth in the number or percentage of IP addresses.
asm_config.growth_type	string	Optional	The type of factor to use are percent or count.
asm_config.history	number	Optional	The minimum amount of history needed before ASM can run on this subnet.
asm_config.min_total	number	Optional	The minimum size of range needed for ASM to run on this subnet.
asm_config.min_unused	number	Optional	The minimum percentage of addresses that must be available outside of the DHCP ranges and fixed addresses when making a suggested change.
asm_config.reenable_date	string	Optional	Date value
comment	string	Optional	The description for the IP space. May contain 0 to 1024 characters. Can include UTF-8.
compartment_id	string	Optional	Reserved for future use.
ddns_client_update	string	Optional	Controls who does the DDNS updates.
ddns_conflict_resolution_mode	string	Optional	The mode used for resolving conflicts while performing DDNS updates.
ddns_domain	string	Optional	The domain suffix for DDNS updates. FQDN, may be empty.
ddns_generate_name	boolean	Optional	Indicates if DDNS needs to generate a hostname when not supplied by the client.
ddns_generated_prefix	string	Optional	The prefix used in the generation of an FQDN. When generating a name, DHCP server will construct the name in the format is [ddns-generated-prefix]-[address-text].[ddns-qualifying-suffix]. where address-text is simply the lease IP address converted to a hyphenated string.
ddns_send_updates	boolean	Optional	Determines if DDNS updates are enabled at the IP space level.
ddns_ttl_percent	number	Optional	DDNS TTL value - to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage. It is specified as a percentage (e.g. 25, 75).
ddns_update_on_renew	boolean	Optional	Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed.
ddns_use_conflict_resolution	boolean	Optional	When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients.
default_realms	array	Optional	Reserved for future use.
dhcp_config	object	Optional	A DHCP Config object (dhcp/dhcp_config) represents a shared DHCP configuration that controls how leases are issued.
dhcp_config.abandoned_reclaim_time	number	Optional	The abandoned reclaim time in seconds for IPV4 clients.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.asm_config	object	Result of the operation
result.asm_config.asm_threshold	number	Result of the operation
result.asm_config.enable	boolean	Result of the operation
result.asm_config.enable_notification	boolean	Result of the operation
result.asm_config.forecast_period	number	Result of the operation
result.asm_config.growth_factor	number	Result of the operation
result.asm_config.growth_type	string	Type of the resource
result.asm_config.history	number	Result of the operation
result.asm_config.min_total	number	Result of the operation
result.asm_config.min_unused	number	Result of the operation
result.asm_config.reenable_date	string	Result of the operation
result.asm_scope_flag	number	Result of the operation
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.ddns_client_update	string	Result of the operation
result.ddns_conflict_resolution_mode	string	Result of the operation
result.ddns_domain	string	Result of the operation
result.ddns_generate_name	boolean	Name of the resource
result.ddns_generated_prefix	string	Result of the operation
result.ddns_send_updates	boolean	Result of the operation
result.ddns_ttl_percent	number	Result of the operation

Output Example

{"result":{"asm_config":{"asm_threshold":123,"enable":true,"enable_notification":true,"forecast_period":123,"growth_factor":123,"growth_type":"string","history":123,"min_total":123,"min_unused":123,"reenable_date":"string"},"asm_scope_flag":123,"comment":"string","compartment_id":"string","created_at":"string","ddns_client_update":"string","ddns_conflict_resolution_mode":"string","ddns_domain":"string","ddns_generate_name":true,"ddns_generated_prefix":"string","ddns_send_updates":true,"ddns_ttl_...

Create IPAM Host

Create an IpamHost object. The IpamHost object (ipam/host) represents any network connected equipment that is assigned one or more IP Addresses.

Endpoint

URL: /api/ddi/v1/ipam/host

Method: POST

Input

Argument Name	Type	Required	Description
addresses	array	Optional	The list of all addresses associated with the IPAM host, which may be in different IP spaces.
addresses.address	string	Required	Field usage depends on the operation.
addresses.ref	string	Required	The resource identifier.
addresses.space	string	Required	The resource identifier.
auto_generate_records	boolean	Optional	This flag specifies if resource records have to be auto generated for the host.
comment	string	Optional	The description for the IPAM host. May contain 0 to 1024 characters. Can include UTF-8.
host_names	array	Optional	The name records to be generated for the host.
host_names.alias	boolean	Optional	When true, the name is treated as an alias.
host_names.name	string	Required	A name for the host.
host_names.primary_name	boolean	Optional	When true, the name field is treated as primary name.
host_names.zone	string	Required	The resource identifier.
name	string	Optional	The name of the IPAM host. Must contain 1 to 256 characters. Can include UTF-8.
tags	object	Optional	The tags for the IPAM host in JSON format.

Input Example

{"json_body":{"addresses":[{"address":"Address","ref":"ipam/ip_space/a8d3f3dc-1d7f-11ef-8de7-2ad8f1f3d115","space":"ipam/ip_space/a8d3f3dc-1d7f-11ef-8de7-2ad8f1f3d115"}],"auto_generate_records":true,"comment":"commented","host_names":[{"alias":true,"name":"string","primary_name":true,"zone":"ipam/host/a8d3f3dc-1d7f-11ef-8de7-2ad8f1f3d115"}],"name":"Test IPAM Host 1.5","tags":{}}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.addresses	array	Result of the operation
result.addresses.file_name	string	Name of the resource
result.addresses.file	string	Result of the operation
result.auto_generate_records	boolean	Result of the operation
result.comment	string	Result of the operation
result.created_at	string	Result of the operation
result.host_names	array	Name of the resource
result.host_names.file_name	string	Name of the resource
result.host_names.file	string	Name of the resource
result.id	string	Unique identifier
result.name	string	Name of the resource
result.tags	object	Result of the operation
result.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Fri, 07 Jun 2024 06:54:19 GMT","Content-Type":"application/json","Content-Length":"270","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"addresses":[],"auto_generate_records":false,"comment":"","created_at":"2024-06-07T06:54:19.107977510Z","host_names":[],"id":"ipam/host/c33fb6e8-249a-11ef-9448-02b8a458f3...

Create Lease Command

Executes a specified command on a DHCP lease within Infoblox BloxOne DDI, requiring an address, command, and space.

Endpoint

URL: /api/ddi/v1/dhcp/lease_command

Method: POST

Input

Argument Name	Type	Required	Description
address	string	Optional	The IP address for the DHCP lease in the format “a.b.c.d” within the IP space specified by space field.
command	string	Optional	The command to perform on the lease. Valid values clear and resend-ddns. Clear means Removes the lease defined by (space, address) from the DHCP server(s). This will NOT affect the client that issued the lease. Resend-DDNS means Resends a request to kea-dhcp-ddns to update DNS for an existing lease defined by (space, address).
space	string	Optional	Parameter for Create Lease Command

Input Example

{"json_body":{"address":"string","command":"string","space":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
success	string	Whether the operation was successful

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 19 May 2024 16:41:46 GMT","Content-Type":"application/json","Content-Length":"773","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"success":"string"}}

Create Next Available Address Block

Allocates a new IPAM address block from available resources in Infoblox BloxOne DDI using the specified Address Block ID.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}/nextavailableaddressblock

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Required	Address Block ID.

Input Example

{"path_parameters":{"address_block_id":"fdb56d82-1dd6-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.address	string	Result of the operation
results.asm_config	object	Result of the operation
results.asm_config.asm_threshold	number	Result of the operation
results.asm_config.enable	boolean	Result of the operation
results.asm_config.enable_notification	boolean	Result of the operation
results.asm_config.forecast_period	number	Result of the operation
results.asm_config.growth_factor	number	Result of the operation
results.asm_config.growth_type	string	Type of the resource
results.asm_config.history	number	Result of the operation
results.asm_config.min_total	number	Result of the operation
results.asm_config.min_unused	number	Result of the operation
results.asm_config.reenable_date	string	Result of the operation
results.asm_scope_flag	number	Result of the operation
results.cidr	number	Unique identifier
results.comment	string	Result of the operation
results.compartment_id	string	Unique identifier
results.created_at	string	Result of the operation
results.ddns_client_update	string	Result of the operation
results.ddns_conflict_resolution_mode	string	Result of the operation
results.ddns_domain	string	Result of the operation
results.ddns_generate_name	boolean	Name of the resource
results.ddns_generated_prefix	string	Result of the operation

Output Example

{"results":[{"address":"string","asm_config":{},"asm_scope_flag":123,"cidr":123,"comment":"string","compartment_id":"string","created_at":"string","ddns_client_update":"string","ddns_conflict_resolution_mode":"string","ddns_domain":"string","ddns_generate_name":true,"ddns_generated_prefix":"string","ddns_send_updates":true,"ddns_ttl_percent":123,"ddns_update_on_renew":true}]}

Create Next Available Subnet for Address Block

Allocates a new IPAM/subnet resource from available subnets within a specified address block in Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}/nextavailablesubnet

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Required	Address Block ID.

Input Example

{"path_parameters":{"address_block_id":"fdb56d82-1dd6-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.address	string	Result of the operation
results.asm_config	object	Result of the operation
results.asm_config.asm_threshold	number	Result of the operation
results.asm_config.enable	boolean	Result of the operation
results.asm_config.enable_notification	boolean	Result of the operation
results.asm_config.forecast_period	number	Result of the operation
results.asm_config.growth_factor	number	Result of the operation
results.asm_config.growth_type	string	Type of the resource
results.asm_config.history	number	Result of the operation
results.asm_config.min_total	number	Result of the operation
results.asm_config.min_unused	number	Result of the operation
results.asm_config.reenable_date	string	Result of the operation
results.asm_scope_flag	number	Result of the operation
results.cidr	number	Unique identifier
results.comment	string	Result of the operation
results.compartment_id	string	Unique identifier
results.created_at	string	Result of the operation
results.ddns_client_update	string	Result of the operation
results.ddns_conflict_resolution_mode	string	Result of the operation
results.ddns_domain	string	Result of the operation
results.ddns_generate_name	boolean	Name of the resource
results.ddns_generated_prefix	string	Result of the operation

Output Example

Create Range

Creates a contiguous range of IP addresses within a specified IP space in Infoblox BloxOne DDI, defined by start and end parameters.

Endpoint

URL: /api/ddi/v1/ipam/range

Method: POST

Input

Argument Name	Type	Required	Description
comment	string	Optional	The description for the range. May contain 0 to 1024 characters. Can include UTF-8.
dhcp_host	string	Optional	The resource identifier.
dhcp_options	array	Optional	An item (dhcp/option_item) in a list of DHCP options. May be either a specific option or a group of options.
dhcp_options.group	string	Optional	The resource identifier.
dhcp_options.option_code	string	Optional	The resource identifier.
dhcp_options.option_value	string	Optional	The option value.
dhcp_options.type	string	Optional	The type of item.
disable_dhcp	boolean	Optional	A disabled object is effectively non-existent when generating configuration.
end	string	Optional	The end IP address of the range.
exclusion_ranges	array	Optional	The ExclusionRange object represents an exclusion range inside a DHCP range.
exclusion_ranges.comment	string	Optional	The description for the exclusion range. May contain 0 to 1024 characters. Can include UTF-8.
exclusion_ranges.end	string	Required	The end address of the exclusion range.
exclusion_ranges.start	string	Required	The start address of the exclusion range.
filters	array	Optional	The AccessFilter object represents an allow/deny filter for a DHCP range.
filters.access	string	Optional	The access type of DHCP filter (allow or deny).
filters.hardware_filter_id	string	Optional	The resource identifier.
filters.option_filter_id	string	Optional	The resource identifier.
inheritance_parent	string	Optional	The resource identifier.
inheritance_sources	object	Optional	The inheritance configuration that specifies how the dhcp_options field is inherited from the parent object.
inheritance_sources.dhcp_options	object	Optional	The inheritance configuration for a field that contains list of OptionItem.
inheritance_sources.dhcp_options.action	string	Optional	The inheritance setting.
inheritance_sources.dhcp_options.value	array	Optional	The inherited DHCP option values.
inheritance_sources.dhcp_options.value.action	string	Optional	The inheritance setting.
inheritance_sources.dhcp_options.value.source	string	Optional	The resource identifier.
inheritance_sources.dhcp_options.value.value	object	Optional	A wrapper of item (dhcp/option_item) in a list of Inherited DHCP options. It contains extra fields not covered by OptionItem.

Input Example

{"comment":"string","dhcp_host":"string","dhcp_options":[{"group":"string","option_code":"string","option_value":"string","type":"string"}],"disable_dhcp":true,"end":"string","exclusion_ranges":[{"comment":"string","end":"string","start":"string"}],"filters":[{"access":"allow","hardware_filter_id":"string","option_filter_id":"string"}],"inheritance_parent":"string","inheritance_sources":{"dhcp_options":{"action":"inherit","value":[{"action":"inherit","source":"string","value":{}}]}},"name":"Example Name","parent":"string","space":"string","start":"string","tags":{},"threshold":{"enabled":true,"high":123,"low":123},"utilization_v6":{"abandoned":{"raw_value":"string"},"dynamic":{"raw_value":"string"},"static":{"raw_value":"string"},"total":{"raw_value":"string"},"used":{"raw_value":"string"}}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.dhcp_host	object	Result of the operation
result.dhcp_options	array	Result of the operation
result.dhcp_options.file_name	string	Name of the resource
result.dhcp_options.file	string	Result of the operation
result.disable_dhcp	boolean	Result of the operation
result.end	string	Result of the operation
result.exclusion_ranges	array	Result of the operation
result.exclusion_ranges.file_name	string	Name of the resource
result.exclusion_ranges.file	string	Result of the operation
result.filters	array	Result of the operation
result.filters.file_name	string	Name of the resource
result.filters.file	string	Result of the operation
result.id	string	Unique identifier
result.inheritance_assigned_hosts	array	Result of the operation
result.inheritance_assigned_hosts.file_name	string	Name of the resource
result.inheritance_assigned_hosts.file	string	Result of the operation
result.inheritance_parent	string	Result of the operation
result.inheritance_sources	object	Result of the operation
result.name	string	Name of the resource

Output Example

{"result":{"comment":"string","compartment_id":"string","created_at":"string","dhcp_host":{},"dhcp_options":[{}],"disable_dhcp":true,"end":"string","exclusion_ranges":[{}],"filters":[{}],"id":"12345678-1234-1234-1234-123456789abc","inheritance_assigned_hosts":[{}],"inheritance_parent":"string","inheritance_sources":{},"name":"Example Name","parent":"string"}}

Create Subnet

Generates a new Subnet object in Infoblox BloxOne DDI using specified address and space parameters.

Endpoint

URL: /api/ddi/v1/ipam/subnet

Method: POST

Input

Argument Name	Type	Required	Description
address	string	Optional	The address of the subnet in the form “a.b.c.d/n” where the “/n” may be omitted. In this case, the CIDR value must be defined in the cidr field. When reading, the address field is always in the form “a.b.c.d”.
asm_config	object	Optional	The ASMConfig object represents Automated Scope Management configuration.
asm_config.asm_threshold	number	Optional	ASM shows the number of addresses forecast to be used forecast_period days in the future, if it is greater than asm_threshold percent * dhcp_total (see dhcp_utilization) then the subnet is flagged.
asm_config.enable	boolean	Optional	Indicates if Automated Scope Management is enabled.
asm_config.enable_notification	boolean	Optional	Indicates if ASM should send notifications to the user.
asm_config.forecast_period	number	Optional	The forecast period in days.
asm_config.growth_factor	number	Optional	Indicates the growth in the number or percentage of IP addresses.
asm_config.growth_type	string	Optional	The type of factor to use are percent or count.
asm_config.history	number	Optional	The minimum amount of history needed before ASM can run on this subnet.
asm_config.min_total	number	Optional	The minimum size of range needed for ASM to run on this subnet.
asm_config.min_unused	number	Optional	The minimum percentage of addresses that must be available outside of the DHCP ranges and fixed addresses when making a suggested change.
asm_config.reenable_date	string	Optional	Date value
cidr	number	Optional	The CIDR of the subnet. This is required, if address does not specify it in its input. maximum is 128 and minimum is 1.
comment	string	Optional	The description for the subnet. May contain 0 to 1024 characters. Can include UTF-8.
compartment_id	string	Optional	Reserved for future use.
ddns_client_update	string	Optional	Controls who does the DDNS updates.
ddns_conflict_resolution_mode	string	Optional	The mode used for resolving conflicts while performing DDNS updates.
ddns_domain	string	Optional	The domain suffix for DDNS updates. FQDN, may be empty.
ddns_generate_name	boolean	Optional	Indicates if DDNS needs to generate a hostname when not supplied by the client.
ddns_generated_prefix	string	Optional	The prefix used in the generation of an FQDN. When generating a name, DHCP server will construct the name in the format is [ddns-generated-prefix]-[address-text].[ddns-qualifying-suffix]. where address-text is simply the lease IP address converted to a hyphenated string.
ddns_send_updates	boolean	Optional	Determines if DDNS updates are enabled at the subnet level.
ddns_ttl_percent	number	Optional	DDNS TTL value - to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage. It is specified as a percentage (e.g. 25, 75).
ddns_update_on_renew	boolean	Optional	Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed.
ddns_use_conflict_resolution	boolean	Optional	When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients.
dhcp_config	object	Optional	A DHCP Config object (dhcp/dhcp_config) represents a shared DHCP configuration that controls how leases are issued.

Input Example

{"address":"string","asm_config":{"asm_threshold":123,"enable":true,"enable_notification":true,"forecast_period":123,"growth_factor":123,"growth_type":"string","history":123,"min_total":123,"min_unused":123,"reenable_date":"string"},"cidr":123,"comment":"string","compartment_id":"string","ddns_client_update":"client","ddns_conflict_resolution_mode":"check_with_dhcid","ddns_domain":"string","ddns_generate_name":true,"ddns_generated_prefix":"myhost","ddns_send_updates":true,"ddns_ttl_percent":123,"ddns_update_on_renew":true,"ddns_use_conflict_resolution":true,"dhcp_config":{"abandoned_reclaim_time":123,"abandoned_reclaim_time_v6":123,"allow_unknown":true,"allow_unknown_v6":true,"echo_client_id":true,"filters":["string"],"filters_large_selection":["string"],"filters_v6":["string"],"ignore_client_uid":true,"ignore_list":[{"type":"string","value":"string"}],"lease_time":123,"lease_time_v6":123},"dhcp_options":[{"group":"string","option_code":"string","option_value":"string","type":"string"}],"discovery_attrs":{},"discovery_metadata":{},"federated_realms":["string"],"header_option_filename":"Example Name","header_option_server_address":"string","header_option_server_name":"Example Name","hostname_rewrite_char":"Example Name","hostname_rewrite_enabled":true,"hostname_rewrite_regex":"Example Name","inheritance_parent":"string","inheritance_sources":{"asm_config":{"asm_enable_block":{"action":"string","source":"string","value":{}},"asm_growth_block":{"action":"inherit","source":"string","value":{}},"asm_threshold":{"action":"inherit","source":"string"},"forecast_period":{"action":"inherit","source":"string"},"history":{"action":"inherit","source":"string"},"min_total":{"action":"inherit","source":"string"},"min_unused":{"action":"inherit","source":"string"}},"ddns_client_update":{"action":"inherit","source":"string"},"ddns_conflict_resolution_mode":{"action":"inherit","source":"string"},"ddns_enabled":{"action":"inherit","source":"string"},"ddns_hostname_block":{"action":"inherit","source":"string","value":{"ddns_generate_name":true,"ddns_generated_prefix":"string"}},"ddns_ttl_percent":{"action":"inherit","source":"string"},"ddns_update_block":{"action":"inherit","source":"string","value":{"ddns_domain":"string","ddns_send_updates":true}},"ddns_update_on_renew":{"action":"inherit","source":"string"},"ddns_use_conflict_resolution":{"action":"inherit","source":"string"},"dhcp_config":{"abandoned_reclaim_time":{"action":"inherit","source":"string"},"abandoned_reclaim_time_v6":{"action":"inherit","source":"string"},"allow_unknown":{"action":"inherit","source":"string"},"allow_unknown_v6":{"action":"inherit","source":"string"},"echo_client_id":{"action":"inherit","source":"string"},"filters":{"action":"inherit","source":"string","value":["string"]},"filters_v6":{"action":"inherit","source":"string","value":["string"]},"ignore_client_uid":{"action":"inherit","source":"string"},"ignore_list":{"action":"inherit","source":"string"},"lease_time":{"action":"inherit","source":"string"},"lease_time_v6":{"action":"inherit","source":"string"}},"dhcp_options":{"action":"inherit","value":[{"action":"inherit","source":"string","value":{}}]},"header_option_filename":{"action":"inherit","source":"string"},"header_option_server_address":{"action":"inherit","source":"string"},"header_option_server_name":{"action":"inherit","source":"string"},"hostname_rewrite_block":{"action":"inherit","source":"string","value":{"hostname_rewrite_char":"Example Name","hostname_rewrite_enabled":true,"hostname_rewrite_regex":"Example Name"}}},"name":"Example Name","parent":"string","rebind_time":123,"renew_time":123,"space":"string","tags":{},"threshold":{"enabled":true,"high":123,"low":123},"utilization_v6":{"abandoned":{"raw_value":"string"},"dynamic":{"raw_value":"string"},"static":{"raw_value":"string"},"total":{"raw_value":"string"},"used":{"raw_value":"string"}}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.address	string	Result of the operation
result.asm_config	object	Result of the operation
result.asm_config.asm_threshold	number	Result of the operation
result.asm_config.enable	boolean	Result of the operation
result.asm_config.enable_notification	boolean	Result of the operation
result.asm_config.forecast_period	number	Result of the operation
result.asm_config.growth_factor	number	Result of the operation
result.asm_config.growth_type	string	Type of the resource
result.asm_config.history	number	Result of the operation
result.asm_config.min_total	number	Result of the operation
result.asm_config.min_unused	number	Result of the operation
result.asm_config.reenable_date	string	Result of the operation
result.asm_scope_flag	number	Result of the operation
result.cidr	number	Unique identifier
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.ddns_client_update	string	Result of the operation
result.ddns_conflict_resolution_mode	string	Result of the operation
result.ddns_domain	string	Result of the operation
result.ddns_generate_name	boolean	Name of the resource
result.ddns_generated_prefix	string	Result of the operation

Output Example

Delete Address Block

Moves an AddressBlock object to the recycle bin in Infoblox BloxOne DDI, requiring the Address Block ID as a path parameter.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Required	Address Block ID.

Input Example

{"path_parameters":{"address_block_id":"73f7dc78-1c07-11ef-a128-beacc4e9494e"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"Date":"Fri, 31 May 2024 04:22:25 GMT","Content-Type":"application/json","Content-Length":"2","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{}}

Delete DHCP Fingerprint

Moves the specified DHCP fingerprint to the recycle bin in Infoblox BloxOne DDI using the fingerprint ID.

Endpoint

URL: /api/ddi/v1/dhcp/fingerprint/{{fingerprint_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.fingerprint_id	string	Required	Fingerprint ID.

Input Example

{"path_parameters":{"fingerprint_id":"10837136-166a-11ef-8c5e-7e4e2209b4ae"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 20 May 2024 06:36:41 GMT","Content-Type":"application/json","Content-Length":"2","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{}}

Delete IP Address

Moves a specified IP address to the recycle bin in Infoblox BloxOne DDI using the Address ID.

Endpoint

URL: /api/ddi/v1/ipam/address/{{address_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.address_id	string	Required	Address ID.

Input Example

{"path_parameters":{"address_id":"a44c65fa-1b4c-11ef-8447-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 26 May 2024 14:50:41 GMT","Content-Type":"application/json","Content-Length":"2","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{}}

Delete IP Space

Move an IPSpace object to the recycle bin. The IPSpace object represents an entire address space.

Endpoint

URL: /api/ddi/v1/ipam/ip_space/{{ip_space_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.ip_space_id	string	Required	IP Space ID.

Input Example

{"path_parameters":{"ip_space_id":"2ec8e03c-d27c-11ee-9595-e6ac2ebb2f62"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 10 Jun 2024 07:47:04 GMT","Content-Type":"application/json","Content-Length":"2","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{}}

Delete IPAM Host by ID

Move an IpamHost object to the recycle bin. The IpamHost object (ipam/host) represents any network connected equipment that is assigned one or more IP Addresses.

Endpoint

URL: /api/ddi/v1/ipam/host/{{host_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.host_id	string	Required	IPAM Host ID.

Input Example

{"path_parameters":{"host_id":"c33fb6e8-249a-11ef-9448-02b8a458f3ca"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"Date":"Fri, 07 Jun 2024 06:57:24 GMT","Content-Type":"application/json","Content-Length":"2","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{}}

Delete Range

Moves a specified Range object to the recycle bin in Infoblox BloxOne DDI, requiring the Range ID of the target IP address set.

Endpoint

URL: /api/ddi/v1/ipam/range/{{range_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.range_id	string	Required	Range ID.

Input Example

{"path_parameters":{"range_id":"78ac54f8-1d89-11ef-8a41-02b8a458f3ca"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{}

Delete Subnet

Move a specified Subnet object to the recycle bin in Infoblox BloxOne DDI using the Subnet ID.

Endpoint

URL: /api/ddi/v1/ipam/subnet/{{subnet_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.subnet_id	string	Required	Subnet ID.

Input Example

{"path_parameters":{"subnet_id":"4aaf5a2d-1c83-11ef-b68d-02b8a458f3ca"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 28 May 2024 06:06:50 GMT","Content-Type":"application/json","Content-Length":"2","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{}}

Get a DHCP Fingerprint

Retrieve a specific DHCP Fingerprint object by its ID in Infoblox BloxOne DDI, including its name and associated rules.

Endpoint

URL: /api/ddi/v1/dhcp/fingerprint/{{fingerprint_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.fingerprint_id	string	Required	Fingerprint ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id"},"path_parameters":{"fingerprint_id":"b5595b96-166b-11ef-b908-262f6a930816"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.class	string	Result of the operation
result.comment	string	Result of the operation
result.created_at	string	Result of the operation
result.defined_by	string	Result of the operation
result.id	string	Unique identifier
result.inheritance_sources	object	Result of the operation
result.name	string	Name of the resource
result.precedence	number	Result of the operation
result.rules	array	Result of the operation
result.rules.file_name	string	Name of the resource
result.rules.file	string	Result of the operation
result.share_fingerprint	boolean	Result of the operation
result.tags	object	Result of the operation
result.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 20 May 2024 06:16:57 GMT","Content-Type":"application/json","Content-Length":"386","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"class":"dhcp/fingerprint_class/0acf3996-6f31-47b6-8c57-4666df9743b2","comment":"","created_at":"2024-05-20T05:42:13.167636Z","defined_by":"user","id":"dhcp/fingerprint/b...

Get Address Block

Retrieves an AddressBlock object by ID, supporting administrative grouping and routing aggregation in Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Required	Address Block ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id,name"},"path_parameters":{"address_block_id":"2d1bbb08-00c8-11ef-8c72-d2db0cedb6eb"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.address	string	Result of the operation
result.asm_config	object	Result of the operation
result.asm_config.asm_threshold	number	Result of the operation
result.asm_config.enable	boolean	Result of the operation
result.asm_config.enable_notification	boolean	Result of the operation
result.asm_config.forecast_period	number	Result of the operation
result.asm_config.growth_factor	number	Result of the operation
result.asm_config.growth_type	string	Type of the resource
result.asm_config.history	number	Result of the operation
result.asm_config.min_total	number	Result of the operation
result.asm_config.min_unused	number	Result of the operation
result.asm_config.reenable_date	string	Result of the operation
result.asm_scope_flag	number	Result of the operation
result.cidr	number	Unique identifier
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.ddns_client_update	string	Result of the operation
result.ddns_conflict_resolution_mode	string	Result of the operation
result.ddns_domain	string	Result of the operation
result.ddns_generate_name	boolean	Name of the resource
result.ddns_generated_prefix	string	Result of the operation

Output Example

Get Address Block Next Available IP Address

Retrieve the next available IP address from Infoblox BloxOne DDI's address block for dynamic allocation.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}/nextavailableip

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Optional	Address Block ID.
parameters.contiguous	boolean	Optional	Indicates whether the IP addresses should belong to a contiguous block.
parameters.count	number	Optional	The number of IP addresses requested.

Input Example

{"parameters":{"contiguous":false,"count":2},"path_parameters":{"address_block_id":"fdb56d82-1dd6-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	string	Unique identifier
results.space	string	Result of the operation
results.address	string	Result of the operation
results.protocol	string	Result of the operation
results.comment	string	Result of the operation
results.parent	string	Result of the operation
results.range	object	Result of the operation
results.interface	string	Result of the operation
results.state	string	Result of the operation
results.usage	array	Result of the operation
results.usage.file_name	string	Name of the resource
results.usage.file	string	Result of the operation
results.dhcp_info	object	Result of the operation
results.names	array	Name of the resource
results.names.file_name	string	Name of the resource
results.names.file	string	Name of the resource
results.host	object	Result of the operation
results.hwaddr	string	Result of the operation
results.tags	object	Result of the operation
results.created_at	string	Result of the operation
results.updated_at	string	Result of the operation
results.discovery_attrs	object	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Thu, 30 May 2024 07:13:18 GMT","Content-Type":"application/json","Content-Length":"540","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}]}}

Get ASM by ID

Retrieve an ASM object for Automated Scope Management. The ASM object returns the suggested updates for the subnet from the ASM suggestion engine and allows for updating the subnet and range information.

Endpoint

URL: /api/ddi/v1/ipam/asm/{{asm_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.asm_id	string	Required	ASM ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id,growth"},"path_parameters":{"asm_id":"a9cd96e5-1d88-11ef-8a41-02b8a458f3ca"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.id	string	Unique identifier
result.subnet_id	string	Unique identifier
result.range_id	object	Unique identifier
result.range_start	string	Result of the operation
result.range_end	string	Result of the operation
result.update	string	Result of the operation
result.utilization	number	Result of the operation
result.threshold_utilization	number	Result of the operation
result.lookahead	number	Result of the operation
result.growth	number	Result of the operation
result.front_start	string	Result of the operation
result.front_end	string	Result of the operation
result.back_start	string	Result of the operation
result.back_end	string	Result of the operation
result.both_start	string	Result of the operation
result.both_end	string	Result of the operation
result.subnet_direction	string	Result of the operation
result.subnet_address	string	Result of the operation
result.subnet_cidr	number	Unique identifier
result.subnet_range	object	Result of the operation
result.subnet_range_start	string	Result of the operation
result.subnet_range_end	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 11 Jun 2024 04:46:19 GMT","Content-Type":"application/json","Content-Length":"15","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"id":"ipam/asm","subnet_id":"ipam/subnet/4b96eb17-00c8-11ef-af8c-82dcd2cac46c","range_id":null,"range_start":"","range_end"...

Get DHCP Fingerprint Class

Retrieve a specific DHCP fingerprint class by its ID for device classification within Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/dhcp/fingerprint_class/{{fingerprint_class_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.fingerprint_class_id	string	Required	Fingerprint Class ID.

Input Example

{"path_parameters":{"fingerprint_class_id":"0129e6ee-81fa-4d78-9923-756b2556dc48"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.id	string	Unique identifier
result.name	string	Name of the resource

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 19 May 2024 11:26:15 GMT","Content-Type":"application/json","Content-Length":"122","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"id":"dhcp/fingerprint_class/0129e6ee-81fa-4d78-9923-756b2556dc48","name":"Router, Access Point or Femtocell"}}}

Get DHCP System Fingerprint

Retrieve a specific DHCP system fingerprint by ID from Infoblox BloxOne DDI, including its name and associated rules.

Endpoint

URL: /api/ddi/v1/dhcp/system_fingerprint/{{system_fingerprint_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.system_fingerprint_id	string	Required	System Fingerprint ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id,name"},"path_parameters":{"system_fingerprint_id":"010ca6dc-ec7e-4eec-8812-fc056b8d87a6"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.id	string	Unique identifier
result.name	string	Name of the resource
result.rules	array	Result of the operation
result.rules.prl	array	Result of the operation
result.rules.prefix	string	Result of the operation
result.rules.vendor	string	Result of the operation
result.rules.vendor_compare	string	Result of the operation
result.class	string	Result of the operation
result.created_at	object	Result of the operation
result.updated_at	object	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 19 May 2024 12:11:22 GMT","Content-Type":"application/json","Content-Length":"329","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"id":"dhcp/system_fingerprint/010ca6dc-ec7e-4eec-8812-fc056b8d87a6","name":"PCS Revenue Control Systems","rules":[],"class...

Get DNS Usage by ID

Retrieve a DNSUsage object.

Endpoint

URL: /api/ddi/v1/ipam/dns_usage/{{dns_usage_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.dns_usage_id	string	Required	DNS Usage ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id,name"},"path_parameters":{"dns_usage_id":"4b96eb17-00c8-11ef-af8c-82dcd2cac46c"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.absolute_name	string	Name of the resource
result.address	string	Result of the operation
result.dns_rdata	string	Response data
result.id	string	Unique identifier
result.name	string	Name of the resource
result.record	string	Result of the operation
result.space	string	Result of the operation
result.type	string	Type of the resource
result.view	string	Result of the operation
result.zone	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 11 Jun 2024 05:16:51 GMT","Content-Type":"application/json","Content-Length":"42","Connection":"keep-alive","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"absolute_name":"string","address":"string","dns_rdata":"string","id":"string","name":"string","record":"string","space":"string","type":"string","view":"string","zone":"string"}}}

Get Global Lease by ID

Retrieve the GlobalLease object by its unique identifier from Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/dhcp/global_lease/{{global_lease_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.global_lease_id	string	Required	Global Lease ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id"},"path_parameters":{"global_lease_id":"ab37d2fc-85ee-4edb-8ac4-9485cb67a95c"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.id	string	Unique identifier
result.share_fingerprint	boolean	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 20 May 2024 04:36:02 GMT","Content-Type":"application/json","Content-Length":"99","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"id":"dhcp/global_lease/ab37d2fc-85ee-4edb-8ac4-9485cb67a95c","share_fingerprint":true}}}

Get GlobalLease

Retrieve the global DHCP lease configuration from Infoblox BloxOne DDI, including parent settings for inheritance.

Endpoint

URL: /api/ddi/v1/dhcp/global_lease

Method: GET

Input

Argument Name	Type	Required	Description
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.id	string	Unique identifier
result.share_fingerprint	boolean	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 19 May 2024 11:33:03 GMT","Content-Type":"application/json","Content-Length":"99","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"id":"dhcp/global_lease/ab37d2fc-85ee-4edb-8ac4-9485cb67a95c","share_fingerprint":true}}}

Get IP Address

Retrieves a single IP address object from Infoblox BloxOne DDI, representing an IP within a specified space.

Endpoint

URL: /api/ddi/v1/ipam/address/{{address_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.address_id	string	Optional	Address ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id,state"},"path_parameters":{"address_id":"a44c65fa-1b4c-11ef-8447-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.address	string	Result of the operation
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.dhcp_info	object	Result of the operation
result.disable_dhcp	boolean	Result of the operation
result.discovery_attrs	object	Result of the operation
result.discovery_metadata	object	Response data
result.host	object	Result of the operation
result.hwaddr	string	Result of the operation
result.id	string	Unique identifier
result.interface	string	Result of the operation
result.names	array	Name of the resource
result.names.file_name	string	Name of the resource
result.names.file	string	Name of the resource
result.parent	string	Result of the operation
result.protocol	string	Result of the operation
result.range	object	Result of the operation
result.space	string	Result of the operation
result.state	string	Result of the operation
result.tags	object	Result of the operation
result.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 26 May 2024 13:55:37 GMT","Content-Type":"application/json","Content-Length":"553","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"address":"192.168.0.1","comment":"","compartment_id":"","created_at":"2024-05-26T10:42:25.973780Z","dhcp_info":null,"disable_dhcp":false,"discovery_attrs":null,"discover...

Get IP Space by ID

Retrieve an IPSpace object. The IPSpace object represents an entire address space.

Endpoint

URL: /api/ddi/v1/ipam/ip_space/{{ip_space_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.ip_space_id	string	Required	IP Space ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id,name"},"path_parameters":{"ip_space_id":"2ec8e03c-d27c-11ee-9595-e6ac2ebb2f62"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.asm_config	object	Result of the operation
result.asm_config.asm_threshold	number	Result of the operation
result.asm_config.enable	boolean	Result of the operation
result.asm_config.enable_notification	boolean	Result of the operation
result.asm_config.forecast_period	number	Result of the operation
result.asm_config.growth_factor	number	Result of the operation
result.asm_config.growth_type	string	Type of the resource
result.asm_config.history	number	Result of the operation
result.asm_config.min_total	number	Result of the operation
result.asm_config.min_unused	number	Result of the operation
result.asm_config.reenable_date	string	Result of the operation
result.asm_scope_flag	number	Result of the operation
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.ddns_client_update	string	Result of the operation
result.ddns_conflict_resolution_mode	string	Result of the operation
result.ddns_domain	string	Result of the operation
result.ddns_generate_name	boolean	Name of the resource
result.ddns_generated_prefix	string	Result of the operation
result.ddns_send_updates	boolean	Result of the operation
result.ddns_ttl_percent	number	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 10 Jun 2024 07:09:11 GMT","Content-Type":"application/json","Content-Length":"1648","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"asm_config":{},"asm_scope_flag":0,"comment":"Some Comment","compartment_id":"","created_at":"2024-02-23T18:48:49.777030Z","ddns_client_update":"client","ddns_conflict_r...

Get IPAM Host by ID

Retrieve an IpamHost object. The IpamHost object (ipam/host) represents any network connected equipment that is assigned one or more IP Addresses.

Endpoint

URL: /api/ddi/v1/ipam/host/{{host_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.host_id	string	Required	IPAM Host ID.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_order_by":"name desc","_fields":"id,name"},"path_parameters":{"host_id":"e5a5411d-2497-11ef-9448-02b8a458f3ca"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.addresses	array	Result of the operation
result.addresses.file_name	string	Name of the resource
result.addresses.file	string	Result of the operation
result.auto_generate_records	boolean	Result of the operation
result.comment	string	Result of the operation
result.created_at	string	Result of the operation
result.host_names	array	Name of the resource
result.host_names.file_name	string	Name of the resource
result.host_names.file	string	Name of the resource
result.id	string	Unique identifier
result.name	string	Name of the resource
result.tags	object	Result of the operation
result.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Fri, 07 Jun 2024 06:38:07 GMT","Content-Type":"application/json","Content-Length":"264","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"addresses":[],"auto_generate_records":false,"comment":"","created_at":"2024-06-07T06:33:48.326138Z","host_names":[],"id":"ipam/host/e5a5411d-2497-11ef-9448-02b8a458f3ca"...

Get List Address Blocks

Retrieve AddressBlock objects in Infoblox BloxOne DDI, representing address space segmentation for functions like grouping and routing.

Endpoint

URL: /api/ddi/v1/ipam/address_block

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FIpamsvc#/address/addressList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.
parameters._torder_by	string	Optional	This parameter is used for sorting by tags.
parameters._tfilter	string	Optional	This parameter is used for filtering by tags.

Input Example

{"parameters":{"_filter":"name=='PCS Revenue Control Systems'","_fields":"id,name","_order_by":"name desc","_offset":10,"_limit":5,"_page_token":"afsatgfvfwgeffzawfeggehngwfdcbganehbgd","_torder_by":"cool","_tfilter":"cool"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.address	string	Result of the operation
results.asm_config	object	Result of the operation
results.asm_config.asm_threshold	number	Result of the operation
results.asm_config.enable	boolean	Result of the operation
results.asm_config.enable_notification	boolean	Result of the operation
results.asm_config.forecast_period	number	Result of the operation
results.asm_config.growth_factor	number	Result of the operation
results.asm_config.growth_type	string	Type of the resource
results.asm_config.history	number	Result of the operation
results.asm_config.min_total	number	Result of the operation
results.asm_config.min_unused	number	Result of the operation
results.asm_config.reenable_date	string	Result of the operation
results.asm_scope_flag	number	Result of the operation
results.cidr	number	Unique identifier
results.comment	string	Result of the operation
results.compartment_id	string	Unique identifier
results.created_at	string	Result of the operation
results.ddns_client_update	string	Result of the operation
results.ddns_conflict_resolution_mode	string	Result of the operation
results.ddns_domain	string	Result of the operation
results.ddns_generate_name	boolean	Name of the resource
results.ddns_generated_prefix	string	Result of the operation

Output Example

Get List IP Addresses

Retrieve a list of Address objects representing individual IP addresses within a specified IP space in Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/ipam/address

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FIpamsvc#/address/addressList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.
parameters.scope	string	Optional	Parameters for the Get List IP Addresses action
parameters.address_state	string	Optional	Parameters for the Get List IP Addresses action
parameters._torder_by	string	Optional	This parameter is used for sorting by tags.
parameters._tfilter	string	Optional	This parameter is used for filtering by tags.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.address	string	Result of the operation
results.comment	string	Result of the operation
results.compartment_id	string	Unique identifier
results.created_at	string	Result of the operation
results.dhcp_info	object	Result of the operation
results.disable_dhcp	boolean	Result of the operation
results.discovery_attrs	object	Result of the operation
results.discovery_metadata	object	Response data
results.host	object	Result of the operation
results.hwaddr	string	Result of the operation
results.id	string	Unique identifier
results.interface	string	Result of the operation
results.names	array	Name of the resource
results.names.file_name	string	Name of the resource
results.names.file	string	Name of the resource
results.parent	string	Result of the operation
results.protocol	string	Result of the operation
results.range	object	Result of the operation
results.space	string	Result of the operation
results.state	string	Result of the operation
results.tags	object	Result of the operation
results.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 26 May 2024 11:27:27 GMT","Content-Type":"application/json","Content-Length":"1638","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{},{},{}]}}

Get List of Address Block Ancestors

Retrieve a list of ancestor details for a specified AddressBlock object in Infoblox BloxOne DDI using the 'Address Block ID'.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}/ancestor

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Required	Address Block ID.

Input Example

{"path_parameters":{"address_block_id":"2d1bbb08-00c8-11ef-8c72-d2db0cedb6eb"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	string	Unique identifier
results.address	string	Result of the operation
results.cidr	number	Unique identifier
results.parent	object	Result of the operation
results.federated_realms	array	Result of the operation
results.federated_realms.file_name	string	Name of the resource
results.federated_realms.file	string	Result of the operation
results.space	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Thu, 30 May 2024 04:28:42 GMT","Content-Type":"application/json","Content-Length":"14","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}]}}

Get List of ASM

Retrieve ASM objects for Automated Scope Management. The ASM object returns the suggested updates for the subnet from the ASM suggestion engine and allows for updating the subnet and range information.

Endpoint

URL: /api/ddi/v1/ipam/asm

Method: GET

Input

Argument Name	Type	Required	Description
parameters.subnet_id	string	Required	Subnet ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"subnet_id":"ipam/subnet/4b96eb17-00c8-11ef-af8c-82dcd2cac46c","_fields":"growth,update"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	object	Unique identifier
results.subnet_id	string	Unique identifier
results.range_id	object	Unique identifier
results.range_start	string	Result of the operation
results.range_end	string	Result of the operation
results.update	string	Result of the operation
results.utilization	number	Result of the operation
results.threshold_utilization	number	Result of the operation
results.lookahead	number	Result of the operation
results.growth	number	Result of the operation
results.front_start	string	Result of the operation
results.front_end	string	Result of the operation
results.back_start	string	Result of the operation
results.back_end	string	Result of the operation
results.both_start	string	Result of the operation
results.both_end	string	Result of the operation
results.subnet_direction	string	Result of the operation
results.subnet_address	string	Result of the operation
results.subnet_cidr	number	Unique identifier
results.subnet_range	object	Result of the operation
results.subnet_range_start	string	Result of the operation
results.subnet_range_end	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 10 Jun 2024 10:32:38 GMT","Content-Type":"application/json","Content-Length":"475","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}]}}

Get List of DHCP Fingerprint Classes

Retrieve a list of device classes for DHCP fingerprinting from Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/dhcp/fingerprint_class

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc/?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FDhcpLeases#/fingerprint_class/fingerprint_classList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.

Input Example

{"parameters":{"_filter":"name=='PCS Revenue Control Systems'","_fields":"id,name","_order_by":"name desc","_offset":10,"_limit":5,"_page_token":"afsatgfvfwgeffzawfeggehngwfdcbganehbgd"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	string	Unique identifier
results.name	string	Name of the resource

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 19 May 2024 11:21:03 GMT","Content-Type":"application/json","Transfer-Encoding":"chunked","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{"id":"dhcp/fingerprint_class/0129e6ee-81fa-4d78-9923-756b2556dc48","name":"Router, Access Point or Femtocell"},{"id":"dhcp/fingerprint_class/0312d734-db5e-4a92-9...

Get List of DHCP Fingerprints

Retrieve a list of DHCP Fingerprint objects from Infoblox BloxOne DDI, each specifying a unique name and associated rules.

Endpoint

URL: /api/ddi/v1/dhcp/fingerprint

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc/?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FDhcpLeases#/fingerprint/fingerprintList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.
parameters._torder_by	string	Optional	This parameter is used for sorting by tags.
parameters._tfilter	string	Optional	This parameter is used for filtering by tags.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.class	string	Result of the operation
results.comment	string	Result of the operation
results.created_at	string	Result of the operation
results.defined_by	string	Result of the operation
results.id	string	Unique identifier
results.inheritance_sources	object	Result of the operation
results.name	string	Name of the resource
results.precedence	number	Result of the operation
results.rules	array	Result of the operation
results.rules.file_name	string	Name of the resource
results.rules.file	string	Result of the operation
results.share_fingerprint	boolean	Result of the operation
results.tags	object	Result of the operation
results.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 20 May 2024 05:50:07 GMT","Content-Type":"application/json","Content-Length":"763","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{},{}]}}

Get List of DHCP leases

Retrieve a list of DHCP lease objects from Infoblox BloxOne DDI, representing active leases on addresses.

Endpoint

URL: /api/ddi/v1/dhcp/lease

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc/?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FDhcpLeases#/lease/leaseList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.
parameters._torder_by	string	Optional	This parameter is used for sorting by tags.
parameters._tfilter	string	Optional	This parameter is used for filtering by tags.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.file_name	string	Name of the resource
results.file	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 19 May 2024 17:40:04 GMT","Content-Type":"application/json","Content-Length":"14","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[]}}

Get List of DHCP System Fingerprints

Retrieve a list of DHCP system fingerprints, each specifying a name and associated rules as defined by Infoblox.

Endpoint

URL: /api/ddi/v1/dhcp/system_fingerprint

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc/?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FDhcpLeases#/lease/leaseList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.
parameters._torder_by	string	Optional	This parameter is used for sorting by tags.
parameters._tfilter	string	Optional	This parameter is used for filtering by tags.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	string	Unique identifier
results.name	string	Name of the resource
results.rules	array	Result of the operation
results.rules.prl	array	Result of the operation
results.rules.prefix	string	Result of the operation
results.rules.vendor	string	Result of the operation
results.rules.vendor_compare	string	Result of the operation
results.class	string	Result of the operation
results.created_at	object	Result of the operation
results.updated_at	object	Result of the operation

Output Example

Get List of DNS Usage

Retrieve DNSUsage objects.

Endpoint

URL: /api/ddi/v1/ipam/dns_usage

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FIpamsvc#/dns_usage/dns_usageList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.

Input Example

{"parameters":{"_filter":"name=='test 1'","_fields":"id,name","_order_by":"name desc","_offset":10,"_limit":5,"_page_token":"afsatgfvfwgeffzawfeggehngwfdcbganehbgd","_torder_by":"cool","_tfilter":"cool"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.absolute_name	string	Name of the resource
results.address	string	Result of the operation
results.dns_rdata	string	Response data
results.id	string	Unique identifier
results.name	string	Name of the resource
results.record	string	Result of the operation
results.space	string	Result of the operation
results.type	string	Type of the resource
results.view	string	Result of the operation
results.zone	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 11 Jun 2024 04:59:23 GMT","Content-Type":"application/json","Content-Length":"14","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}]}}

Get List of IP Spaces

Retrieve IPSpace objects. The IPSpace object represents an entire address space.

Endpoint

URL: /api/ddi/v1/ipam/ip_space

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FIpamsvc#/ip_space/ip_spaceList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.
parameters._torder_by	string	Optional	This parameter is used for sorting by tags.
parameters._tfilter	string	Optional	This parameter is used for filtering by tags.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.asm_config	object	Result of the operation
results.asm_config.asm_threshold	number	Result of the operation
results.asm_config.enable	boolean	Result of the operation
results.asm_config.enable_notification	boolean	Result of the operation
results.asm_config.forecast_period	number	Result of the operation
results.asm_config.growth_factor	number	Result of the operation
results.asm_config.growth_type	string	Type of the resource
results.asm_config.history	number	Result of the operation
results.asm_config.min_total	number	Result of the operation
results.asm_config.min_unused	number	Result of the operation
results.asm_config.reenable_date	string	Result of the operation
results.asm_scope_flag	number	Result of the operation
results.comment	string	Result of the operation
results.compartment_id	string	Unique identifier
results.created_at	string	Result of the operation
results.ddns_client_update	string	Result of the operation
results.ddns_conflict_resolution_mode	string	Result of the operation
results.ddns_domain	string	Result of the operation
results.ddns_generate_name	boolean	Name of the resource
results.ddns_generated_prefix	string	Result of the operation
results.ddns_send_updates	boolean	Result of the operation
results.ddns_ttl_percent	number	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 10 Jun 2024 06:36:09 GMT","Content-Type":"application/json","Transfer-Encoding":"chunked","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}]}}

Get List of IPAM Host

Retrieve IpamHost objects. The IpamHost object (ipam/host) represents any network connected equipment that is assigned one or more IP Addresses.

Endpoint

URL: /api/ddi/v1/ipam/host

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FIpamsvc#/address/addressList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.
parameters._torder_by	string	Optional	This parameter is used for sorting by tags.
parameters._tfilter	string	Optional	This parameter is used for filtering by tags.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.addresses	array	Result of the operation
results.addresses.file_name	string	Name of the resource
results.addresses.file	string	Result of the operation
results.auto_generate_records	boolean	Result of the operation
results.comment	string	Result of the operation
results.created_at	string	Result of the operation
results.host_names	array	Name of the resource
results.host_names.file_name	string	Name of the resource
results.host_names.file	string	Name of the resource
results.id	string	Unique identifier
results.name	string	Name of the resource
results.tags	object	Result of the operation
results.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Fri, 07 Jun 2024 06:34:58 GMT","Content-Type":"application/json","Content-Length":"267","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}]}}

Get List of Next Available Address Blocks

Generates a list of available IPAM address blocks from Infoblox BloxOne DDI using a specified Address Block ID.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}/nextavailableaddressblock

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Required	Parameters for the Get List of Next Available Address Blocks action
parameters.cidr	number	Optional	The cidr value of subnets to be created.
parameters.count	number	Optional	Number of subnets to generate.
parameters.name	string	Optional	Name of next available address blocks.
parameters.comment	string	Optional	Comment of next available address blocks.
parameters.federated_realms	array	Optional	Reserved for future use.
parameters.compartment_id	string	Optional	The compartment id of the address blocks to be created.

Input Example

{"parameters":{"cidr":10,"count":2,"name":"test","comment":"List of subnets","federated_realms":[],"compartment_id":"compartd id"},"path_parameters":{"address_block_id":"fdb56d82-1dd6-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.address	string	Result of the operation
results.asm_config	object	Result of the operation
results.asm_config.asm_threshold	number	Result of the operation
results.asm_config.enable	boolean	Result of the operation
results.asm_config.enable_notification	boolean	Result of the operation
results.asm_config.forecast_period	number	Result of the operation
results.asm_config.growth_factor	number	Result of the operation
results.asm_config.growth_type	string	Type of the resource
results.asm_config.history	number	Result of the operation
results.asm_config.min_total	number	Result of the operation
results.asm_config.min_unused	number	Result of the operation
results.asm_config.reenable_date	string	Result of the operation
results.asm_scope_flag	number	Result of the operation
results.cidr	number	Unique identifier
results.comment	string	Result of the operation
results.compartment_id	string	Unique identifier
results.created_at	string	Result of the operation
results.ddns_client_update	string	Result of the operation
results.ddns_conflict_resolution_mode	string	Result of the operation
results.ddns_domain	string	Result of the operation
results.ddns_generate_name	boolean	Name of the resource
results.ddns_generated_prefix	string	Result of the operation

Output Example

Get List of Next Available Subnet

Retrieve a list of next available subnet objects within a specified address block ID in Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}/nextavailablesubnet

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Required	Address Block ID.
parameters.cidr	number	Optional	The cidr value of subnets to be created.
parameters.count	number	Optional	Number of subnets to generate.
parameters.name	string	Optional	Name of next available subnets.
parameters.comment	string	Optional	Comment of next available subnets.
parameters.dhcp_host	string	Optional	Reference of OnPrem Host associated with the next available subnets to be created.
parameters.federated_realms	array	Optional	Reserved for future use.

Input Example

{"path_parameters":{"address_block_id":"fdb56d82-1dd6-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.address	string	Result of the operation
results.asm_config	object	Result of the operation
results.asm_config.asm_threshold	number	Result of the operation
results.asm_config.enable	boolean	Result of the operation
results.asm_config.enable_notification	boolean	Result of the operation
results.asm_config.forecast_period	number	Result of the operation
results.asm_config.growth_factor	number	Result of the operation
results.asm_config.growth_type	string	Type of the resource
results.asm_config.history	number	Result of the operation
results.asm_config.min_total	number	Result of the operation
results.asm_config.min_unused	number	Result of the operation
results.asm_config.reenable_date	string	Result of the operation
results.asm_scope_flag	number	Result of the operation
results.cidr	number	Unique identifier
results.comment	string	Result of the operation
results.compartment_id	string	Unique identifier
results.created_at	string	Result of the operation
results.ddns_client_update	string	Result of the operation
results.ddns_conflict_resolution_mode	string	Result of the operation
results.ddns_domain	string	Result of the operation
results.ddns_generate_name	boolean	Name of the resource
results.ddns_generated_prefix	string	Result of the operation

Output Example

Get List of Ranges

Retrieves a list of contiguous IP address ranges within a subnet for administrative and protocol management in Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/ipam/range

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FIpamsvc#/range/rangeList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags. Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix ‘asc’ sorts the data in ascending order. The suffix ‘desc’ sorts the data in descending order. If no suffix is specified the data is sorted in ascending order.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.
parameters._torder_by	string	Optional	This parameter is used for sorting by tags.
parameters._tfilter	string	Optional	This parameter is used for filtering by tags.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.comment	string	Result of the operation
results.compartment_id	string	Unique identifier
results.created_at	string	Result of the operation
results.dhcp_host	object	Result of the operation
results.dhcp_options	array	Result of the operation
results.dhcp_options.file_name	string	Name of the resource
results.dhcp_options.file	string	Result of the operation
results.disable_dhcp	boolean	Result of the operation
results.end	string	Result of the operation
results.exclusion_ranges	array	Result of the operation
results.exclusion_ranges.file_name	string	Name of the resource
results.exclusion_ranges.file	string	Result of the operation
results.filters	array	Result of the operation
results.filters.file_name	string	Name of the resource
results.filters.file	string	Result of the operation
results.id	string	Unique identifier
results.inheritance_assigned_hosts	array	Result of the operation
results.inheritance_assigned_hosts.file_name	string	Name of the resource
results.inheritance_assigned_hosts.file	string	Result of the operation
results.inheritance_parent	string	Result of the operation
results.inheritance_sources	object	Result of the operation
results.name	string	Name of the resource

Output Example

{"status_code":200,"response_headers":{"Date":"Wed, 29 May 2024 09:08:48 GMT","Content-Type":"application/json","Transfer-Encoding":"chunked","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{},{}]}}

Get List of Subnet Ancestors

Retrieve all ancestor details of a specified subnet in Infoblox BloxOne DDI using the Subnet ID.

Endpoint

URL: /api/ddi/v1/ipam/subnet/{{subnet_id}}/ancestor

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.subnet_id	string	Required	Subnet ID.

Input Example

{"path_parameters":{"subnet_id":"4b96eb17-00c8-11ef-af8c-82dcd2cac46c"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	string	Unique identifier
results.address	string	Result of the operation
results.cidr	number	Unique identifier
results.parent	object	Result of the operation
results.federated_realms	array	Result of the operation
results.federated_realms.file_name	string	Name of the resource
results.federated_realms.file	string	Result of the operation
results.space	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 28 May 2024 06:17:09 GMT","Content-Type":"application/json","Content-Length":"206","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}]}}

Get List of Subnets

Retrieve a list of Subnet objects representing address sets assigned to network interfaces in Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/ipam/subnet

Method: GET

Input

Argument Name	Type	Required	Description
parameters._filter	string	Optional	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. For Operators refer API documentation https://csp.infoblox.com/apidoc?url=https%3A%2F%2Fcsp.infoblox.com%2Fapidoc%2Fdocs%2FIpamsvc#/subnet/subnetList.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.
parameters._order_by	string	Optional	A collection of response resources can be sorted by their JSON tags. Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix ‘asc’ sorts the data in ascending order. The suffix ‘desc’ sorts the data in descending order. If no suffix is specified the data is sorted in ascending order.
parameters._offset	number	Optional	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
parameters._limit	number	Optional	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
parameters._page_token	string	Optional	The service-defined string used to identify a page of resources. A null value indicates the first page.
parameters._torder_by	string	Optional	This parameter is used for sorting by tags.
parameters._tfilter	string	Optional	This parameter is used for filtering by tags.

Input Example

{"parameters":{"_filter":"address=='235.128.0.0'","_fields":"id,comment","_order_by":"comment desc","_offset":10,"_limit":5,"_page_token":"afsatgfvfwgeffzawfeggehngwfdcbganehbgd","_torder_by":"cool","_tfilter":"cool"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.address	string	Result of the operation
results.asm_config	object	Result of the operation
results.asm_config.asm_threshold	number	Result of the operation
results.asm_config.enable	boolean	Result of the operation
results.asm_config.enable_notification	boolean	Result of the operation
results.asm_config.forecast_period	number	Result of the operation
results.asm_config.growth_factor	number	Result of the operation
results.asm_config.growth_type	string	Type of the resource
results.asm_config.history	number	Result of the operation
results.asm_config.min_total	number	Result of the operation
results.asm_config.min_unused	number	Result of the operation
results.asm_config.reenable_date	string	Result of the operation
results.asm_scope_flag	number	Result of the operation
results.cidr	number	Unique identifier
results.comment	string	Result of the operation
results.compartment_id	string	Unique identifier
results.created_at	string	Result of the operation
results.ddns_client_update	string	Result of the operation
results.ddns_conflict_resolution_mode	string	Result of the operation
results.ddns_domain	string	Result of the operation
results.ddns_generate_name	boolean	Name of the resource
results.ddns_generated_prefix	string	Result of the operation

Output Example

Get Range

Retrieves a contiguous set of IP addresses within a subnet identified by the 'Range ID' parameter in Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/ipam/range/{{range_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.range_id	string	Required	Range ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id,name"},"path_parameters":{"range_id":"b8d8af38-1d88-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.dhcp_host	object	Result of the operation
result.dhcp_options	array	Result of the operation
result.dhcp_options.file_name	string	Name of the resource
result.dhcp_options.file	string	Result of the operation
result.disable_dhcp	boolean	Result of the operation
result.end	string	Result of the operation
result.exclusion_ranges	array	Result of the operation
result.exclusion_ranges.file_name	string	Name of the resource
result.exclusion_ranges.file	string	Result of the operation
result.filters	array	Result of the operation
result.filters.file_name	string	Name of the resource
result.filters.file	string	Result of the operation
result.id	string	Unique identifier
result.inheritance_assigned_hosts	array	Result of the operation
result.inheritance_assigned_hosts.file_name	string	Name of the resource
result.inheritance_assigned_hosts.file	string	Result of the operation
result.inheritance_parent	string	Result of the operation
result.inheritance_sources	object	Result of the operation
result.name	string	Name of the resource

Output Example

Get Range Next Available IP Address

Retrieve the next available IP address within a specified range from Infoblox BloxOne DDI, given the 'Range ID'.

Endpoint

URL: /api/ddi/v1/ipam/range/{{range_id}}/nextavailableip

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.range_id	string	Required	Range ID.
parameters.contiguous	boolean	Optional	Indicates whether the IP addresses should belong to a contiguous block.
parameters.count	number	Optional	The number of IP addresses requested.

Input Example

{"parameters":{"contiguous":false,"count":1},"path_parameters":{"range_id":"b8d8af38-1d88-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	string	Unique identifier
results.space	string	Result of the operation
results.address	string	Result of the operation
results.protocol	string	Result of the operation
results.comment	string	Result of the operation
results.parent	string	Result of the operation
results.range	string	Result of the operation
results.interface	string	Result of the operation
results.state	string	Result of the operation
results.usage	array	Result of the operation
results.usage.file_name	string	Name of the resource
results.usage.file	string	Result of the operation
results.dhcp_info	object	Result of the operation
results.names	array	Name of the resource
results.names.file_name	string	Name of the resource
results.names.file	string	Name of the resource
results.host	object	Result of the operation
results.hwaddr	string	Result of the operation
results.tags	object	Result of the operation
results.created_at	string	Result of the operation
results.updated_at	string	Result of the operation
results.discovery_attrs	object	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Wed, 29 May 2024 12:38:58 GMT","Content-Type":"application/json","Content-Length":"587","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}]}}

Get Subnet

Retrieves a specific Subnet object by Subnet ID from Infoblox BloxOne DDI, representing a set of assignable network addresses.

Endpoint

URL: /api/ddi/v1/ipam/subnet/{{subnet_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.subnet_id	string	Required	Subnet ID.
parameters._fields	string	Optional	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. Specify this parameter as a comma-separated list of JSON tag names.

Input Example

{"parameters":{"_fields":"id,comment"},"path_parameters":{"subnet_id":"4aaf5a2d-1c83-11ef-b68d-02b8a458f3ca"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.address	string	Result of the operation
result.asm_config	object	Result of the operation
result.asm_config.asm_threshold	number	Result of the operation
result.asm_config.enable	boolean	Result of the operation
result.asm_config.enable_notification	boolean	Result of the operation
result.asm_config.forecast_period	number	Result of the operation
result.asm_config.growth_factor	number	Result of the operation
result.asm_config.growth_type	string	Type of the resource
result.asm_config.history	number	Result of the operation
result.asm_config.min_total	number	Result of the operation
result.asm_config.min_unused	number	Result of the operation
result.asm_config.reenable_date	string	Result of the operation
result.asm_scope_flag	number	Result of the operation
result.cidr	number	Unique identifier
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.ddns_client_update	string	Result of the operation
result.ddns_conflict_resolution_mode	string	Result of the operation
result.ddns_domain	string	Result of the operation
result.ddns_generate_name	boolean	Name of the resource
result.ddns_generated_prefix	string	Result of the operation

Output Example

Get Subnet Next Available IP Address

Retrieve the next available IP address within a specified subnet by providing the Subnet ID.

Endpoint

URL: /api/ddi/v1/ipam/subnet/{{subnet_id}}/nextavailableip

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.subnet_id	string	Required	Subnet ID.
parameters.contiguous	boolean	Optional	Indicates whether the IP addresses should belong to a contiguous block.
parameters.count	number	Optional	The number of IP addresses requested. Defaults to 1.

Input Example

{"parameters":{"contiguous":false,"count":1},"path_parameters":{"subnet_id":"4b96eb17-00c8-11ef-af8c-82dcd2cac46c"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
results	array	Result of the operation
results.id	string	Unique identifier
results.space	string	Result of the operation
results.address	string	Result of the operation
results.protocol	string	Result of the operation
results.comment	string	Result of the operation
results.parent	string	Result of the operation
results.range	object	Result of the operation
results.interface	string	Result of the operation
results.state	string	Result of the operation
results.usage	array	Result of the operation
results.usage.file_name	string	Name of the resource
results.usage.file	string	Result of the operation
results.dhcp_info	object	Result of the operation
results.names	array	Name of the resource
results.names.file_name	string	Name of the resource
results.names.file	string	Name of the resource
results.host	object	Result of the operation
results.hwaddr	string	Result of the operation
results.tags	object	Result of the operation
results.created_at	string	Result of the operation
results.updated_at	string	Result of the operation
results.discovery_attrs	object	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 28 May 2024 06:35:39 GMT","Content-Type":"application/json","Content-Length":"538","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"results":[{}]}}

Update Address Block

Updates an AddressBlock object in Infoblox BloxOne DDI, requiring Address Block ID and JSON body for segmentation and delegation functions.

Endpoint

URL: /api/ddi/v1/ipam/address_block/{{address_block_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.address_block_id	string	Required	Address Block ID.
address	string	Optional	The address field in form “a.b.c.d/n” where the “/n” may be omitted. In this case, the CIDR value must be defined in the cidr field. When reading, the address field is always in the form “a.b.c.d”.
asm_config	object	Optional	The ASMConfig object represents Automated Scope Management configuration.
asm_config.asm_threshold	number	Optional	ASM shows the number of addresses forecast to be used forecast_period days in the future, if it is greater than asm_threshold percent * dhcp_total (see dhcp_utilization) then the subnet is flagged.
asm_config.enable	boolean	Optional	Indicates if Automated Scope Management is enabled.
asm_config.enable_notification	boolean	Optional	Indicates if ASM should send notifications to the user.
asm_config.forecast_period	number	Optional	The forecast period in days.
asm_config.growth_factor	number	Optional	Indicates the growth in the number or percentage of IP addresses.
asm_config.growth_type	string	Optional	The type of factor to use are percent or count.
asm_config.history	number	Optional	The minimum amount of history needed before ASM can run on this subnet.
asm_config.min_total	number	Optional	The minimum size of range needed for ASM to run on this subnet.
asm_config.min_unused	number	Optional	The minimum percentage of addresses that must be available outside of the DHCP ranges and fixed addresses when making a suggested change.
asm_config.reenable_date	string	Optional	Date value
cidr	number	Optional	The CIDR of the address block. This is required, if address does not specify it in its input. maximum is 128 and minimum is 1.
comment	string	Optional	The description for the address block. May contain 0 to 1024 characters. Can include UTF-8.
compartment_id	string	Optional	Reserved for future use.
ddns_client_update	string	Optional	Controls who does the DDNS updates.
ddns_conflict_resolution_mode	string	Optional	The mode used for resolving conflicts while performing DDNS updates.
ddns_domain	string	Optional	The domain suffix for DDNS updates. FQDN, may be empty.
ddns_generate_name	boolean	Optional	Indicates if DDNS needs to generate a hostname when not supplied by the client.
ddns_generated_prefix	string	Optional	The prefix used in the generation of an FQDN. When generating a name, DHCP server will construct the name in the format is [ddns-generated-prefix]-[address-text].[ddns-qualifying-suffix]. where address-text is simply the lease IP address converted to a hyphenated string.
ddns_send_updates	boolean	Optional	Determines if DDNS updates are enabled at the address block level.
ddns_ttl_percent	number	Optional	DDNS TTL value - to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage. It is specified as a percentage (e.g. 25, 75).
ddns_update_on_renew	boolean	Optional	Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed.
ddns_use_conflict_resolution	boolean	Optional	When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients.

Input Example

{"path_parameters":{"address_block_id":"2a475199-1e59-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.address	string	Result of the operation
result.asm_config	object	Result of the operation
result.asm_config.asm_threshold	number	Result of the operation
result.asm_config.enable	boolean	Result of the operation
result.asm_config.enable_notification	boolean	Result of the operation
result.asm_config.forecast_period	number	Result of the operation
result.asm_config.growth_factor	number	Result of the operation
result.asm_config.growth_type	string	Type of the resource
result.asm_config.history	number	Result of the operation
result.asm_config.min_total	number	Result of the operation
result.asm_config.min_unused	number	Result of the operation
result.asm_config.reenable_date	string	Result of the operation
result.asm_scope_flag	number	Result of the operation
result.cidr	number	Unique identifier
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.ddns_client_update	string	Result of the operation
result.ddns_conflict_resolution_mode	string	Result of the operation
result.ddns_domain	string	Result of the operation
result.ddns_generate_name	boolean	Name of the resource
result.ddns_generated_prefix	string	Result of the operation

Output Example

Update ASM

Update the subnet and range for Automated Scope Management. The ASM object generates and returns the suggestions from the ASM suggestion engine and allows for updating the subnet and range.

Endpoint

URL: /api/ddi/v1/ipam/asm

Method: POST

Input

Argument Name	Type	Required	Description
range_end	string	Optional	The end IP address of the range.
range_id	string	Optional	The resource identifier.
range_start	string	Optional	The start IP address of the range.
subnet_id	string	Optional	The resource identifier.
subnet_range	string	Optional	The resource identifier.
suppress	string	Optional	Indicates if future notifications for this subnet should be suppressed.
suppress_time	number	Optional	The time duration in days to suppress the notifications for this subnet.
update	string	Optional	The object to update.

Input Example

{"json_body":{"range_end":"30.127.233.254","range_id":"ipam/range/b8d8af38-1d88-11ef-8de7-2ad8f1f3d115","range_start":"30.127.233.1","subnet_id":"ipam/subnet/4b96eb17-00c8-11ef-af8c-82dcd2cac46c","subnet_range":"ipam/subnet/4b96eb17-00c8-11ef-af8c-82dcd2cac46c","suppress":"time","suppress_time":0,"update":"range"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.id	string	Unique identifier
result.subnet_id	string	Unique identifier
result.range_id	object	Unique identifier
result.range_start	string	Result of the operation
result.range_end	string	Result of the operation
result.update	string	Result of the operation
result.utilization	number	Result of the operation
result.threshold_utilization	number	Result of the operation
result.lookahead	number	Result of the operation
result.growth	number	Result of the operation
result.front_start	string	Result of the operation
result.front_end	string	Result of the operation
result.back_start	string	Result of the operation
result.back_end	string	Result of the operation
result.both_start	string	Result of the operation
result.both_end	string	Result of the operation
result.subnet_direction	string	Result of the operation
result.subnet_address	string	Result of the operation
result.subnet_cidr	number	Unique identifier
result.subnet_range	object	Result of the operation
result.subnet_range_start	string	Result of the operation
result.subnet_range_end	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Tue, 11 Jun 2024 04:16:15 GMT","Content-Type":"application/json","Content-Length":"470","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"id":"ipam/asm","subnet_id":"ipam/subnet/4b96eb17-00c8-11ef-af8c-82dcd2cac46c","range_id":null,"range_start":"","range_end...

Update DHCP Fingerprint

Updates a DHCP fingerprint in Infoblox BloxOne DDI by specifying a name and class rules for client matching.

Endpoint

URL: /api/ddi/v1/dhcp/fingerprint/{{fingerprint_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.fingerprint_id	string	Required	Parameters for the Update DHCP Fingerprint action
class	string	Optional	The resource identifier.
comment	string	Optional	The description for the DHCP fingerprint. May contain 0 to 1024 characters. Can include UTF-8.
inheritance_sources	object	Optional	The inheritance configuration specifies how share_fingerprint is inherited.
inheritance_sources.share_fingerprint	object	Optional	The inheritance configuration for a field of type Bool.
inheritance_sources.share_fingerprint.action	string	Optional	The inheritance setting for a field. Valid values are inherit,override. Inherit - Use the inherited value. Override - Use the value set in the object.
inheritance_sources.share_fingerprint.source	string	Optional	The resource identifier.
name	string	Optional	The name of the DHCP fingerprint. Must contain 1 to 256 characters. Can include UTF-8.
precedence	number	Optional	Integer (1-N) defining priority order of DHCP fingerprints; smaller means higher precedence. Maximum is 2147483647
rules	array	Optional	The collection of fingerprint rules for the DHCP fingerprint. A FingerprintRule object (dhcp/fingerprint_rule) represents a DHCP fingerprint rule. A lease matches a fingerprint rule if all of the sub-rules evaluate to true. If a sub-rule doesn’t include a value (it has been left empty) it evaluates to true.
rules.prl	array	Optional	The value to use to match the parameter request list option (option 55). A string of intergers.
rules.prefix	string	Optional	The value to use to match the first three bytes of the hardware address.
rules.vendor	string	Optional	The value to use to match the vendor class ID option (option 60).
rules.vendor_compare	string	Optional	The operation to use when matching the vendor class ID.
share_fingerprint	boolean	Optional	Indicates if the DHCP fingerprint should be shared with Infoblox. This is only applicable for custom fingerprints. Defaults to true for custom fingerprints.
tags	object	Optional	The tags for the DHCP fingerprint in JSON format.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.class	string	Result of the operation
result.comment	string	Result of the operation
result.created_at	string	Result of the operation
result.defined_by	string	Result of the operation
result.id	string	Unique identifier
result.inheritance_sources	object	Result of the operation
result.name	string	Name of the resource
result.precedence	number	Result of the operation
result.rules	array	Result of the operation
result.rules.file_name	string	Name of the resource
result.rules.file	string	Result of the operation
result.share_fingerprint	boolean	Result of the operation
result.tags	object	Result of the operation
result.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 20 May 2024 06:25:43 GMT","Content-Type":"application/json","Content-Length":"389","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"class":"dhcp/fingerprint_class/0acf3996-6f31-47b6-8c57-4666df9743b2","comment":"","created_at":"2024-05-20T05:42:13.167636Z","defined_by":"user","id":"dhcp/fingerprint/b...

Update Global Lease

Updates the global DHCP lease configuration in Infoblox BloxOne DDI using a specified global_lease_id.

Endpoint

URL: /api/ddi/v1/dhcp/global_lease/{{global_lease_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.global_lease_id	string	Required	Global Lease ID.
share_fingerprint	boolean	Optional	Indicates if DHCP fingerprint should be shared with Infoblox. This is only applicable for custom fingerprints. Defaults to true for custom DHCP fingerprints.

Input Example

{"json_body":{"share_fingerprint":true},"path_parameters":{"global_lease_id":"ab37d2fc-85ee-4edb-8ac4-9485cb67a95c"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.id	string	Unique identifier
result.share_fingerprint	boolean	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 19 May 2024 11:53:48 GMT","Content-Type":"application/json","Content-Length":"99","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","grpc-metadata-content-type":"application/grpc","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"id":"dhcp/global_lease/ab37d2fc-85ee-4edb-8ac4-9485cb67a95c","share_fingerprint":true}}}

Update IP Address

Updates a specific IP address object within the designated IP space in Infoblox BloxOne DDI.

Endpoint

URL: /api/ddi/v1/ipam/address/{{address_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.address_id	string	Required	Address ID.
address	string	Optional	The address in form "a.b.c.d".
comment	string	Optional	The description for the address object. May contain 0 to 1024 characters. Can include UTF-8.
discovery_attrs	object	Optional	The discovery attributes for this address in JSON format.
discovery_metadata	object	Optional	The discovery metadata for this address in JSON format.
host	string	Optional	The resource identifier.
hwaddr	string	Optional	The hardware address associated with this IP address.
interface	string	Optional	The name of the network interface card (NIC) associated with the address, if any.
names	array	Optional	The list of all names associated with this address.
names.name	string	Required	The name expressed as a single label or FQDN.
names.type	string	Required	The origin of the name.
parent	string	Optional	The resource identifier.
range	string	Optional	The resource identifier.
tags	object	Optional	Parameter for Update IP Address
space	string	Optional	The resource identifier.

Input Example

{"json_body":{"address":"192.168.1.0","comment":"Updated the IP Address comment 1.1","discovery_attrs":{},"discovery_metadata":{},"host":"string","hwaddr":"string","interface":"string","names":[{"name":"string","type":"string"}],"parent":"string","range":"string","tags":{},"space":"ipam/ip_space/2ec8e03c-d27c-11ee-9595-e6ac2ebb2f62"},"path_parameters":{"address_id":"a44c65fa-1b4c-11ef-8447-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.address	string	Result of the operation
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.dhcp_info	object	Result of the operation
result.disable_dhcp	boolean	Result of the operation
result.discovery_attrs	object	Result of the operation
result.discovery_metadata	object	Response data
result.host	object	Result of the operation
result.hwaddr	string	Result of the operation
result.id	string	Unique identifier
result.interface	string	Result of the operation
result.names	array	Name of the resource
result.names.file_name	string	Name of the resource
result.names.file	string	Name of the resource
result.parent	string	Result of the operation
result.protocol	string	Result of the operation
result.range	object	Result of the operation
result.space	string	Result of the operation
result.state	string	Result of the operation
result.tags	object	Result of the operation
result.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Sun, 26 May 2024 14:12:27 GMT","Content-Type":"application/json","Content-Length":"586","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"address":"192.168.1.0","comment":"Updated the IP Address comment","compartment_id":"","created_at":"2024-05-26T10:42:25.973780Z","dhcp_info":null,"disable_dhcp":false,"d...

Update IP Space

Update an IPSpace object. The IPSpace object represents an entire address space.

Endpoint

URL: /api/ddi/v1/ipam/ip_space/{{ip_space_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.ip_space_id	string	Required	IP Space ID.
asm_config	object	Optional	The ASMConfig object represents Automated Scope Management configuration.
asm_config.asm_threshold	number	Optional	ASM shows the number of addresses forecast to be used forecast_period days in the future, if it is greater than asm_threshold percent * dhcp_total (see dhcp_utilization) then the subnet is flagged.
asm_config.enable	boolean	Optional	Indicates if Automated Scope Management is enabled.
asm_config.enable_notification	boolean	Optional	Indicates if ASM should send notifications to the user.
asm_config.forecast_period	number	Optional	The forecast period in days.
asm_config.growth_factor	number	Optional	Indicates the growth in the number or percentage of IP addresses.
asm_config.growth_type	string	Optional	The type of factor to use are percent or count.
asm_config.history	number	Optional	The minimum amount of history needed before ASM can run on this subnet.
asm_config.min_total	number	Optional	The minimum size of range needed for ASM to run on this subnet.
asm_config.min_unused	number	Optional	The minimum percentage of addresses that must be available outside of the DHCP ranges and fixed addresses when making a suggested change.
asm_config.reenable_date	string	Optional	Date value
comment	string	Optional	The description for the IP space. May contain 0 to 1024 characters. Can include UTF-8.
compartment_id	string	Optional	Reserved for future use.
ddns_client_update	string	Optional	Controls who does the DDNS updates.
ddns_conflict_resolution_mode	string	Optional	The mode used for resolving conflicts while performing DDNS updates.
ddns_domain	string	Optional	The domain suffix for DDNS updates. FQDN, may be empty.
ddns_generate_name	boolean	Optional	Indicates if DDNS needs to generate a hostname when not supplied by the client.
ddns_generated_prefix	string	Optional	The prefix used in the generation of an FQDN. When generating a name, DHCP server will construct the name in the format is [ddns-generated-prefix]-[address-text].[ddns-qualifying-suffix]. where address-text is simply the lease IP address converted to a hyphenated string.
ddns_send_updates	boolean	Optional	Determines if DDNS updates are enabled at the IP space level.
ddns_ttl_percent	number	Optional	DDNS TTL value - to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage. It is specified as a percentage (e.g. 25, 75).
ddns_update_on_renew	boolean	Optional	Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed.
ddns_use_conflict_resolution	boolean	Optional	When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients.
default_realms	array	Optional	Reserved for future use.
dhcp_config	object	Optional	A DHCP Config object (dhcp/dhcp_config) represents a shared DHCP configuration that controls how leases are issued.

Input Example

{"path_parameters":{"ip_space_id":"7eb42207-27b4-11ef-a715-729fd14e7c69"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.asm_config	object	Result of the operation
result.asm_config.asm_threshold	number	Result of the operation
result.asm_config.enable	boolean	Result of the operation
result.asm_config.enable_notification	boolean	Result of the operation
result.asm_config.forecast_period	number	Result of the operation
result.asm_config.growth_factor	number	Result of the operation
result.asm_config.growth_type	string	Type of the resource
result.asm_config.history	number	Result of the operation
result.asm_config.min_total	number	Result of the operation
result.asm_config.min_unused	number	Result of the operation
result.asm_config.reenable_date	string	Result of the operation
result.asm_scope_flag	number	Result of the operation
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.ddns_client_update	string	Result of the operation
result.ddns_conflict_resolution_mode	string	Result of the operation
result.ddns_domain	string	Result of the operation
result.ddns_generate_name	boolean	Name of the resource
result.ddns_generated_prefix	string	Result of the operation
result.ddns_send_updates	boolean	Result of the operation
result.ddns_ttl_percent	number	Result of the operation

Output Example

Update IPAM Host

Update an IpamHost object. The IpamHost object (ipam/host) represents any network connected equipment that is assigned one or more IP Addresses.

Endpoint

URL: /api/ddi/v1/ipam/host/{{host_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.host_id	string	Optional	IPAM Host ID.
addresses	array	Optional	The list of all addresses associated with the IPAM host, which may be in different IP spaces.
addresses.address	string	Required	Field usage depends on the operation.
addresses.ref	string	Required	The resource identifier.
addresses.space	string	Required	The resource identifier.
auto_generate_records	boolean	Optional	This flag specifies if resource records have to be auto generated for the host.
comment	string	Optional	The description for the IPAM host. May contain 0 to 1024 characters. Can include UTF-8.
host_names	array	Optional	The name records to be generated for the host.
host_names.alias	boolean	Optional	When true, the name is treated as an alias.
host_names.name	string	Required	A name for the host.
host_names.primary_name	boolean	Optional	When true, the name field is treated as primary name.
host_names.zone	string	Required	The resource identifier.
name	string	Optional	The name of the IPAM host. Must contain 1 to 256 characters. Can include UTF-8.
tags	object	Optional	The tags for the IPAM host in JSON format.

Input Example

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.addresses	array	Result of the operation
result.addresses.file_name	string	Name of the resource
result.addresses.file	string	Result of the operation
result.auto_generate_records	boolean	Result of the operation
result.comment	string	Result of the operation
result.created_at	string	Result of the operation
result.host_names	array	Name of the resource
result.host_names.file_name	string	Name of the resource
result.host_names.file	string	Name of the resource
result.id	string	Unique identifier
result.name	string	Name of the resource
result.tags	object	Result of the operation
result.updated_at	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 10 Jun 2024 05:48:53 GMT","Content-Type":"application/json","Content-Length":"277","Connection":"keep-alive","cache-control":"no-cache, no-store, max-age=0, must-revalidate","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"reason":"OK","json_body":{"result":{"addresses":[],"auto_generate_records":false,"comment":"","created_at":"2024-06-07T06:33:48.326138Z","host_names":[],"id":"ipam/host/e5a5411d-2497-11ef-9448-02b8a458f3ca"...

Update Range

Modifies a contiguous set of IP addresses within a subnet in Infoblox BloxOne DDI, identified by the 'Range ID'.

Endpoint

URL: /api/ddi/v1/ipam/range/{{range_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.range_id	string	Required	Range ID.
comment	string	Optional	The description for the range. May contain 0 to 1024 characters. Can include UTF-8.
dhcp_host	string	Optional	The resource identifier.
dhcp_options	array	Optional	An item (dhcp/option_item) in a list of DHCP options. May be either a specific option or a group of options.
dhcp_options.group	string	Optional	The resource identifier.
dhcp_options.option_code	string	Optional	The resource identifier.
dhcp_options.option_value	string	Optional	The option value.
dhcp_options.type	string	Optional	The type of item.
disable_dhcp	boolean	Optional	A disabled object is effectively non-existent when generating configuration.
end	string	Optional	The end IP address of the range.
exclusion_ranges	array	Optional	The ExclusionRange object represents an exclusion range inside a DHCP range.
exclusion_ranges.comment	string	Optional	The description for the exclusion range. May contain 0 to 1024 characters. Can include UTF-8.
exclusion_ranges.end	string	Required	The end address of the exclusion range.
exclusion_ranges.start	string	Required	The start address of the exclusion range.
filters	array	Optional	The AccessFilter object represents an allow/deny filter for a DHCP range.
filters.access	string	Optional	The access type of DHCP filter (allow or deny).
filters.hardware_filter_id	string	Optional	The resource identifier.
filters.option_filter_id	string	Optional	The resource identifier.
inheritance_parent	string	Optional	The resource identifier.
inheritance_sources	object	Optional	The inheritance configuration that specifies how the dhcp_options field is inherited from the parent object.
inheritance_sources.dhcp_options	object	Optional	The inheritance configuration for a field that contains list of OptionItem.
inheritance_sources.dhcp_options.action	string	Optional	The inheritance setting.
inheritance_sources.dhcp_options.value	array	Optional	The inherited DHCP option values.
inheritance_sources.dhcp_options.value.action	string	Optional	The inheritance setting.
inheritance_sources.dhcp_options.value.source	string	Optional	The resource identifier.

Input Example

{"path_parameters":{"range_id":"b8d8af38-1d88-11ef-8de7-2ad8f1f3d115"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.dhcp_host	object	Result of the operation
result.dhcp_options	array	Result of the operation
result.dhcp_options.file_name	string	Name of the resource
result.dhcp_options.file	string	Result of the operation
result.disable_dhcp	boolean	Result of the operation
result.end	string	Result of the operation
result.exclusion_ranges	array	Result of the operation
result.exclusion_ranges.file_name	string	Name of the resource
result.exclusion_ranges.file	string	Result of the operation
result.filters	array	Result of the operation
result.filters.file_name	string	Name of the resource
result.filters.file	string	Result of the operation
result.id	string	Unique identifier
result.inheritance_assigned_hosts	array	Result of the operation
result.inheritance_assigned_hosts.file_name	string	Name of the resource
result.inheritance_assigned_hosts.file	string	Result of the operation
result.inheritance_parent	string	Result of the operation
result.inheritance_sources	object	Result of the operation
result.name	string	Name of the resource

Output Example

Update Subnet

Updates a Subnet object in Infoblox BloxOne DDI using the specified Subnet ID. This action requires a JSON body with updated details.

Endpoint

URL: /api/ddi/v1/ipam/subnet/{{subnet_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.subnet_id	string	Required	Subnet ID.
address	string	Optional	The address of the subnet in the form “a.b.c.d/n” where the “/n” may be omitted. In this case, the CIDR value must be defined in the cidr field. When reading, the address field is always in the form “a.b.c.d”.
asm_config	object	Optional	The ASMConfig object represents Automated Scope Management configuration.
asm_config.asm_threshold	number	Optional	ASM shows the number of addresses forecast to be used forecast_period days in the future, if it is greater than asm_threshold percent * dhcp_total (see dhcp_utilization) then the subnet is flagged.
asm_config.enable	boolean	Optional	Indicates if Automated Scope Management is enabled.
asm_config.enable_notification	boolean	Optional	Indicates if ASM should send notifications to the user.
asm_config.forecast_period	number	Optional	The forecast period in days.
asm_config.growth_factor	number	Optional	Indicates the growth in the number or percentage of IP addresses.
asm_config.growth_type	string	Optional	The type of factor to use are percent or count.
asm_config.history	number	Optional	The minimum amount of history needed before ASM can run on this subnet.
asm_config.min_total	number	Optional	The minimum size of range needed for ASM to run on this subnet.
asm_config.min_unused	number	Optional	The minimum percentage of addresses that must be available outside of the DHCP ranges and fixed addresses when making a suggested change.
asm_config.reenable_date	string	Optional	Date value
cidr	number	Optional	The CIDR of the subnet. This is required, if address does not specify it in its input. maximum is 128 and minimum is 1.
comment	string	Optional	The description for the subnet. May contain 0 to 1024 characters. Can include UTF-8.
compartment_id	string	Optional	Reserved for future use.
ddns_client_update	string	Optional	Controls who does the DDNS updates.
ddns_conflict_resolution_mode	string	Optional	The mode used for resolving conflicts while performing DDNS updates.
ddns_domain	string	Optional	The domain suffix for DDNS updates. FQDN, may be empty.
ddns_generate_name	boolean	Optional	Indicates if DDNS needs to generate a hostname when not supplied by the client.
ddns_generated_prefix	string	Optional	The prefix used in the generation of an FQDN. When generating a name, DHCP server will construct the name in the format is [ddns-generated-prefix]-[address-text].[ddns-qualifying-suffix]. where address-text is simply the lease IP address converted to a hyphenated string.
ddns_send_updates	boolean	Optional	Determines if DDNS updates are enabled at the subnet level.
ddns_ttl_percent	number	Optional	DDNS TTL value - to be calculated as a simple percentage of the lease's lifetime, using the parameter's value as the percentage. It is specified as a percentage (e.g. 25, 75).
ddns_update_on_renew	boolean	Optional	Instructs the DHCP server to always update the DNS information when a lease is renewed even if its DNS information has not changed.
ddns_use_conflict_resolution	boolean	Optional	When true, DHCP server will apply conflict resolution, as described in RFC 4703, when attempting to fulfill the update request. When false, DHCP server will simply attempt to update the DNS entries per the request, regardless of whether or not they conflict with existing entries owned by other DHCP4 clients.

Input Example

{"path_parameters":{"subnet_id":"591d65cb-1f08-11ef-9e44-e26969575d2b"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.address	string	Result of the operation
result.asm_config	object	Result of the operation
result.asm_config.asm_threshold	number	Result of the operation
result.asm_config.enable	boolean	Result of the operation
result.asm_config.enable_notification	boolean	Result of the operation
result.asm_config.forecast_period	number	Result of the operation
result.asm_config.growth_factor	number	Result of the operation
result.asm_config.growth_type	string	Type of the resource
result.asm_config.history	number	Result of the operation
result.asm_config.min_total	number	Result of the operation
result.asm_config.min_unused	number	Result of the operation
result.asm_config.reenable_date	string	Result of the operation
result.asm_scope_flag	number	Result of the operation
result.cidr	number	Unique identifier
result.comment	string	Result of the operation
result.compartment_id	string	Unique identifier
result.created_at	string	Result of the operation
result.ddns_client_update	string	Result of the operation
result.ddns_conflict_resolution_mode	string	Result of the operation
result.ddns_domain	string	Result of the operation
result.ddns_generate_name	boolean	Name of the resource
result.ddns_generated_prefix	string	Result of the operation

Output Example

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	907
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:35:39 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