Virima API Specification - InfoBloxService Services

The requests documented in this section are directed to InfoBloxService resources, which represent .

Contents

1 syncWithInfoBloxCon GET Interface
2 getInfoBloxCredential GET Interface
3 editInfoBloxCredentials POST Interface
4 editScheduleInfoBlox POST Interface
5 syncIPsWithInfoBlox POST Interface
6 getDefaultSubnetColumns GET Interface
7 getDefaultIPColumns GET Interface
8 getAllIPAMIPColumns GET Interface
9 getAllIPAMSubnetColumns GET Interface
10 deleteInfoBloxCredential GET Interface
11 syncSelectedSubnets POST Interface
12 isSyncTrue GET Interface
13 immediateStatusUpdate POST Interface
14 scheduleStatusUpdate POST Interface
15 getLocationInformation POST Interface
16 addLocation POST Interface
17 getIPAMScheduledDetails GET Interface
18 getIPAMScheduledRecordDetails GET Interface
19 deleteIPAMScheduleRecord GET Interface
20 deleteAllRecords POST Interface

syncWithInfoBloxCon GET Interface

Method: GET

Relative URL: infoblox/sync-with-infoblox-con

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getInfoBloxCredential GET Interface

Method: GET

Relative URL: infoblox/get-infoblox-credential

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

editInfoBloxCredentials POST Interface

Method: POST

Relative URL: infoblox/edit-infoblox-credential

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
infoblox	InfoBlox

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITINFOBLOXCREDENTIALS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "userName":"?",
   "password":"?",
   "lastModifiedOn":?,
   "createdOn":?,
   "ipAddress":"?",
   "client":"?",
   "uniqueId":"?",
   "archive":?,
   "isFromClient":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

editScheduleInfoBlox POST Interface

Method: POST

Relative URL: infoblox/edit-schedule-infoblox

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
scheduleinfoblox	InfoBloxScheduleSync

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITSCHEDULEINFOBLOX 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "archive":?,
   "scanFrequency":"?",
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "addedTime":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

syncIPsWithInfoBlox POST Interface

Method: POST

Relative URL: infoblox/sync-ip-with-infoblox

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SYNCIPSWITHINFOBLOX 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getDefaultSubnetColumns GET Interface

Method: GET

Relative URL: infoblox/get-default-ipam-subnet-columns

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getDefaultIPColumns GET Interface

Method: GET

Relative URL: infoblox/get-default-ip-subnet-columns

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllIPAMIPColumns GET Interface

Method: GET

Relative URL: infoblox/get-all-ipam-ip-columns

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getAllIPAMSubnetColumns GET Interface

Method: GET

Relative URL: infoblox/get-all-ipam-subnet-columns

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deleteInfoBloxCredential GET Interface

Method: GET

Relative URL: infoblox/delete-infoblox-credential

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

syncSelectedSubnets POST Interface

Method: POST

Relative URL: infoblox/sync-selected-subnets

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SYNCSELECTEDSUBNETS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1443596080,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

{
   "id":1407376509,
   "response":"?"
}

isSyncTrue GET Interface

Method: GET

Relative URL: infoblox/is-sync-true

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

immediateStatusUpdate POST Interface

Method: POST

Relative URL: infoblox/immediate-status-update

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
ipamInput	IPAMStatusUpdate

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

IMMEDIATESTATUSUPDATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "archive":?,
   "probe":"?",
   "client":?,
   "ipAddress":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

scheduleStatusUpdate POST Interface

Method: POST

Relative URL: infoblox/schedule-status-update

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
scheduleIpamInput	ScheduleIPAMStatusUpdate

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SCHEDULESTATUSUPDATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "archive":?,
   "probe":"?",
   "client":?,
   "ipAddress":"?",
   "scanFrequency":"?",
   "isScheduled":?,
   "scheduleSeconds":"?",
   "scheduleMinutes":"?",
   "scheduleHours":"?",
   "scheduleDays":"?",
   "scheduleWeeks":"?",
   "scheduleMonths":"?",
   "scheduleYears":"?",
   "recurring":?,
   "isActive":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getLocationInformation POST Interface

Method: POST

Relative URL: infoblox/get-location-info

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETLOCATIONINFORMATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":521998092,
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addLocation POST Interface

Method: POST

Relative URL: infoblox/add-location

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfLocations	LocationsList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDLOCATION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":1689715193,
   "fileName":"?",
   "arrayofLocation":[
      {
         "id":2147483647,
         "lastModifiedBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "createdBy": {
               "id":2147483647,
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "lastModifiedOn":?,
         "createdOn":?,
         "name":"?",
         "locationType":"?",
         "street":"?",
         "city":"?",
         "state":"?",
         "country":"?",
         "postalCode":"?",
         "locationCode":"?",
         "businessUnit":"?",
         "division":"?",
         "siteClass":"?",
         "siteStatus":"?",
         "legacyDomain":"?",
         "phone":"?",
         "archive":?,
         "email":"?",
         "uniqueId":"?"
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getIPAMScheduledDetails GET Interface

Method: GET

Relative URL: infoblox/get-ipam-scheduled-details

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getIPAMScheduledRecordDetails GET Interface

Method: GET

Relative URL: infoblox/get-ipam-scheduled-record-details/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

deleteIPAMScheduleRecord GET Interface

Method: GET

Relative URL: infoblox/delete-scheduled-record/id

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":1745176543,
   "response":"?"
}

deleteAllRecords POST Interface

Method: POST

Relative URL: infoblox/delete-all-records

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
listOfIds	RecordList

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

DELETEALLRECORDS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":696946442,
   "scanId":?,
   "workflowId":?,
   "fromSACM":?,
   "customerId":"?",
   "userId":"?",
   "startTime":"?",
   "idList":[
      {
         "id":2147483647,
         "flag":?
      }   ]
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}