IPAM

Gets a list of containers

get

This endpoint is used to fetch all the containers in the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

/ux/ipam/ipam/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

post

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Container serializers

idstringRead-onlyRequired

subnetstringRead-onlyRequired

maskstringRead-onlyRequired

reservation_methodstringRead-onlyRequired

ip_countstringRead-onlyRequired

organizationstringOptional

customer_idstringOptional

config_idstringRequired

namestringOptional

descriptionstring | nullableOptional

ip_versionintegerOptional

is_deletedbooleanOptional

categorystringOptional

ip_addressstringOptional

utilization_threshold_breachintegerOptional

subnet_maskintegerOptional

is_reservedbooleanOptional

is_availabilitybooleanOptional

is_inventorybooleanOptional

agent_idstringOptional

last_scan_completedstring · date-timeOptional

last_scan_statusintegerOptional

last_inv_scan_statusintegerOptional

last_inv_scan_timestring · date-timeOptional

last_group_inv_scan_timestring · date-timeOptional

next_action_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

Responses

201Success

application/json

post

/ux/ipam/ipam/

HTTPcURLJavaScriptPython

POST /ux/ipam/ipam/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1025

{
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

Gets a container with the given id

get

This endpoint is used to fetch a container details in the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/{id}/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

put

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Container serializers

idstringRead-onlyRequired

subnetstringRead-onlyRequired

maskstringRead-onlyRequired

reservation_methodstringRead-onlyRequired

ip_countstringRead-onlyRequired

organizationstringOptional

customer_idstringOptional

config_idstringRequired

namestringOptional

descriptionstring | nullableOptional

ip_versionintegerOptional

is_deletedbooleanOptional

categorystringOptional

ip_addressstringOptional

utilization_threshold_breachintegerOptional

subnet_maskintegerOptional

is_reservedbooleanOptional

is_availabilitybooleanOptional

is_inventorybooleanOptional

agent_idstringOptional

last_scan_completedstring · date-timeOptional

last_scan_statusintegerOptional

last_inv_scan_statusintegerOptional

last_inv_scan_timestring · date-timeOptional

last_group_inv_scan_timestring · date-timeOptional

next_action_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

Responses

200Success

application/json

put

/ux/ipam/ipam/{id}/

HTTPcURLJavaScriptPython

PUT /ux/ipam/ipam/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1025

{
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

Deletes the Container with given id

delete

This endpoint is used to delete an existing container for the current organization

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idstringRequired

Responses

204

No response body

delete

/ux/ipam/ipam/{id}/

HTTPcURLJavaScriptPython

DELETE /ux/ipam/ipam/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/agent_list/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/agent_list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

post

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Container serializers

idstringRead-onlyRequired

subnetstringRead-onlyRequired

maskstringRead-onlyRequired

reservation_methodstringRead-onlyRequired

ip_countstringRead-onlyRequired

organizationstringOptional

customer_idstringOptional

config_idstringRequired

namestringOptional

descriptionstring | nullableOptional

ip_versionintegerOptional

is_deletedbooleanOptional

categorystringOptional

ip_addressstringOptional

utilization_threshold_breachintegerOptional

subnet_maskintegerOptional

is_reservedbooleanOptional

is_availabilitybooleanOptional

is_inventorybooleanOptional

agent_idstringOptional

last_scan_completedstring · date-timeOptional

last_scan_statusintegerOptional

last_inv_scan_statusintegerOptional

last_inv_scan_timestring · date-timeOptional

last_group_inv_scan_timestring · date-timeOptional

next_action_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

Responses

200Success

application/json

post

/ux/ipam/ipam/check_inventory_scan/

HTTPcURLJavaScriptPython

POST /ux/ipam/ipam/check_inventory_scan/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1025

{
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/container-entities/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/container-entities/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/dependency-status/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/dependency-status/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

post

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Container serializers

idstringRead-onlyRequired

subnetstringRead-onlyRequired

maskstringRead-onlyRequired

reservation_methodstringRead-onlyRequired

ip_countstringRead-onlyRequired

organizationstringOptional

customer_idstringOptional

config_idstringRequired

namestringOptional

descriptionstring | nullableOptional

ip_versionintegerOptional

is_deletedbooleanOptional

categorystringOptional

ip_addressstringOptional

utilization_threshold_breachintegerOptional

subnet_maskintegerOptional

is_reservedbooleanOptional

is_availabilitybooleanOptional

is_inventorybooleanOptional

agent_idstringOptional

last_scan_completedstring · date-timeOptional

last_scan_statusintegerOptional

last_inv_scan_statusintegerOptional

last_inv_scan_timestring · date-timeOptional

last_group_inv_scan_timestring · date-timeOptional

next_action_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

Responses

200Success

application/json

post

/ux/ipam/ipam/do_availability_scan/

HTTPcURLJavaScriptPython

POST /ux/ipam/ipam/do_availability_scan/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1025

{
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

post

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Container serializers

idstringRead-onlyRequired

subnetstringRead-onlyRequired

maskstringRead-onlyRequired

reservation_methodstringRead-onlyRequired

ip_countstringRead-onlyRequired

organizationstringOptional

customer_idstringOptional

config_idstringRequired

namestringOptional

descriptionstring | nullableOptional

ip_versionintegerOptional

is_deletedbooleanOptional

categorystringOptional

ip_addressstringOptional

utilization_threshold_breachintegerOptional

subnet_maskintegerOptional

is_reservedbooleanOptional

is_availabilitybooleanOptional

is_inventorybooleanOptional

agent_idstringOptional

last_scan_completedstring · date-timeOptional

last_scan_statusintegerOptional

last_inv_scan_statusintegerOptional

last_inv_scan_timestring · date-timeOptional

last_group_inv_scan_timestring · date-timeOptional

next_action_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

Responses

200Success

application/json

post

/ux/ipam/ipam/do_inventory_scan/

HTTPcURLJavaScriptPython

POST /ux/ipam/ipam/do_inventory_scan/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1025

{
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/get-subnet-name/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/get-subnet-name/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/get_audit_options/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/get_audit_options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/get_container_options/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/get_container_options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/get_ip_addresses/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/get_ip_addresses/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/group-summary/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/group-summary/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/group-summary-widget-options/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/group-summary-widget-options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/ip-container-details/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/ip-container-details/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/ip-details-grid-view/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/ip-details-grid-view/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/ip-reservation/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/ip-reservation/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/ip-reservation-config/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/ip-reservation-config/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/ip-reservation-list/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/ip-reservation-list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/ipam_audit_list/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/ipam_audit_list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/ipasset-interfaces-list/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/ipasset-interfaces-list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/ipasset-menu-details/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/ipasset-menu-details/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/ipasset-port-details/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/ipasset-port-details/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/ipasset-portmapper-details/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/ipasset-portmapper-details/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/license-check/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/license-check/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/options/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

post

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Container serializers

idstringRead-onlyRequired

subnetstringRead-onlyRequired

maskstringRead-onlyRequired

reservation_methodstringRead-onlyRequired

ip_countstringRead-onlyRequired

organizationstringOptional

customer_idstringOptional

config_idstringRequired

namestringOptional

descriptionstring | nullableOptional

ip_versionintegerOptional

is_deletedbooleanOptional

categorystringOptional

ip_addressstringOptional

utilization_threshold_breachintegerOptional

subnet_maskintegerOptional

is_reservedbooleanOptional

is_availabilitybooleanOptional

is_inventorybooleanOptional

agent_idstringOptional

last_scan_completedstring · date-timeOptional

last_scan_statusintegerOptional

last_inv_scan_statusintegerOptional

last_inv_scan_timestring · date-timeOptional

last_group_inv_scan_timestring · date-timeOptional

next_action_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

Responses

200Success

application/json

post

/ux/ipam/ipam/save-ip-allocated/

HTTPcURLJavaScriptPython

POST /ux/ipam/ipam/save-ip-allocated/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1025

{
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

post

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Container serializers

idstringRead-onlyRequired

subnetstringRead-onlyRequired

maskstringRead-onlyRequired

reservation_methodstringRead-onlyRequired

ip_countstringRead-onlyRequired

organizationstringOptional

customer_idstringOptional

config_idstringRequired

namestringOptional

descriptionstring | nullableOptional

ip_versionintegerOptional

is_deletedbooleanOptional

categorystringOptional

ip_addressstringOptional

utilization_threshold_breachintegerOptional

subnet_maskintegerOptional

is_reservedbooleanOptional

is_availabilitybooleanOptional

is_inventorybooleanOptional

agent_idstringOptional

last_scan_completedstring · date-timeOptional

last_scan_statusintegerOptional

last_inv_scan_statusintegerOptional

last_inv_scan_timestring · date-timeOptional

last_group_inv_scan_timestring · date-timeOptional

next_action_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

Responses

200Success

application/json

post

/ux/ipam/ipam/schedule/

HTTPcURLJavaScriptPython

POST /ux/ipam/ipam/schedule/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1025

{
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/scheduler-data/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/scheduler-data/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/show-ip-reservation/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/show-ip-reservation/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/subnet_agent_list/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/subnet_agent_list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/tree-data/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/tree-data/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/unmanaged_ip_list/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/unmanaged_ip_list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}

get

API endpoint that allows bot cmdb configurations to be viewed or edited.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200Success

application/json

get

/ux/ipam/ipam/visibility-data/

HTTPcURLJavaScriptPython

GET /ux/ipam/ipam/visibility-data/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "subnet": "text",
  "mask": "text",
  "reservation_method": "text",
  "ip_count": "text",
  "organization": "text",
  "customer_id": "text",
  "customer_entity_id": [],
  "config_id": "text",
  "name": "text",
  "description": "text",
  "ip_version": 1,
  "is_deleted": true,
  "category": "text",
  "id_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "user_info": [],
  "role_info": [],
  "team_info": [],
  "ip_address": "text",
  "utilization_threshold_breach": 1,
  "subnet_mask": 1,
  "is_reserved": true,
  "is_availability": true,
  "is_inventory": true,
  "reservation_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "availability_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "inventory_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "agent_id": "text",
  "last_scan_completed": "2025-12-14T15:07:46.678Z",
  "last_scan_status": 1,
  "last_inv_scan_status": 1,
  "last_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "last_group_inv_scan_time": "2025-12-14T15:07:46.678Z",
  "next_action_time": "2025-12-14T15:07:46.678Z",
  "created_by": "text",
  "modified_by": "text",
  "schedule_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "creation_time": "2025-12-14T15:07:46.678Z",
  "last_update_time": "2025-12-14T15:07:46.678Z"
}