Bulk Subnet Updates - IPAM Infoblox

PUT 
/pub/v4.0/network/subnetBulkUpdate?updateSource=ipam_infoblox

Bulk subnet updates from customer IPAM (infoblox)

Request

Query Parameters

customerid stringrequired

The customer ID specifies the API call

updateSource stringrequired

Source of integration

application/json

Body

required

dataOverwrite booleanrequired

A flag to control overwriting of subnet metadata like vlan, description etc

siteOverwrite booleanrequired

A flag to control overwriting of site

subnetList object[]required
Array of subnet attributes coming from IPAM
Array [
prefix stringrequired
IPv4 prefix
site string
A site name where prefix belongs to (customer defined)
vlan string
A vlan value between 0-4094 or keep it empty if not available
description string
Description of the prefix
name string
Name of the prefix
type string
Prefix type block or subnet
gateway string
Gateway IP of the prefix
integration_instance_name string
internally used by XSOAR server to track XSOAR agent name running on customer premises
]

Responses

200

Successful Response

application/json

Schema

Schema

api string

The path used to call the IoT Security API: “network/subnetBulkUpdate”

ver string

The version of the IoT Security API: “v4.0”

code string

The code number indicating success: 1

message string

The message indicating success: “OK”

numOfUpdatedSubnets integer

The number of successfully inserted/updated subnets

Example (from schema)

{
  "api": "string",
  "ver": "string",
  "code": "string",
  "message": "string",
  "numOfUpdatedSubnets": 0
}

resolveSecurityAlertResponseExample

{
  "api": "network/subnetBulkUpdate",
  "ver": "v4.0",
  "code": 1,
  "message": "OK",
  "updatedSubnetNum": 4
}

4XX

Client Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

Bad Request

{
  "code": 400,
  "msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}

Unauthrorized Request

{
  "code": 403,
  "msg": "Forbidden access. Either the provided API key is invalid or it does not have the required RBAC permissions to run this API."
}

5XX

Server Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

resolveSecurityAlertResponseExample

{
  "code": 500,
  "msg": "Internal server error. A unified status for API communication type errors."
}

Loading...