openapi: 3.0.0
info:
title: VitalQIP RESTful APIs Document
description: Sample call for RESTful APIs
contact: {}
version: '1.0.0'
servers:
- url: https://{defaultHost}
variables:
defaultHost:
default: www.example.com/api
paths:
/login:
post:
tags:
- Authentication
summary: getToken
description: Get token
operationId: getToken
parameters: []
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/QIPUser'
- description: Request body
required: true
responses:
'200':
description: OK
headers:
Authentication:
description: Token
content:
text/plain:
schema:
type: string
description: Token
Date:
description: Date Time
content:
text/plain:
schema:
type: string
description: Date Time
Expire Time:
description: Expire Time
content:
text/plain:
schema:
type: string
description: Expire Time
content: {}
'401':
description: Authentication failed
headers: {}
content: {}
'500':
description: Server error
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v4network/{networkInfo}{extension}:
get:
tags:
- V4 Network
summary: getV4Network
description: Get V4 network by name or address
operationId: getV4Network
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: networkInfo
in: path
description: Network info (address or name of V4 network)
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V4NetworkRec'
- description: V4 Network model
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/V4NetworkRec'
- description: V4 Network model
xml:
name: V4NetworkRec
attribute: false
wrapped: false
'400':
description: '<address> is not an IPv4 network address. Network address should have format x.x.x.0 (x is a number between 1 and 255)'
headers: {}
content: {}
'404':
description: 'Network not found: [address=<address>]'
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v4network/{networkInfo}:
delete:
tags:
- V4 Network
summary: deleteV4Network
description: Delete V4 network by name or address
operationId: deleteV4Network
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: networkInfo
in: path
description: Network info (address or name of V4 network)
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
'404':
description: Network does not exist.
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v4network:
post:
tags:
- V4 Network
summary: addV4Network
description: Create a new V4 network
operationId: addV4Network
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V4NetworkRec'
- description: Request body
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'400':
description: Bad request
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: Not Found
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'409':
description: Conflict
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v4network{extension}:
get:
tags:
- V4 Network
summary: searchV4Network
description: Search V4 network by name or address.
operationId: searchV4Network
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: address
in: query
description: V4 network address
style: form
explode: true
schema:
type: string
- name: name
in: query
description: V4 network name
style: form
explode: true
schema:
type: string
- name: pageSize
in: query
description: page size of response
style: form
explode: true
schema:
type: string
- name: pageIndex
in: query
description: page index of response
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/V4NetworkRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/V4NetworkRec'
description: ''
xml:
attribute: false
wrapped: false
'400':
description: '<address> is not an IPv4 network address. Network address should have format x.x.x.0 (x is a number between 1 and 255)'
headers: {}
content: {}
'404':
description: 'Network not found: [address=<address>]'
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v6subnet/{address}/{prefixLength}{extension}:
get:
tags:
- V6 Subnet
summary: getV6SubnetByAddress
description: Get V6 subnet get by address and prefix length.
operationId: getV6SubnetByAddress
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: address
in: path
description: Address of V6 subnet
required: true
style: simple
schema:
type: string
- name: prefixLength
in: path
description: prefix length of v6 subnet
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6SubnetRec'
- description: V6 Subnet model
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/V6SubnetRec'
- description: V6 Subnet model
xml:
name: V6SubnetRec
attribute: false
wrapped: false
'404':
description: Subnet not found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v6subnet/{address}/{prefixLength}:
delete:
tags:
- V6 Subnet
summary: deleteV6SubnetByAddress
description: Delete V6 Subnet by address and prefix length.
operationId: deleteV6SubnetByAddress
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: address
in: path
description: Address of V6 subnet
required: true
style: simple
schema:
type: string
- name: prefixLength
in: path
description: prefix length of v6 subnet
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: Subnet not found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v6subnet/{address}/{prefixLength}/v6addresses{extension}:
get:
tags:
- V6 Subnet
summary: getV6AddressInV6SubnetByAddress
description: Get list v6 address in v6 subnet by address and prefixlength.
operationId: getV6AddressInV6SubnetByAddress
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: address
in: path
description: Address of V6 subnet
required: true
style: simple
schema:
type: string
- name: prefixLength
in: path
description: prefix length of v6 subnet
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/V6AddressRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/V6AddressRec'
description: ''
xml:
attribute: false
wrapped: false
'404':
description: Not found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v6subnet/{address}/{prefixLength}/ranges{extension}:
get:
tags:
- V6 Subnet
summary: getListRangeInV6SubnetByAddress
description: Get list range in v6 subnet by address and prefixlength.
operationId: getListRangeInV6SubnetByAddress
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: address
in: path
description: Address of V6 subnet
required: true
style: simple
schema:
type: string
- name: prefixLength
in: path
description: prefix length of v6 subnet
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/V6AddressRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/V6AddressRec'
description: ''
xml:
attribute: false
wrapped: false
'404':
description: Not found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v6subnet/{subnetName}{extension}:
get:
tags:
- V6 Subnet
summary: getV6SubnetByName
description: Get V6 subnet by name
operationId: getV6SubnetByName
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: subnetName
in: path
description: Name of V6 subnet
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6SubnetRec'
- description: V6 Subnet model
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/V6SubnetRec'
- description: V6 Subnet model
xml:
name: V6SubnetRec
attribute: false
wrapped: false
'404':
description: Subnet not found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v6subnet/{subnetName}:
delete:
tags:
- V6 Subnet
summary: deleteV6SubnetByName
description: Delete V6 Subnet by name
operationId: deleteV6SubnetByName
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: subnetName
in: path
description: V6 Subnet's name
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: Subnet not found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v6subnet:
post:
tags:
- V6 Subnet
summary: addV6Subnet
description: >-
Creates a new V6 Subnet. Subnet Name and Address pairs are returned after adding subnets successfully.
*Note:* Should not test this API on Swagger. Please use another REST Client (cURL, Postman).
operationId: addV6Subnet
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
requestBody:
description: The format of request body when creating a V6Subnet is different to the format of response when searching a V6Subnet. Please do not use it.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6CreateSubnetRec'
- description: The format of request body when creating a V6Subnet is different to the format of response when searching a V6Subnet. Please do not use it.
required: true
responses:
'201':
description: >-
Successfully created subnets - <subnetsNo>
<no><subnetName> - <subnetAddress>
headers: {}
content: {}
'400':
description: Bad request
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Pool not found: [name=<name>, parent=<name>]
Block not found
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'409':
description: Subnet with this name already Exists in the Parent Pool.
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
deprecated: false
put:
tags:
- V6 Subnet
summary: updateV6Subnet
description: Modify a V6 Subnet
operationId: updateV6Subnet
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6SubnetRec'
- description: Request body
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'400':
description: Bad request
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Pool not found: [name=<name>, parent=<name>]
Block not found
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'409':
description: Subnet with this name already Exists in the Parent Pool.
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6subnet{extension}:
get:
tags:
- V6 Subnet
summary: searchV6Subnet
description: Search V6 subnet by name or address.
operationId: searchV6Subnet
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
- name: address
in: query
description: V6 Subnet address
style: form
explode: true
schema:
type: string
- name: name
in: query
description: V6 Subet name
style: form
explode: true
schema:
type: string
- name: pageSize
in: query
description: page size of response
style: form
explode: true
schema:
type: string
- name: pageIndex
in: query
description: page index of response
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/V6SubnetRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/V6SubnetRec'
description: ''
xml:
attribute: false
wrapped: false
'404':
description: Subnet not found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v6address:
post:
tags:
- V6 Address
summary: addV6Address
description: Creates V6 Address
operationId: addV6Address
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6AddressRec'
- description: Request body
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'400':
description: 'Required Field(s) Missing: [field]'
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: Range not found.
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'409':
description: IPv6 address with the given IAID and DUID combination already exists within the parent subnet subnetAddress.
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
deprecated: false
put:
tags:
- V6 Address
summary: updateV6Address
description: Modify V6 Address
operationId: updateV6Address
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6AddressRec'
- description: Request body
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Address not found.
UDA group not found: [name=<groupName>].
User Defined Attribute not found: [name=<udaName>].
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6address/{addressInfo}/:
delete:
tags:
- V6 Address
summary: deleteV6Address
description: Delete V6 Address by name or address. The trailing slash is required.
operationId: deleteV6Address
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: addressInfo
in: path
description: V6 address or name
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: Address not found.
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v6address/{addressInfo}{extension}:
get:
tags:
- V6 Address
summary: getV6Address
description: Get V6 address by address or by name
operationId: getV6Address
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: addressInfo
in: path
description: Address OR object name and domain name of V6 Address
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/V6AddressRec'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/V6AddressRec'
- xml:
name: V6AddressRec
attribute: false
wrapped: false
'404':
description: Address not found.
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v4subnet:
post:
tags:
- V4 Subnet
summary: addV4Subnet
description: Creates V4 Subnet
operationId: addV4Subnet
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V4SubnetRec'
- description: Request body
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
Required Field(s) Missing: [field]
UDA <uda> is required.
UDA <uda>'s value is required.
UDA <uda> in group <group> is required.
UDA <uda>'s value in group <group> is required.
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'409':
description: Subnet address already exists
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
deprecated: false
put:
tags:
- V4 Subnet
summary: updateV4Subnet
description: Modify V4 Subnet
operationId: updateV4Subnet
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
- name: isUpdate
in: query
description: update
required: true
style: form
explode: true
schema:
type: boolean
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V4SubnetRec'
- description: Request body
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
Or "<routeAddress>" is not an IPv4 address
Or Invalid Attribute(s): <attributeName>
Or The threshold is invalid. Valid warning type is in 0 - 3. Valid warning percent is in 0 - 99.
Or Invalid input specified for [checkUsage] parameter. Required [true | false], Received [false1].
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Or Subnet having address "<address>" does not exist.
Or Domain <domainName> not found.
Or The time server object <timeServer> does not exist.
Or DHCP Server <dhcpServer> does not exist.
Or DHCP Option Template not found: [dhcpOptionTemplate]
Or DHCP Policy Template not found: [dhcpPolicyTemplate]
Or DNS Server not found: [<dnsServerName>]"
headers: {}
content: {}
'409':
description: Subnet address already exists
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v4subnet{extension}:
get:
tags:
- V4 Subnet
summary: searchV4Subnet
description: Search V4 subnet by name or address.
operationId: searchV4Subnet
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: address
in: query
description: V4 Subnet address
style: form
explode: true
schema:
type: string
- name: name
in: query
description: V4 Subet name
style: form
explode: true
schema:
type: string
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/V4SubnetRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/V4SubnetRec'
description: ''
xml:
attribute: false
wrapped: false
'404':
description: Subnet not found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v4subnet/{subnetAddress}{extension}:
get:
tags:
- V4 Subnet
summary: getV4Subnet
description: Get V4 subnet by subnet address.
Get objects usage information of a subnet using ?usage parameter
operationId: getV4Subnet
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: subnetAddress
in: path
description: Subnet address
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
- name: usage
in: query
description: Add this parameter to show subnet statistics information
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/V4SubnetRec'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/V4SubnetRec'
- xml:
name: V4SubnetRec
attribute: false
wrapped: false
'404':
description: Subnet not found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v4subnet/{subnetInfo}/:
delete:
tags:
- V4 Subnet
summary: deleteV4SubnetByName
description: Delete V4 Subnet by name or by address. The trailing slash is required.
operationId: deleteV4SubnetByName
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: subnetInfo
in: path
description: V4 Subnet's name or address
required: true
style: simple
schema:
type: string
- name: multipleDelete
in: query
description: Multiple delete
style: form
explode: true
schema:
type: boolean
- name: deleteReserveObjects
in: query
description: delete reserve objects
style: form
explode: true
schema:
type: boolean
- name: application
in: query
description: application name
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: Subnet having address <subnetAddress> does not exist.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v4subnet/{subnetAddress}/v4addresses{extension}:
get:
tags:
- V4 Subnet
summary: getListAddressV4Subnet
description: Get list V4 address of a V4 Subnet by subnet address
operationId: getListAddressV4Subnet
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: subnetAddress
in: path
description: Subnet address
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/V4AddrRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/V4AddrRec'
description: ''
xml:
attribute: false
wrapped: false
'404':
description: Subnet not found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v4address:
post:
tags:
- V4 Address
summary: addV4Address
description: Creates V4 Address
operationId: addV4Address
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V4AddrRec'
- description: Request body
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: 'Required Field(s) Missing: [field]'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: Given IP Address <address> already exists in subnet <subnet>.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
put:
tags:
- V4 Address
summary: updateV4Address
description: Modify V4 Address
operationId: updateV4Address
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V4AddrRec'
- description: Request body
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
Address not found
UDA group not found: [name=G33].
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: 'User Defined Attribute not found: [name=1231].'
headers: {}
content: {}
'409':
description: Given IP Address 1.1.1.20 already exists in subnet 1.1.1.0.
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v4address/{addressInfo}/:
delete:
tags:
- V4 Address
summary: deleteV4Address
description: Delete V4 Address by name or address. The trailing slash is required.
operationId: deleteV4Address
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: addressInfo
in: path
description: V4 address or name
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Could not find IPv4 Address <address>.
Or No object is found
headers: {}
content: {}
deprecated: false
/v1/{orgName}/v4address/{addressInfo}{extension}:
get:
tags:
- V4 Address
summary: getV4Address
description: Get V4 address by name or by address
operationId: getV4Address
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: addressInfo
in: path
description: Address or object name of V4 Address
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json or null if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/V4AddrRec'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/V4AddrRec'
- xml:
name: V4AddrRec
attribute: false
wrapped: false
'404':
description: >-
Object name <name> is not found.
Address <address> is not found.
headers: {}
content: {}
deprecated: false
/v1/{orgName}/rr/singleDelete:
delete:
tags:
- RR
summary: deleteASingleRr
description: Delete a single RR
operationId: deleteASingleRr
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
- name: infraFQDN
in: query
description: Infrastrucutre Full Qualify Domain Name - Required if not address
style: form
explode: true
schema:
type: string
- name: address
in: query
description: Address of infrastructure. - Required if not infraFQDN
style: form
explode: true
schema:
type: string
- name: infraType
in: query
description: 'Type of infrastructure: OBJECT|V6ADDRESS|ZONE|V4REVERSEZONE|V6REVERSEZONE'
required: true
style: form
explode: true
schema:
type: string
- name: rrType
in: query
description: Type of resource record.
style: form
explode: true
schema:
type: string
- name: owner
in: query
description: Owner name for the resource record.
style: form
explode: true
schema:
type: string
- name: ttl
in: query
description: >-
The length of time (in seconds) the name server will hold this information.
If no TTL is defined, the value is inherited from the zone.
style: form
explode: true
schema:
type: string
- name: data1
in: query
description: The data associated with the specific resource record type.
style: form
explode: true
schema:
type: string
- name: data2
in: query
description: The data associated with the specific resource record type.
style: form
explode: true
schema:
type: string
- name: data3
in: query
description: The data associated with the specific resource record type.
style: form
explode: true
schema:
type: string
- name: data4
in: query
description: The data associated with the specific resource record type.
style: form
explode: true
schema:
type: string
- name: publishing
in: query
description: Publishing type.
style: form
explode: true
schema:
type: string
- name: classType
in: query
description: Class type of records pertains to a type of network or software.
style: form
explode: true
schema:
type: string
responses:
'204':
description: No content
headers: {}
content: {}
'404':
description: Network does not exist.
headers: {}
content: {}
'406':
description: Not Acceptable.
headers: {}
content: {}
deprecated: false
/v1/{orgName}/rr/{infraType}/{rrInfo}/:
delete:
tags:
- RR
summary: deleteRRbyInfraTypebyNameOrAddress
description: Delete All RRs by infraType and by name or address. The trailing slash is required.
operationId: deleteRRbyInfraTypebyNameOrAddress
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
- name: infraType
in: path
description: 'infratype: OBJECT|V6ADDRESS|ZONE|V4REVERSEZONE|V6REVERSEZONE|NODE'
required: true
style: simple
schema:
type: string
- name: rrInfo
in: path
description: name or address
required: true
style: simple
schema:
type: string
responses:
'204':
description: No content
headers: {}
content: {}
'404':
description: Network does not exist.
headers: {}
content: {}
'406':
description: Not Acceptable.
headers: {}
content: {}
deprecated: false
/v1/{orgName}/rr/{rrInfo}/:
delete:
tags:
- RR
summary: deleteRRsbyNameOrAddress
description: Delete All RRs by name or address. The trailing slash is required.
operationId: deleteRRsbyNameOrAddress
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
- name: rrInfo
in: path
description: name or address
required: true
style: simple
schema:
type: string
responses:
'204':
description: No content
headers: {}
content: {}
'404':
description: Network does not exist.
headers: {}
content: {}
'406':
description: Not Acceptable.
headers: {}
content: {}
deprecated: false
/v1/{orgName}/rr{extension}:
get:
tags:
- RR
summary: getRRByName
description: Search RR by name or address.
operationId: getRRByName
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
- name: name
in: query
description: Infrastrucutre FQDN - Required if Search RR by name
style: form
explode: true
schema:
type: string
- name: address
in: query
description: Address of infrastructure - Required if Search RR by address
style: form
explode: true
schema:
type: string
- name: pageIndex
in: query
description: page index
style: form
explode: true
schema:
type: number
format: double
- name: pageSize
in: query
description: page size
style: form
explode: true
schema:
type: number
format: double
- name: type
in: query
description: 'infrastructure type: OBJECT|V6ADDRESS|ZONE|V4REVERSEZONE|V6REVERSEZONE|NODE|ALL'
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RRRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/RRRec'
description: ''
xml:
attribute: false
wrapped: false
'404':
description: Not resource record found.
headers: {}
content: {}
'406':
description: Not acceptable
headers: {}
content: {}
deprecated: false
/v1/{orgName}/rr:
post:
tags:
- RR
summary: addRR
description: Creates a new RR
operationId: addRR
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RRRec'
- description: Request body
example:
owner: Owner1
classType: IN
rrType: PTR
data1: data1
publishing: ALWAYS
ttl: '3200'
infraType: OBJECT
infraFQDN: infraFQDN
data2: data2
data3: data3
data4: data4
infraAddr: 192.168.88.1
isCreatingReverseZoneRR: true
example:
owner: Owner1
classType: IN
rrType: PTR
data1: data1
publishing: ALWAYS
ttl: '3200'
infraType: OBJECT
infraFQDN: infraFQDN
data2: data2
data3: data3
data4: data4
infraAddr: 192.168.88.1
isCreatingReverseZoneRR: true
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'400':
description: Bad request
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Pool not found: [name=<name>, parent=<name>]
Block not found
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
'409':
description: Subnet with this name already Exists in the Parent Pool.
headers: {}
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
xml:
name: response
attribute: false
wrapped: false
deprecated: false
delete:
tags:
- RR
summary: DeleteRR
description: Delete All RRs or Delete Single RR using request body
operationId: DeleteRR
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
responses:
'204':
description: No content
headers: {}
content: {}
'404':
description: Network does not exist.
headers: {}
content: {}
'406':
description: Not Acceptable.
headers: {}
content: {}
deprecated: false
put:
tags:
- RR
summary: updateRR
description: Update a RR
operationId: updateRR
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: "Organization Name
\nExample: VitalQIP Organization"
required: true
style: simple
schema:
type: string
requestBody:
description: Request body when modify RR
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateRRRec'
- description: Request body when modify RR
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: Bad request
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: Not Found
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: Conflict
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/selectedv4address/{address}/:
delete:
tags:
- Selected V4 Address
summary: DeleteSelectedV4address
description: Delete selected V4 address by address
operationId: DeleteSelectedV4address
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
- name: address
in: path
description: subnet address
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
'500':
description: Internal Server Error - IP address [address] does not have an object associated with it
headers: {}
content: {}
deprecated: false
/v1/{orgName}/selectedv4address/{v4SubnetAddress}{extension}:
put:
tags:
- Selected V4 Address
summary: selectedV4addressWithRange
description: Get allows to select an IPv4 from a specific IPv4 subnet or Get next Ipv4 address (getting a next address from a subnet can take an optional set of start/end address pairs)
operationId: selectedV4addressWithRange
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
- name: v4SubnetAddress
in: path
description: subnet address
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
requestBody:
description: Request body - Required if get a next address in range
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddrRangeList'
- description: Request body - Required if get a next address in range
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NextV4AddrRec'
- description: NextV4AddrRec model
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/NextV4AddrRec'
- description: NextV4AddrRec model
xml:
name: NextV4AddrRec
attribute: false
wrapped: false
'400':
description: Bad request
headers: {}
content: {}
'500':
description: Internal Server Error - Allocation pool AddrRange [startAddress=<address>, endAddress=<address>] already exists/overlaps existed pool AddrRange [startAddress=<address>, endAddress=<address>]
headers: {}
content: {}
deprecated: false
/v1/{orgName}/selectedv6address/{address}:
delete:
tags:
- Selected V6 Address
summary: DeleteSelectedV6address
description: Delete selected V6 address by address
operationId: DeleteSelectedV6address
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
- name: address
in: path
description: range address
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
'404':
description: Not found - Address address was not found in database.
headers: {}
content: {}
'406':
description: Not Acceptable - The object [address] is not a selected object.
headers: {}
content: {}
deprecated: false
/v1/{orgName}/selectedv6address/{address}{extension}:
put:
tags:
- Selected V6 Address
summary: selectedV6addressWithRange
description: Get allows you to get the detailed information for one IPv6 address. Get next Ipv6address (getting a next address from a subnet can take an optional set of start/end address pairs)
operationId: selectedV6addressWithRange
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization name
required: true
style: simple
schema:
type: string
- name: address
in: path
description: address
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: ".json if you want to reponse with JSON format
\n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json if you want to reponse with JSON format
\n.xml to reponse with XML format"
example: .json
requestBody:
description: Request body - Required if Get a next address in range.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddrRangeList'
- description: Request body - Required if Get a next address in range.
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6GetIpAddressRec'
- description: V6GetIpAddressRec model
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/V6GetIpAddressRec'
- description: V6GetIpAddressRec model
xml:
name: V6GetIpAddressRec
attribute: false
wrapped: false
'400':
description: Bad request - Permission denied. You do not have appropriate privileges to perform this action.
headers: {}
content: {}
'404':
description: Not Found - Subnet Not Found
headers: {}
content: {}
'500':
description: >-
Internal Server Error The start address <address> must be less than the end address <address>.
Internal Server Error The start address or the end address is invalid AddrRange [startAddress=<address>, endAddress=<address>]
Internal Server Error - Allocation pool AddrRange [startAddress=<address>, endAddress=<address>] already exists/overlaps existed pool AddrRange [startAddress=<address>, endAddress=<address>].
headers: {}
content: {}
deprecated: false
/v1/{orgName}/zone:
post:
tags:
- Zone
summary: addZone
description: >
Create a new DNS zone
operationId: addZone
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
requestBody:
description: The zone request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DNSZoneRec'
- description: The zone request body
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
Required Field(s) Missing: <name>.
Domain <name> contains invalid characters
Invalid zone contact address: <contact>
Required Field(s) Missing: <email>.
Invalid zone contact address: <email>.
UDA <uda> is not associated with the given infrastructure.
UDA Group <udagroup> is not associated with the given infrastructure.
UDA <uda> is required.
UDA <uda>'s value is required.
UDA <uda> in group <group> is required.
UDA <uda>'s value in group <group> is required.
Required Field(s) Missing: [Zone name]
Required Field(s) Missing: [Email]
Required Field(s) Missing: [expireTime]
Required Field(s) Missing: [negativeCacheTtl]
Required Field(s) Missing: [defaultTtl]
Required Field(s) Missing: [refreshTime]
Required Field(s) Missing: [retryTime]
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: 'DNS Server not found: [<dnsServers>]'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: 'Cannot save the zone <zone>: It already exists in database.'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: >-
Invalid permissions for the requested operation.
Permission Denied. You do not have appropriate privileges to perform this action for normal administrator.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
put:
tags:
- Zone
summary: modifyZone
description: >
Modify a global zone.
operationId: modifyZone
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
requestBody:
description: The zone request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DNSZoneRec'
- description: The zone request body
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
The first DNS Server must be added as an primary server.
DNS Server not found: <dnsServer>.
Required Field(s) Missing: <name>.
Required Field(s) Missing: <email>.
Invalid zone contact address: <email>.
UDA <uda> is required.
UDA <uda>'s value is required.
UDA <uda> in group <group> is required.
UDA <uda>'s value in group <group> is required.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: 'DNS Zone not found: <dnsServer>.'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: >-
Not a valid IPv6 Address.
Range address <networkAddress> is not valid for this subnet <subnet>.
Range address <networkAddress> already exists/overlaps for this subnet <subnet>.
Cannot save the zone <zone>: It already exists in database.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: >-
Invalid permissions for the requested operation.
Permission Denied. You do not have appropriate privileges to perform this action for normal administrator.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/zone{extension}:
get:
tags:
- Zone
summary: searchZone
description: Search zones by name. It just return basic information of Dns zone such as name, email, defaultTtl, exprireTime, nagativeCacheTtl, refreshTime and retryTime
operationId: searchZone
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
example: .json
- name: name
in: query
description: "Name of the zone for which you are searching.\nYou can use an asterisk (*) as a wildcard character to \nreturn a range of results. If you use the asterisk as \nthe first or only character, you must put this value in \neither single or double quotes."
required: true
style: form
explode: true
schema:
type: string
- name: pageIndex
in: query
description: page index
style: form
explode: true
schema:
type: integer
format: int32
- name: pageSize
in: query
description: Page size. Default value is 25.
style: form
explode: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DNSZoneRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/DNSZoneRec'
description: ''
xml:
attribute: false
wrapped: false
'400':
description: 'Required Field(s) Missing: <name>.'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: Record Not Found
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/zone/{zoneName}{extension}:
get:
tags:
- Zone
summary: getZone
description: Get full profile of a Dns zone by name
operationId: getZone
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: extension
in: path
description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
example: .json
- name: zoneName
in: path
description: Zone name
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DNSZoneRec'
- description: "This section defines a group of operations for adding a global zone. Different messages, \nand capabilities, are provided to handle the adding. Add, Get and Update actions support \nare supported."
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/DNSZoneRec'
- description: "This section defines a group of operations for adding a global zone. Different messages, \nand capabilities, are provided to handle the adding. Add, Get and Update actions support \nare supported."
xml:
name: DNSZoneRec
attribute: false
wrapped: false
'404':
description: Record Not Found
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/zone/{name}/:
delete:
tags:
- Zone
summary: deleteZone
description: >
Delete a global zone by name. The trailing slash is required.
operationId: deleteZone
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: name
in: path
description: Name of the zone being deleted.
required: true
style: simple
schema:
type: string
responses:
'204':
description: No Content
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: 'DNS Zone not found: <dnsServer>.'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6block:
post:
tags:
- V6 Block
summary: addV6BlockToPool
description: >-
Add V6 Block to V6 Pool.
*Note:* Should not test this API on Swagger. Please use another REST Client (cURL, Postman).
operationId: addV6BlockToPool
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6BlockRec'
- description: Request body
example:
name: B1
address: '4000::'
prefixLength: 48
minPrefix: 64
maxPrefix: 48
defaultPrefix: 56
algorithmType: BEST_FIT_FROM_START
poolName: P1
createType: 1
createReverseZone: false
udas:
- name: atb1
value: 'true'
groups:
- name: grp1
udas:
- name: atb1
value: 'true'
example:
name: B1
address: '4000::'
prefixLength: 48
minPrefix: 64
maxPrefix: 48
defaultPrefix: 56
algorithmType: BEST_FIT_FROM_START
poolName: P1
createType: 1
createReverseZone: false
udas:
- name: atb1
value: 'true'
groups:
- name: grp1
udas:
- name: atb1
value: 'true'
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
Required Field(s) Missing: [name]
Required Field(s) Missing: [address]
Required Field(s) Missing: [algorithmType]
Required Field(s) Missing: [prefixLength]
Required Field(s) Missing: [minPrefix]
Required Field(s) Missing: [maxPrefix]
Required Field(s) Missing: [defaultPrefix]
Required Field(s) Missing: [poolName]
Required Field(s) Missing: [createType]
Field value is not correct : [name=prefixLength]
Field value is not correct : [name=minPrefix]
Field value is not correct : [name=maxPrefix]
Field value is not correct : [name=defaultPrefix]
Field value is not correct : [name=createType]
Field value is not correct : [name=algorithmType]
Field value is not correct : [name=address]
UDA <udaName>'s Value <udaValue> is not an valid Boolean Value.
Required input UDA Enabled QIP Type: <udaName> is invalid.
Invalid Attribute(s): <udaValue>.
UDA <udaName>'s Value <udaValue> is not an valid Integer Value.
UDA <udaName>'s value <udaValue> is an invalid IP address.
UDA <uda> is required.
UDA <uda>'s value is required.
UDA <uda> in group <group> is required.
UDA <uda>'s value in group <group> is required.
Field value is not correct : [name=minPrefix|defaultPrefix|maxPrefix]
Field value is not correct : [name=minPrefix|maxPrefix]
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Pool not found: [name= <poolName>, parent= <parentPoolName>]
User Defined Attribute not found: [name= <udaName>].
UDA group not found: [name= <udaGroupName>].
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: >-
Given Seed Block <blockAddress> already exists or has an overlap with
Seed Block <blockAddress> in <poolName>
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: >-
Invalid permissions for the requested operation
UDA <udaName> is not associated with the given infrastructure.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
put:
tags:
- V6 Block
summary: modifyV6Block
description: Modify V6 Block
operationId: modifyV6Block
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6BlockRec'
- description: Request body
example:
name: B1
address: '4000::'
prefixLength: 48
minPrefix: 64
maxPrefix: 48
defaultPrefix: 56
algorithmType: BEST_FIT_FROM_START
poolName: P1
createType: 1
createReverseZone: false
udas:
- name: atb1
value: 'true'
groups:
- name: grp1
udas:
- name: atb1
value: 'true'
example:
name: B1
address: '4000::'
prefixLength: 48
minPrefix: 64
maxPrefix: 48
defaultPrefix: 56
algorithmType: BEST_FIT_FROM_START
poolName: P1
createType: 1
createReverseZone: false
udas:
- name: atb1
value: 'true'
groups:
- name: grp1
udas:
- name: atb1
value: 'true'
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
Field value is not correct : [name=prefixLength]
Field value is not correct : [name=minPrefix]
Field value is not correct : [name=maxPrefix]
Field value is not correct : [name=defaultPrefix]
Field value is not correct : [name=createType]
Field value is not correct : [name=algorithmType]
Field value is not correct : [name=address]
Field value is not correct : [name=createType]
UDA <udaName>'s Value <udaValue> is not an valid Boolean Value.
Required input UDA Enabled QIP Type: <udaName> is invalid.
Invalid Attribute(s): <udaValue>.
UDA <udaName>'s Value <udaValue> is not an valid Integer Value.
UDA <udaName>'s value <udaValue> is an invalid IP address.
UDA <uda> is required.
UDA <uda>'s value is required.
UDA <uda> in group <group> is required.
UDA <uda>'s value in group <group> is required.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Pool not found: [name= <pool>, parent= <parent>]
User Defined Attribute not found: [name= <udaName>].
UDA group not found: [name= <udaGroupName>].
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: Given Seed Block <blockAddress> already exists or has an overlap with Seed Block <blockAddress> in <poolName>
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: >-
Invalid permissions for the requested operation
UDA <udaName> is not associated with the given infrastructure.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6block{extension}:
get:
tags:
- V6 Block
summary: searchV6Block
description: Search V6 Block by name or address - Support search wildcard.
operationId: searchV6Block
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: extension
in: path
description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
example: .json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: name
in: query
description: Name of the block.
style: form
explode: true
schema:
type: string
- name: address
in: query
description: Address of the block (prefix/prefixlength).
style: form
explode: true
schema:
type: string
- name: poolName
in: query
description: Name of the parent pool.
style: form
explode: true
schema:
type: string
- name: pageSize
in: query
description: page size of response
style: form
explode: true
schema:
type: string
- name: pageIndex
in: query
description: page index of response
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/V6BlockRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/V6BlockRec'
description: ''
xml:
attribute: false
wrapped: false
'400':
description: >-
Required Field(s) Missing: [name]
Required Field(s) Missing: [address]
Required Field(s) Missing: [poolName]
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: Block not found
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6block/{uuid}{extension}:
get:
tags:
- V6 Block
summary: getV6BlockByUUID
description: Get V6 Block by UUID
operationId: getV6BlockByUUID
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: extension
in: path
description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
example: .json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: uuid
in: path
description: UUID of the block.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/V6BlockRec'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/V6BlockRec'
- xml:
name: V6BlockRec
attribute: false
wrapped: false
'400':
description: 'Required Field(s) Missing: [uuid]'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: Block not found
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6block/{blockInfo}:
delete:
tags:
- V6 Block
summary: deleteV6BlockByBlockInfo
description: Delete V6 Block by UUID or Name or Name and Pool Path.
operationId: deleteV6BlockByBlockInfo
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: blockInfo
in: path
description: blockInfo is UUID or blockName.
required: true
style: simple
schema:
type: string
- name: poolPath
in: query
description: Name of parent pool or Hierarchical path to the parent pool if parent pool name is not unique enough.
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
Required Field(s) Missing: [name]
Required Field(s) Missing: [address]
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: Block not found
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: >-
Invalid permissions for the requested operation
Block name not unique. Use Block address to perform operation.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6block/{blockAddress}/{prefixLength}:
delete:
tags:
- V6 Block
summary: deleteV6BlockByAddress
description: Delete V6 Block by Address.
operationId: deleteV6BlockByAddress
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: blockAddress
in: path
description: Address of the block.
required: true
style: simple
schema:
type: string
- name: prefixLength
in: path
description: Prefixlength of address.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: 'Required Field(s) Missing: [address]'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: Block not found
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: Invalid permissions for the requested operation
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6block/assignment:
put:
tags:
- V6 Block
summary: assignV6Block
description: Assign V6 Block
operationId: assignV6Block
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
requestBody:
description: Request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6BlockAssign'
- description: Request body
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
Required Field(s) Missing: [targetPool]
Required Field(s) Missing: [sourcePool]
Required Field(s) Missing: [sourceBlock]
Required Field(s) Missing: [prefixLength]
Required Field(s) Missing: [assignmentType]
Required Field(s) Missing: [newBlockName]
Required Field(s) Missing: [assignAlgorithm]
Field value is not correct : [name=minPrefix]
Field value is not correct : [name=maxPrefix]
Field value is not correct : [name=defaultPrefix]
Field value is not correct : [name=createType]
Default prefix length missing or invalid range.
Default algorithm missing.
Start address missing.
Prefix length missing or invalid range.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Pool not found: [name= <poolName>, parent= <parentPoolName>]
Source block does not exists.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: Given Seed Block <blockAddress> already exists or has an overlap with Seed Block <blockAddress> in <poolName>
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: >-
Pool Name cannot be modified
Source block does not belong to source pool.
Pool cannot assign block to ancestors.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6range{extension}:
get:
tags:
- V6 Range
summary: searchV6Range
description: Search an IPv6 range by name or address.
operationId: searchV6Range
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: name
in: query
description: Range name.
style: form
explode: true
schema:
type: string
- name: address
in: query
description: IPv6 address of range.
style: form
explode: true
schema:
type: string
- name: subnet
in: query
description: IPv6 address of the subnet.
style: form
explode: true
schema:
type: string
- name: pageIndex
in: query
description: page index
style: form
explode: true
schema:
type: integer
format: int32
- name: pageSize
in: query
description: page size
style: form
explode: true
schema:
type: integer
format: int32
- name: extension
in: path
description: ".json if you want to reponse with JSON format \n.xml to reponse with XML format"
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: ".json if you want to reponse with JSON format \n.xml to reponse with XML format"
example: .json
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/V6RangeRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/V6RangeRec'
description: ''
xml:
attribute: false
wrapped: false
'400':
description: 'Required Field(s) Missing: [name | startAddress | name and subnet]'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: Range not found
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6range:
post:
tags:
- V6 Range
summary: addV6Range
description: Create an IPv6 range.
operationId: addV6Range
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
requestBody:
description: The request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6RangeRec'
- description: The request body
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: "Not a valid IP Address.\n \nField value is not correct : <name>.\n\nField value is not correct : <startAddress>.\n\nField value is not correct : <newStartAddress>.\n\nField(s) <subnetPrefixLength> cannot be zero.\n\nField value is not correct : <rangePrefixLength>.\n\nField value is not correct : <rangeType>.\n\nField value is not correct : <addressSelection>.\n\nField value is not correct : <standPrimDHCPServer>.\n\nField value is not correct : <optTemplate>.\n\nUDA <udaName>'s Value <udaValue> is not an valid Boolean Value.\n\nRequired input UDA Enabled QIP Type: <udaName> is invalid.\n\nInvalid Attribute(s): <udaValue>.\n\nUDA <udaName>'s Value <udaValue> is not an valid Integer Value.\n\nUDA <udaName>'s value <udaValue> is an invalid IP address.\n\nUDA <uda> is required.\n\nUDA <uda>'s value is required.\n\nUDA <uda> in group <group> is required.\n\nUDA <uda>'s value in group <group> is required."
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
User Defined Attribute not found: <udaName>.
UDA group not found: <udaGroupName>
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: Range address <subnetPrefixLength> is not valid for this subnet <standPrimDHCPServer>.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: Invalid permissions for the requested operation.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
delete:
tags:
- V6 Range
summary: deleteV6Range
description: >
Delete an IPv6 range from an IPv6 subnet by name or address.
operationId: deleteV6Range
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: name
in: query
description: Range name.
style: form
explode: true
schema:
type: string
- name: address
in: query
description: IPv6 address of range.
style: form
explode: true
schema:
type: string
- name: subnet
in: query
description: IPv6 address of the subnet.
style: form
explode: true
schema:
type: string
responses:
'204':
description: No Content
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: 'Required Field(s) Missing: <name>'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Range not found.
Range not unique. Use range address to perform operation.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
put:
tags:
- V6 Range
summary: modifyV6Range
description: Modify an IPv6 range.
operationId: modifyV6Range
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
requestBody:
description: The request body
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6RangeRec'
- description: The request body
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: "Not a valid IP Address.\n \nField value is not correct : <name>.\n\nField value is not correct : <startAddress>.\n\nField value is not correct : <newStartAddress>.\n\nField(s) <subnetPrefixLength> cannot be zero.\n\nField value is not correct : <rangePrefixLength>.\n\nField value is not correct : <rangeType>.\n\nField value is not correct : <addressSelection>.\n\nField value is not correct : <standPrimDHCPServer>.\n\nField value is not correct : <optTemplate>.\n\nUDA <udaName>'s Value <udaValue> is not an valid Boolean Value.\n\nRequired input UDA Enabled QIP Type: <udaName> is invalid.\n\nInvalid Attribute(s): <udaValue>.\n\nUDA <udaName>'s Value <udaValue> is not an valid Integer Value.\n\nUDA <udaName>'s value <udaValue> is an invalid IP address.\n\nUDA <uda> is required.\n\nUDA <uda>'s value is required.\n\nUDA <uda> in group <group> is required.\n\nUDA <uda>'s value in group <group> is required."
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
User Defined Attribute not found: <udaName>.
UDA group not found: <udaGroupName>
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: Range address <subnetPrefixLength> is not valid for this subnet <standPrimDHCPServer>.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: Invalid permissions for the requested operation.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6pool{extension}:
get:
tags:
- V6 Pool
summary: searchV6Pool
description: Search V6 pool by name.
operationId: searchV6Pool
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: extension
in: path
description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
example: .json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: name
in: query
description: Name of pool. Support * character.
required: true
style: form
explode: true
schema:
type: string
- name: poolPath
in: query
description: Name of parent pool or Hierarchical path to the parent pool if parent pool name is not unique enough.
style: form
explode: true
schema:
type: string
- name: pageSize
in: query
description: page size of response
style: form
explode: true
schema:
type: string
- name: pageIndex
in: query
description: page index of response
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/V6PoolRec'
description: ''
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/V6PoolRec'
description: ''
xml:
attribute: false
wrapped: false
'400':
description: 'Required Field(s) Missing: [name]'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: 'Pool not found: [name= <pool>, parent= <parent>]'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6pool/{uuid}{extension}:
get:
tags:
- V6 Pool
summary: getV6PoolByUUID
description: Get V6 Pool by UUID
operationId: getV6PoolByUUID
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: >-
application/xml
application/json
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- description: >-
application/xml
application/json
example: application/json
- name: extension
in: path
description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/extension'
- description: >-
.json or null if you want to reponse with JSON format
.xml to reponse with XML format
example: .json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: uuid
in: path
description: UUID of the pool
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/V6PoolRec'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/V6PoolRec'
- xml:
name: V6PoolRec
attribute: false
wrapped: false
'400':
description: ''
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: 'Pool not found: [UUID= <uuid>]'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6pool:
post:
tags:
- V6 Pool
summary: addV6Pool
description: >-
Create V6 Pool. It will return the UUID.
*Note:* Should not test this API on Swagger. Please use another REST Client (cURL, Postman).
operationId: addV6Pool
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
requestBody:
description: You don't need set value for parentName if you want to create a Seed Pool.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6PoolRec'
- description: You don't need set value for parentName if you want to create a Seed Pool.
example:
name: ChildPool1
parentName: Pool1
fullQualifiedParentPoolName: Pool/Pool1
contact: restapi@example.com
blockReqType: MANUAL_PARENT_REQUEST
assignBlockType: APPROVAL_REQUIRED
notificationType: REQUESTS_AND_ASSIGNMENTS
algorithmType: BEST_FIT_FROM_START
minPrefix: 64
maxPrefix: 48
defaultPrefix: 56
createReverseZone: true
udas:
- name: atb1
value: 'true'
groups:
- name: grp1
udas:
- name: atb1
value: 'true'
example:
name: ChildPool1
parentName: Pool1
fullQualifiedParentPoolName: Pool/Pool1
contact: restapi@example.com
blockReqType: MANUAL_PARENT_REQUEST
assignBlockType: APPROVAL_REQUIRED
notificationType: REQUESTS_AND_ASSIGNMENTS
algorithmType: BEST_FIT_FROM_START
minPrefix: 64
maxPrefix: 48
defaultPrefix: 56
createReverseZone: true
udas:
- name: atb1
value: 'true'
groups:
- name: grp1
udas:
- name: atb1
value: 'true'
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
Required Field(s) Missing: [name]
Required Field(s) Missing: [contact]
Required Field(s) Missing: [assignBlockType]
Required Field(s) Missing: [notificationType]
Required Field(s) Missing: [algorithmType]
Required Field(s) Missing: [minPrefix]
Required Field(s) Missing: [maxPrefix]
Required Field(s) Missing: [defaultPrefix]
Required Field(s) Missing: [blockReqType]
Field value is not correct : [name=assignBlockType]
Field value is not correct : [name=notificationType]
Field value is not correct : [name=algorithmType]
Field value is not correct : [name=minPrefix]
Field value is not correct : [name=maxPrefix]
Field value is not correct : [name=defaultPrefix]
Field value is not correct : [name=blockReqType]
Invalid Email Addresses <contact> specified for the given Pool <name>
Invalid Block Request Type. Block Request Type <blockReqType> is not supported.
Invalid Assign Request Type. Assign Request Type <assignBlockType> is not supported.
Invalid Notification Type. Notification <notificationType> is not supported.
Invalid Allocation Algorithm. Algorithm <algorithmType> is not supported.
UDA <udaName>'s Value <udaValue> is not an valid Boolean Value.
Required input UDA Enabled QIP Type: <udaName> is invalid.
Invalid Attribute(s): <udaValue>.
UDA <udaName>'s Value <udaValue> is not an valid Integer Value.
UDA <udaName>'s value <udaValue> is an invalid IP address.
UDA <udaName> is not associated with the given infrastructure.
UDA Group <udaGroupName> is not associated with the given infrastructure.
UDA <uda> is required.
UDA <uda>'s value is required.
UDA <uda> in group <group> is required.
UDA <uda>'s value in group <group> is required.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Parent Pool does not exists.
User Defined Attribute not found: [name= <udaName>].
UDA group not found: [name= <udaGroupName>].
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: >-
Pool name not unique: [name= <poolName>]
There is more than one address pool named <poolName>. Parent pool
name is required.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: Invalid permissions for the requested operation
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
put:
tags:
- V6 Pool
summary: modifyV6Pool
description: Modify V6 Pool
operationId: modifyV6Pool
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
requestBody:
description: Add parentName to modify child pool
Remove parentName to modify seed pool.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/V6PoolRec'
- description: Add parentName to modify child pool
Remove parentName to modify seed pool.
example:
name: ChildPool1
parentName: Pool1
fullQualifiedParentPoolName: Pool/Pool1
contact: restapi@example.com
blockReqType: MANUAL_PARENT_REQUEST
assignBlockType: APPROVAL_REQUIRED
notificationType: REQUESTS_AND_ASSIGNMENTS
algorithmType: BEST_FIT_FROM_START
minPrefix: 64
maxPrefix: 48
defaultPrefix: 56
createReverseZone: true
udas:
- name: atb1
value: 'true'
groups:
- name: grp1
udas:
- name: atb1
value: 'true'
example:
name: ChildPool1
parentName: Pool1
fullQualifiedParentPoolName: Pool/Pool1
contact: restapi@example.com
blockReqType: MANUAL_PARENT_REQUEST
assignBlockType: APPROVAL_REQUIRED
notificationType: REQUESTS_AND_ASSIGNMENTS
algorithmType: BEST_FIT_FROM_START
minPrefix: 64
maxPrefix: 48
defaultPrefix: 56
createReverseZone: true
udas:
- name: atb1
value: 'true'
groups:
- name: grp1
udas:
- name: atb1
value: 'true'
required: true
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: >-
Required Fields) Missing: [name]
Field value is not correct : [name=assignBlockType]
Field value is not correct : [name=notificationType]
Field value is not correct : [name=algorithmType]
Field value is not correct : [name=minPrefix]
Field value is not correct : [name=maxPrefix]
Field value is not correct : [name=defaultPrefix]
Field value is not correct : [name=blockReqType]
UDA <udaName>'s Value <udaValue> is not an valid Boolean Value.
Required input UDA Enabled QIP Type: <udaName> is invalid.
Invalid Attribute(s): <udaValue>.
UDA <udaName>'s Value <udaValue> is not an valid Integer Value.
UDA <udaName>'s value <udaValue> is an invalid IP address.
UDA <uda> is required.
UDA <uda>'s value is required.
UDA <uda> in group <group> is required.
UDA <uda>'s value in group <group> is required.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: >-
Pool not found: [name= <poolName>, parent= <parentPoolName>]
User Defined Attribute not found: [name= <udaName>].
UDA group not found: [name= <udaGroupName>].
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: "Pool name not unique: [name= <poolName>] \n\nThere is more than one address pool named <poolName>. Parent pool\nname is required."
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'500':
description: >-
Invalid permissions for the requested operation
UDA <udaName> is not associated with the given infrastructure.
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
/v1/{orgName}/v6pool/{poolInfo}:
delete:
tags:
- V6 Pool
summary: deleteV6Pool
description: Delete V6 Pool. You can delete V6 Pool by pool name (FQDN) or UUID
operationId: deleteV6Pool
parameters:
- name: Authentication
in: header
description: >-
Token tokenValue
or
Basic username:password
or
Leave blank if using Client Certificate Authentication
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: application/json
- name: orgName
in: path
description: Organization Name
required: true
style: simple
schema:
type: string
- name: poolInfo
in: path
description: poolInfo can be poolName or UUID
required: true
style: simple
schema:
type: string
- name: poolPath
in: query
description: >-
Name of parent pool or Hierarchical path to the parent pool if parent pool name is not unique enough.
If poolInfo is uuid, we don't need this parameter
style: form
explode: true
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'400':
description: 'Required Field(s) Missing: [pool]'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'404':
description: 'Pool not found: [poolInfo = <poolInfo>, parent= <parent>]'
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
'409':
description: >-
There is more than one address pool named <pool>. Parent pool name is required.
Unable to delete V6 Pool - <pool> containing child pools or blocks
Pool cannot be deleted
headers: {}
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
xml:
name: response
attribute: false
wrapped: false
deprecated: false
components:
schemas:
QIPUser:
title: QIPUser
required:
- username
- password
type: object
properties:
username:
type: string
xml:
name: username
attribute: false
wrapped: false
password:
type: string
xml:
name: password
attribute: false
wrapped: false
expires:
type: integer
format: int32
xml:
name: expires
attribute: false
wrapped: false
description: QIPUser model
xml:
name: QIPUser
attribute: false
wrapped: false
NextV4AddrRec:
title: NextV4AddrRec
type: object
properties:
objectAddr:
type: string
xml:
name: objectAddr
attribute: false
wrapped: false
description: NextV4AddrRec model
xml:
name: NextV4AddrRec
attribute: false
wrapped: false
V6GetIpAddressRec:
title: V6GetIpAddressRec
type: object
properties:
ipV6AddrStr:
type: string
xml:
name: ipV6AddrStr
attribute: false
wrapped: false
description: V6GetIpAddressRec model
xml:
name: V6GetIpAddressRec
attribute: false
wrapped: false
RRDeleteInfo:
title: RRDeleteInfo
required:
- owner
- rrType
- infraType
- singleDelete
type: object
properties:
owner:
type: string
description: Owner name for the resource record.
xml:
name: owner
attribute: false
wrapped: false
classType:
type: string
description: Class type of records pertains to a type of network or software.
xml:
name: classType
attribute: false
wrapped: false
rrType:
type: string
description: Type of resource record.
xml:
name: rrType
attribute: false
wrapped: false
data1:
type: string
description: The data associated with the specific resource record type.
xml:
name: data1
attribute: false
wrapped: false
publishing:
type: string
description: Publishing type.
xml:
name: publishing
attribute: false
wrapped: false
ttl:
type: string
description: The length of time (in seconds) the name server will hold this information. If no TTL is defined, the value is inherited from the zone.
xml:
name: ttl
attribute: false
wrapped: false
infraType:
type: string
description: 'Type of infrastructure: OBJECT|V6ADDRESS|ZONE|V4REVERSEZONE|V6REVERSEZONE'
xml:
name: infraType
attribute: false
wrapped: false
infraFQDN:
type: string
description: Infrastrucutre FQDN.
xml:
name: infraFQDN
attribute: false
wrapped: false
data2:
type: string
description: The data associated with the specific resource record type.
xml:
name: data2
attribute: false
wrapped: false
data3:
type: string
description: The data associated with the specific resource record type.
xml:
name: data3
attribute: false
wrapped: false
data4:
type: string
description: The data associated with the specific resource record type.
xml:
name: data4
attribute: false
wrapped: false
infraAddr:
type: string
description: Address of infrastructure.
xml:
name: infraAddr
attribute: false
wrapped: false
isCreatingReverseZoneRR:
type: boolean
description: When creating or updating PTR resource record in Object/Node level, if this property is set to true, the PTR resource record will be created in Reverse zone. Otherwise, resource record will be created in Object as normally. Default value of this property is false. This property will be hidden when users get resource record.
xml:
name: isCreatingReverseZoneRR
attribute: false
wrapped: false
singleDelete:
type: boolean
description: RR model
xml:
name: RRDeleteInfo
attribute: false
wrapped: false
UpdateRRRec:
title: UpdateRRRec
required:
- oldRRRec
- updatedRRRec
type: object
properties:
oldRRRec:
allOf:
- $ref: '#/components/schemas/RRRec'
- description: RR model
xml:
name: RRRec
attribute: false
wrapped: false
updatedRRRec:
allOf:
- $ref: '#/components/schemas/RRRec'
- description: RR model
xml:
name: RRRec
attribute: false
wrapped: false
description: RR model
RRRec:
title: RRRec
required:
- owner
- rrType
- infraType
type: object
properties:
owner:
type: string
description: Owner name for the resource record.
xml:
name: owner
attribute: false
wrapped: false
classType:
type: string
description: Class type of records pertains to a type of network or software.
xml:
name: classType
attribute: false
wrapped: false
rrType:
type: string
description: Type of resource record.
xml:
name: rrType
attribute: false
wrapped: false
data1:
type: string
description: The data associated with the specific resource record type.
xml:
name: data1
attribute: false
wrapped: false
publishing:
type: string
description: Publishing type.
xml:
name: publishing
attribute: false
wrapped: false
ttl:
type: string
description: The length of time (in seconds) the name server will hold this information. If no TTL is defined, the value is inherited from the zone.
xml:
name: ttl
attribute: false
wrapped: false
infraType:
type: string
description: 'Type of infrastructure: OBJECT|V6ADDRESS|ZONE|V4REVERSEZONE|V6REVERSEZONE'
xml:
name: infraType
attribute: false
wrapped: false
infraFQDN:
type: string
description: Infrastrucutre FQDN.
xml:
name: infraFQDN
attribute: false
wrapped: false
data2:
type: string
description: The data associated with the specific resource record type.
xml:
name: data2
attribute: false
wrapped: false
data3:
type: string
description: The data associated with the specific resource record type.
xml:
name: data3
attribute: false
wrapped: false
data4:
type: string
description: The data associated with the specific resource record type.
xml:
name: data4
attribute: false
wrapped: false
infraAddr:
type: string
description: Address of infrastructure.
xml:
name: infraAddr
attribute: false
wrapped: false
isCreatingReverseZoneRR:
type: boolean
description: When creating or updating PTR resource record in Object/Node level, if this property is set to true, the PTR resource record will be created in Reverse zone. Otherwise, resource record will be created in Object as normally. Default value of this property is false. This property will be hidden when users get resource record.
xml:
name: isCreatingReverseZoneRR
attribute: false
wrapped: false
description: RR model
xml:
name: RRRec
attribute: false
wrapped: false
V4NetworkRec:
title: V4NetworkRec
required:
- address
- maskLength
- email
- warningPercent
- warningType
type: object
properties:
address:
type: string
description: V4 Network address
xml:
name: address
attribute: false
wrapped: false
maskLength:
type: integer
description: Mask length of v4 network
format: int32
xml:
name: maskLength
attribute: false
wrapped: false
email:
type: string
description: email to contact
xml:
name: email
attribute: false
wrapped: false
warningPercent:
type: integer
description: Warning percent
format: int32
xml:
name: warningPercent
attribute: false
wrapped: false
warningType:
type: string
description: warnning type (1 or 2 or 3)
xml:
name: warningType
attribute: false
wrapped: false
name:
type: string
description: Network name
xml:
name: name
attribute: false
wrapped: false
dnsServer:
type: string
description: Name of DNS Server
xml:
name: dnsServer
attribute: false
wrapped: false
cidr:
type: string
description: CIDR (Y or N)
xml:
name: cidr
attribute: false
wrapped: false
optionalAttributeList:
$ref: '#/components/schemas/UdaList'
optionalAddrRangeList:
$ref: '#/components/schemas/AddrRangeList'
description: V4 Network model
xml:
name: V4NetworkRec
attribute: false
wrapped: false
UdaList:
title: UdaList
type: object
properties:
udas:
type: array
items:
$ref: '#/components/schemas/NameValue'
description: ''
xml:
attribute: false
wrapped: false
groups:
type: array
items:
$ref: '#/components/schemas/UdaGroup'
description: ''
xml:
attribute: false
wrapped: false
UdaGroup:
title: UdaGroup
type: object
properties:
name:
type: string
udas:
type: array
items:
$ref: '#/components/schemas/NameValue'
description: ''
xml:
attribute: false
wrapped: false
NameValue:
title: NameValue
required:
- name
- value
type: object
properties:
name:
type: string
xml:
name: name
attribute: false
wrapped: false
value:
type: string
xml:
name: value
attribute: false
wrapped: false
AddrRangeList:
title: AddrRangeList
type: object
properties:
addrRange:
type: array
items:
$ref: '#/components/schemas/AddrRange'
description: ''
xml:
attribute: false
wrapped: false
AddrRange:
title: AddrRange
type: object
properties:
startAddress:
type: string
xml:
name: startAddress
attribute: false
wrapped: false
endAddress:
type: string
xml:
name: endAddress
attribute: false
wrapped: false
V6SubnetRec:
title: V6SubnetRec
required:
- name
- address
- prefixLength
- type
- rangePrefixLength
type: object
properties:
name:
type: string
xml:
name: name
attribute: false
wrapped: false
address:
type: string
xml:
name: address
attribute: false
wrapped: false
prefixLength:
type: integer
format: int32
xml:
name: prefixLength
attribute: false
wrapped: false
domain:
$ref: '#/components/schemas/StringList'
type:
allOf:
- $ref: '#/components/schemas/V6SubnetType'
- xml:
name: V6SubnetType
attribute: false
wrapped: false
poolName:
type: string
xml:
name: poolName
attribute: false
wrapped: false
blockName:
type: string
xml:
name: blockName
attribute: false
wrapped: false
standPrimDHCPServer:
type: string
xml:
name: standPrimDHCPServer
attribute: false
wrapped: false
failoverSecondDHCPServer:
type: string
xml:
name: failoverSecondDHCPServer
attribute: false
wrapped: false
optTemplate:
type: string
xml:
name: optTemplate
attribute: false
wrapped: false
algorithmType:
allOf:
- $ref: '#/components/schemas/V6DefaultAlgorithmType'
- description: depend on using Algorithm value for createSubnet
xml:
name: V6DefaultAlgorithmType
attribute: false
wrapped: false
rangePrefixLength:
type: integer
format: int32
xml:
name: rangePrefixLength
attribute: false
wrapped: false
addressSelection:
$ref: '#/components/schemas/V6AddressSelectionType'
dhcpParams:
$ref: '#/components/schemas/V6DhcpOptionsRec'
description: V6 Subnet model
StringList:
title: StringList
type: object
properties:
name:
type: array
items:
type: string
description: ''
V6SubnetType:
title: V6SubnetType
enum:
- STATEFULL
- STATELESS
type: string
xml:
name: V6SubnetType
attribute: false
wrapped: false
V6DefaultAlgorithmType:
title: V6DefaultAlgorithmType
enum:
- BEST_FIT_FROM_START
- BEST_FIT_FROM_END
- CONTIGUOUS_SPARSE
- SPARSE
type: string
description: depend on using Algorithm value for createSubnet
xml:
name: V6DefaultAlgorithmType
attribute: false
wrapped: false
V6AddressSelectionType:
title: V6AddressSelectionType
enum:
- NEXT_AVAILABLE
- RANDOM
type: string
example: NEXT_AVAILABLE
V6DhcpOptionsRec:
title: V6DhcpOptionsRec
type: object
properties:
informationRefreshTime:
type: string
xml:
name: informationRefreshTime
attribute: false
wrapped: false
preferredLifeTime:
type: string
xml:
name: preferredLifeTime
attribute: false
wrapped: false
rebindingTime:
type: string
xml:
name: rebindingTime
attribute: false
wrapped: false
renewalTime:
type: string
xml:
name: renewalTime
attribute: false
wrapped: false
validLifeTime:
type: string
xml:
name: validLifeTime
attribute: false
wrapped: false
bcmcsServerAddressList:
type: string
xml:
name: bcmcsServerAddressList
attribute: false
wrapped: false
bcmcsServerDomainNameList:
type: string
xml:
name: bcmcsServerDomainNameList
attribute: false
wrapped: false
dnsRecursiveNameServer:
type: string
xml:
name: dnsRecursiveNameServer
attribute: false
wrapped: false
domainSearchList:
type: string
xml:
name: domainSearchList
attribute: false
wrapped: false
nisServers:
type: string
xml:
name: nisServers
attribute: false
wrapped: false
nispDomainName:
type: string
xml:
name: nispDomainName
attribute: false
wrapped: false
panaAuthenticationAgents:
type: string
xml:
name: panaAuthenticationAgents
attribute: false
wrapped: false
posixTimeZone:
type: string
xml:
name: posixTimeZone
attribute: false
wrapped: false
sipServersDomainNameList:
type: string
xml:
name: sipServersDomainNameList
attribute: false
wrapped: false
sipServersIpv6AddressList:
type: string
xml:
name: sipServersIpv6AddressList
attribute: false
wrapped: false
sntpServers:
type: string
xml:
name: sntpServers
attribute: false
wrapped: false
tzdbTimeZone:
type: string
xml:
name: tzdbTimeZone
attribute: false
wrapped: false
vendorOptions:
type: string
xml:
name: vendorOptions
attribute: false
wrapped: false
V6CreateSubnetRec:
title: V6CreateSubnetRec
required:
- poolName
- blockName
- blockAddress
- prefixLength
- subnetPrefixLength
- createSubnet
- algorithmType
- createReverseZone
type: object
properties:
poolName:
type: string
xml:
name: poolName
attribute: false
wrapped: false
blockName:
type: string
xml:
name: blockName
attribute: false
wrapped: false
blockAddress:
type: string
xml:
name: blockAddress
attribute: false
wrapped: false
prefixLength:
type: integer
format: int32
xml:
name: prefixLength
attribute: false
wrapped: false
subnetPrefixLength:
type: integer
format: int32
xml:
name: subnetPrefixLength
attribute: false
wrapped: false
subnetName:
type: string
description: depend on using Specific value for createSubnet
xml:
name: subnetName
attribute: false
wrapped: false
subnetAddress:
type: string
description: depend on using Specific value for createSubnet
xml:
name: subnetAddress
attribute: false
wrapped: false
subnetsNo:
type: integer
description: depend on using Algorithm value for createSubnet. That is the number of subnet will be created by 1 request
format: int32
xml:
name: subnetsNo
attribute: false
wrapped: false
createSubnet:
allOf:
- $ref: '#/components/schemas/V6CreateSubnetType'
- xml:
name: V6CreateSubnetType
attribute: false
wrapped: false
algorithmType:
allOf:
- $ref: '#/components/schemas/V6DefaultAlgorithmType'
- description: depend on using Algorithm value for createSubnet
xml:
name: V6DefaultAlgorithmType
attribute: false
wrapped: false
createReverseZone:
allOf:
- $ref: '#/components/schemas/V6CreateReverseZone'
- xml:
name: V6CreateReverseZone
attribute: false
wrapped: false
domains:
$ref: '#/components/schemas/StringList'
V6CreateSubnetType:
title: V6CreateSubnetType
enum:
- ALGORITHM
- SPECIFIC
type: string
xml:
name: V6CreateSubnetType
attribute: false
wrapped: false
V6CreateReverseZone:
title: V6CreateReverseZone
enum:
- 'TRUE'
- 'FALSE'
type: string
xml:
name: V6CreateReverseZone
attribute: false
wrapped: false
V6AddressRec:
title: V6AddressRec
required:
- hostName
- domainName
- rangeAddress
- address
- addressType
- range
- publishA
- publishPTR
- classType
type: object
properties:
hostName:
type: string
xml:
name: hostName
attribute: false
wrapped: false
domainName:
type: string
xml:
name: domainName
attribute: false
wrapped: false
fqdn:
type: string
xml:
name: fqdn
attribute: false
wrapped: false
rangeAddress:
type: string
xml:
name: rangeAddress
attribute: false
wrapped: false
address:
type: string
xml:
name: address
attribute: false
wrapped: false
newAddress:
type: string
xml:
name: newAddress
attribute: false
wrapped: false
iaid:
type: string
xml:
name: iaid
attribute: false
wrapped: false
addressType:
$ref: '#/components/schemas/V6AddressType'
range:
type: string
xml:
name: range
attribute: false
wrapped: false
subnet:
type: string
xml:
name: subnet
attribute: false
wrapped: false
publishA:
$ref: '#/components/schemas/V6PublishType'
publishPTR:
$ref: '#/components/schemas/V6PublishType'
ttl:
type: integer
format: int32
xml:
name: ttl
attribute: false
wrapped: false
nodeName:
type: string
xml:
name: nodeName
attribute: false
wrapped: false
classType:
type: string
xml:
name: classType
attribute: false
wrapped: false
uniqueId:
type: string
xml:
name: uniqueId
attribute: false
wrapped: false
duid:
type: string
xml:
name: duid
attribute: false
wrapped: false
useMACAddress:
type: boolean
xml:
name: useMACAddress
attribute: false
wrapped: false
macAddress:
type: string
xml:
name: macAddress
attribute: false
wrapped: false
V6AddressType:
title: V6AddressType
enum:
- STATIC
- MANUAL
type: string
example: STATIC
V6PublishType:
title: V6PublishType
enum:
- ALWAYS
- NEVER
- PUSH_ONLY
- EXTERNAL
type: string
example: ALWAYS
V6RangeRec:
title: V6RangeRec
required:
- name
- rangePrefixLength
- rangeType
- addressSelection
- subnetAddress
- subnetPrefixLength
type: object
properties:
name:
type: string
xml:
name: name
attribute: false
wrapped: false
startAddress:
type: string
xml:
name: startAddress
attribute: false
wrapped: false
newStartAddress:
type: string
xml:
name: newStartAddress
attribute: false
wrapped: false
rangePrefixLength:
type: integer
format: int32
xml:
name: rangePrefixLength
attribute: false
wrapped: false
rangeType:
$ref: '#/components/schemas/V6RangeType'
standPrimDHCPServer:
type: string
xml:
name: standPrimDHCPServer
attribute: false
wrapped: false
failoverSecondDHCPServer:
type: string
xml:
name: failoverSecondDHCPServer
attribute: false
wrapped: false
optTemplate:
type: string
xml:
name: optTemplate
attribute: false
wrapped: false
addressSelection:
$ref: '#/components/schemas/V6AddressSelectionType'
subnetName:
type: string
xml:
name: subnetName
attribute: false
wrapped: false
subnetAddress:
type: string
xml:
name: subnetAddress
attribute: false
wrapped: false
subnetPrefixLength:
type: integer
format: int32
xml:
name: subnetPrefixLength
attribute: false
wrapped: false
dhcpParams:
$ref: '#/components/schemas/V6DhcpOptionsRec'
udas:
type: array
items:
$ref: '#/components/schemas/NameValue'
description: ''
xml:
attribute: false
wrapped: false
groups:
type: array
items:
$ref: '#/components/schemas/UdaGroup'
description: ''
xml:
attribute: false
wrapped: false
V6RangeType:
title: V6RangeType
enum:
- DYNAMIC
- FIXED
- RESERVED
- DYNAMIC_TEMPORARY
type: string
example: DYNAMIC
V4AddrRec:
title: V4AddrRec
required:
- objectAddr
- subnetAddr
type: object
properties:
objectAddr:
type: string
description: The hostname of the object. Not fully-qualified.
xml:
name: objectAddr
attribute: false
wrapped: false
subnetAddr:
type: string
xml:
name: subnetAddr
attribute: false
wrapped: false
objectName:
type: string
xml:
name: objectName
attribute: false
wrapped: false
objectClass:
type: string
description: ObjectClass is a value of Workstation, X-terminal, PC, Printer, Server, Wiring_HUB, Router, Bridge, Terminal_Server, Switch, Legacy_System, Gateway, Test_Equipment, Undefined, Others, Any user-defined object class name.
xml:
name: objectClass
attribute: false
wrapped: false
domainName:
type: string
description: The domain of the object. If no value is provided, the Domain Name is identified as the default domain of the subnet the Object is on.
xml:
name: domainName
attribute: false
wrapped: false
expiredDate:
type: string
description: The date when a reserved object expires and is no longer reserved.
xml:
name: expiredDate
attribute: false
wrapped: false
serverType:
type: string
description: "Only applicable if ObjectClass is 'server': TimeServer- If object is a time server, TftpServer- If object is a Tftp server, TftpServer\\&TimeServer- If object is a TftpServer and TimeServer."
xml:
name: serverType
attribute: false
wrapped: false
applName:
type: string
description: The 'Primary Application' of the object.
xml:
name: applName
attribute: false
wrapped: false
objectTag:
type: string
description: Tag field
xml:
name: objectTag
attribute: false
wrapped: false
roomId:
type: string
description: Room ID field
xml:
name: roomId
attribute: false
wrapped: false
manufacturer:
type: string
description: Manufacturer Name
xml:
name: manufacturer
attribute: false
wrapped: false
modelType:
type: string
description: Model Name
xml:
name: modelType
attribute: false
wrapped: false
serialNumber:
type: string
description: Serial Number of Object
xml:
name: serialNumber
attribute: false
wrapped: false
assetNumber:
type: string
description: Asset Number of object
xml:
name: assetNumber
attribute: false
wrapped: false
hostId:
type: string
description: Host ID of object
xml:
name: hostId
attribute: false
wrapped: false
purchaseDate:
type: string
description: Purchase Date/Time of object. Must be in yyyy-mm-dd format
xml:
name: purchaseDate
attribute: false
wrapped: false
objectDesc:
type: string
description: Object Description
xml:
name: objectDesc
attribute: false
wrapped: false
hubName:
type: string
description: Hub Name(s) assigned to object.
xml:
name: hubName
attribute: false
wrapped: false
slotName:
type: string
description: Slot Name(s) assigned to object.
xml:
name: slotName
attribute: false
wrapped: false
portNumber:
type: string
description: Port Numbers assigned to object.
xml:
name: portNumber
attribute: false
wrapped: false
locationId:
type: string
description: The Location ID. If no Location ID is specified, an attempt is made to match the record EXACTLY with the Street1, Street2, City, State, Zip and/or Country information that is supplied. If a match is not found, a new record is added without an ID.
xml:
name: locationId
attribute: false
wrapped: false
street1:
type: string
description: Street1 field of the location.
xml:
name: street1
attribute: false
wrapped: false
street2:
type: string
description: Street2 field of the location.
xml:
name: street2
attribute: false
wrapped: false
city:
type: string
description: City of the location.
xml:
name: city
attribute: false
wrapped: false
state:
type: string
description: State of the location.
xml:
name: state
attribute: false
wrapped: false
zip:
type: string
description: Zip of the location.
xml:
name: zip
attribute: false
wrapped: false
country:
type: string
description: Country of the location.
xml:
name: country
attribute: false
wrapped: false
contactId:
type: string
description: The Contact ID. If no Contact ID is specified, an attempt is made to match the record EXACTLY with the ContactLastName and ContactFirstName information that is supplied. If no match is found, a new record is added without an ID.
xml:
name: contactId
attribute: false
wrapped: false
contactLastName:
type: string
description: Contact last name.
xml:
name: contactLastName
attribute: false
wrapped: false
contactFirstName:
type: string
description: Contact first name.
xml:
name: contactFirstName
attribute: false
wrapped: false
contactEmail:
type: string
description: Contact email address.
xml:
name: contactEmail
attribute: false
wrapped: false
contactPhone:
type: string
description: Contact phone number.
xml:
name: contactPhone
attribute: false
wrapped: false
contactPager:
type: string
description: Contact pager number.
xml:
name: contactPager
attribute: false
wrapped: false
routerGroup:
type: string
description: Router Group of object. Only applicable if the object class is "router".
xml:
name: routerGroup
attribute: false
wrapped: false
dynamicConfig:
type: string
description: Dynamic Configuration of Object include Blank - Static object, None- Dynamic (none), M-DHCP- Manual DHCP, A-DHCP- Automatic DHCP, D-DHCP- Dynamic DHCP, M-BOOTP- Manual Bootp, A-BOOTP- Automatic Bootp, Reserved - To reserve an object (the IP must be unused)
xml:
name: dynamicConfig
attribute: false
wrapped: false
macAddr:
type: string
description: The Mac Address of Object. Exclude the colons (:) when entering a MAC address.
xml:
name: macAddr
attribute: false
wrapped: false
tftpServer:
type: string
description: TFTP Server of object. Only applicable if object type is M-BOOTP.
xml:
name: tftpServer
attribute: false
wrapped: false
bootFileName:
type: string
description: Bootfile name of object. Only applicable if object type is MBOOTP.
xml:
name: bootFileName
attribute: false
wrapped: false
hardwareType:
type: string
description: NONE, ETHERNET, TOKEN_RING, AX25, PRONET, CHAOS, IEEE802, ARCNET.
xml:
name: hardwareType
attribute: false
wrapped: false
aliases:
type: string
xml:
name: aliases
attribute: false
wrapped: false
mailForwarders:
type: string
xml:
name: mailForwarders
attribute: false
wrapped: false
mailHosts:
type: string
xml:
name: mailHosts
attribute: false
wrapped: false
hubSlots:
type: string
xml:
name: hubSlots
attribute: false
wrapped: false
dnsServers:
type: string
description: DNS Servers attached to this object. If multiple, separate by space. Only applicable for M-BOOTP objects.
xml:
name: dnsServers
attribute: false
wrapped: false
timeServers:
type: string
description: Time Servers attached to this object. If multiple, separate by space. Only applicable for M-BOOTP objects.
xml:
name: timeServers
attribute: false
wrapped: false
defaultRouters:
type: string
description: IP Address(es) of Default routers, separated by space if multiples.
xml:
name: defaultRouters
attribute: false
wrapped: false
userClasses:
type: string
description: Specific categories of user options. To enter one or more user classes for this object, enclose a list of users in double quotes (for example, user1, user2, user3).
xml:
name: userClasses
attribute: false
wrapped: false
users:
type: string
xml:
name: users
attribute: false
wrapped: false
nameService:
type: string
description: >-
Name Services selection:
- No: Name Services checked off.
- Yes: Name Services checked on.
- A: Name Services checked on, A record checked on.
- PTR: Name Services checked on, PTR record checked on.
- A PTR: Name Services checked on, A record checked on, PTR record checked on.
xml:
name: nameService
attribute: false
wrapped: false
dynamicDnsUpdate:
type: string
description: >-
Dynamic Update selection:
- A- Dynamic updates for A records.
- PTR- Dynamic updates for PTR records.
- CNAME- Dynamic updates for CNAME records.
- MX- Dynamic updates for MX records.
xml:
name: dynamicDnsUpdate
attribute: false
wrapped: false
dhcpServer:
type: string
description: The DHCP Server assigned to this object. Only applicable for dynamic objects.
xml:
name: dhcpServer
attribute: false
wrapped: false
dhcpOptionTemplate:
type: string
description: The DHCP Option Template assigned to this object. Only applicable for dynamic objects.
xml:
name: dhcpOptionTemplate
attribute: false
wrapped: false
dhcpPolicyTemplate:
type: string
description: The DHCP Policy template assigned to this object. Only applicable for dynamic objects.
xml:
name: dhcpPolicyTemplate
attribute: false
wrapped: false
leaseTime:
type: string
description: The lease time (in seconds assigned) to this object. Only applicable for dynamic objects.
xml:
name: leaseTime
attribute: false
wrapped: false
ttlTime:
type: string
description: Time to live (TTL) value, in seconds. Since 0 is a valid value, a value of-1 indicates no TTL set.
xml:
name: ttlTime
attribute: false
wrapped: false
vendorClass:
type: string
description: The Vendor Class assigned to this object. Only applicable for dynamic objects.
xml:
name: vendorClass
attribute: false
wrapped: false
clientId:
type: string
description: The unique value assigned to DHCP client.
xml:
name: clientId
attribute: false
wrapped: false
dualProtocol:
type: string
xml:
name: dualProtocol
attribute: false
wrapped: false
decNetArea:
type: string
description: DECNet Area. (Valid values are 1-63) Only applicable if Dual Protocol is set to DECNet. The DECNet Address is calculated on the input in the DECNetArea and the DECNet Node.
xml:
name: decNetArea
attribute: false
wrapped: false
decNetAddr:
type: string
description: DECNet Address. (Valid values are 1-1024) Only applicable if Dual Protocol set to DECNet. The DECNet Address is calculated on the input in the DECNetArea and the DECNet Node.
xml:
name: decNetAddr
attribute: false
wrapped: false
decNetNode:
type: string
xml:
name: decNetNode
attribute: false
wrapped: false
talkType:
type: string
xml:
name: talkType
attribute: false
wrapped: false
ipxNode:
type: string
description: IPX Node. Only applicable if Dual Protocol is set to IPX.
xml:
name: ipxNode
attribute: false
wrapped: false
ipxNetworkNumber:
type: string
description: IPX Network number. Only applicable if Dual Protocol is set to IPX.
xml:
name: ipxNetworkNumber
attribute: false
wrapped: false
netBiosDomain:
type: string
description: NetBIOS Name. Only applicable when dual protocol is set to NETBIOS.
xml:
name: netBiosDomain
attribute: false
wrapped: false
netBiosName:
type: string
description: NetBIOS Domain. Only applicable when dual protocol set to NETBIOS.
xml:
name: netBiosName
attribute: false
wrapped: false
usageBillServices:
type: string
xml:
name: usageBillServices
attribute: false
wrapped: false
usageBillLocation:
type: string
xml:
name: usageBillLocation
attribute: false
wrapped: false
usageBillUserGroup:
type: string
xml:
name: usageBillUserGroup
attribute: false
wrapped: false
usageBillObjectClass:
type: string
xml:
name: usageBillObjectClass
attribute: false
wrapped: false
allowModifyDynamicRRs:
type: string
xml:
name: allowModifyDynamicRRs
attribute: false
wrapped: false
tombstoned:
type: string
description: 1 indicates that this is a tombstoned external record. 0 indicates that it is not a tombstoned external record.
xml:
name: tombstoned
attribute: false
wrapped: false
externalComment:
type: string
description: text (up to 255 characters), a comment indicating the history of this external add.
xml:
name: externalComment
attribute: false
wrapped: false
externalTimestamp:
type: string
description: ExternalTimestamp must be in "yyyy-mm-dd" format
xml:
name: externalTimestamp
attribute: false
wrapped: false
manualFlag:
type: string
description: Determines whether MACAddress/ClientID is set based on its value. If value is 0, MACAddress is set, if value is 1, ClientID is set.
xml:
name: manualFlag
attribute: false
wrapped: false
nodeId:
type: string
xml:
name: nodeId
attribute: false
wrapped: false
uniqueNodeId:
type: string
xml:
name: uniqueNodeId
attribute: false
wrapped: false
aTTL:
type: string
xml:
name: aTTL
attribute: false
wrapped: false
ptrTTL:
type: string
xml:
name: ptrTTL
attribute: false
wrapped: false
publishA:
type: string
description: A resource record option (Always | None | Push Only).
xml:
name: publishA
attribute: false
wrapped: false
publishPTR:
type: string
description: PTR resource record option (Always | None | Push Only).
xml:
name: publishPTR
attribute: false
wrapped: false
dhcpClientClass:
type: string
xml:
name: dhcpClientClass
attribute: false
wrapped: false
isUpdate:
type: string
xml:
name: isUpdate
attribute: false
wrapped: false
isAddSelected:
type: string
xml:
name: isAddSelected
attribute: false
wrapped: false
isCheckDupName:
type: string
xml:
name: isCheckDupName
attribute: false
wrapped: false
isCheckOnlyFQDNDups:
type: string
xml:
name: isCheckOnlyFQDNDups
attribute: false
wrapped: false
isSwapAliasAndObjectName:
type: string
xml:
name: isSwapAliasAndObjectName
attribute: false
wrapped: false
localManualFlag:
type: string
xml:
name: localManualFlag
attribute: false
wrapped: false
V4SubnetRec:
title: V4SubnetRec
required:
- subnetAddress
- subnetMask
- networkAddress
type: object
properties:
subnetAddress:
type: string
xml:
name: subnetAddress
attribute: false
wrapped: false
subnetMask:
type: string
xml:
name: subnetMask
attribute: false
wrapped: false
networkAddress:
type: string
xml:
name: networkAddress
attribute: false
wrapped: false
subnetName:
type: string
xml:
name: subnetName
attribute: false
wrapped: false
subnetOrg:
type: string
xml:
name: subnetOrg
attribute: false
wrapped: false
application:
type: string
xml:
name: application
attribute: false
wrapped: false
location:
$ref: '#/components/schemas/LocationRec'
contact:
$ref: '#/components/schemas/ContactRec'
hardwareType:
$ref: '#/components/schemas/HwType'
tftpServerName:
type: string
xml:
name: tftpServerName
attribute: false
wrapped: false
allowDHCPClientsToModifyDynamicObjectRRs:
$ref: '#/components/schemas/ModifyRrsType'
domains:
$ref: '#/components/schemas/StringList'
showUsage:
type: string
xml:
name: showUsage
attribute: false
wrapped: false
checkUsage:
type: string
xml:
name: checkUsage
attribute: false
wrapped: false
subnetDescription:
type: string
xml:
name: subnetDescription
attribute: false
wrapped: false
sharedNetwork:
type: string
xml:
name: sharedNetwork
attribute: false
wrapped: false
warningType:
type: integer
format: int32
xml:
name: warningType
attribute: false
wrapped: false
warningPercentage:
type: integer
format: int32
xml:
name: warningPercentage
attribute: false
wrapped: false
preferredDNSServers:
$ref: '#/components/schemas/StringList'
preferredTimeServers:
$ref: '#/components/schemas/StringList'
defaultRouters:
$ref: '#/components/schemas/StringList'
defaultDHCPServer:
type: string
xml:
name: defaultDHCPServer
attribute: false
wrapped: false
defaultDHCPOptionTemplate:
type: string
xml:
name: defaultDHCPOptionTemplate
attribute: false
wrapped: false
defaultDHCPPolicyTemplate:
type: string
xml:
name: defaultDHCPPolicyTemplate
attribute: false
wrapped: false
primaryInterface:
type: boolean
xml:
name: primaryInterface
attribute: false
wrapped: false
optionalAttributeList:
$ref: '#/components/schemas/UdaList'
addressTemplate:
type: string
xml:
name: addressTemplate
attribute: false
wrapped: false
localTotalDynamicObjects:
type: integer
format: int32
xml:
name: localTotalDynamicObjects
attribute: false
wrapped: false
localLeasedDynamicObjects:
type: integer
format: int32
xml:
name: localLeasedDynamicObjects
attribute: false
wrapped: false
localPercentDynamicObjectsUsed:
type: number
xml:
name: localPercentDynamicObjectsUsed
attribute: false
wrapped: false
ModifyRrsType:
title: ModifyRrsType
enum:
- SAME_AS_IN_GLOBAL_POLICIES
- YES
- NO
type: string
example: SAME_AS_IN_GLOBAL_POLICIES
HwType:
title: HwType
enum:
- ETHERNET
- TOKEN_RING
- AX25
- PRONET
- CHAOS
- IEEE802
- ARCNET
type: string
example: ETHERNET
LocationRec:
title: LocationRec
type: object
properties:
id:
type: integer
format: int32
xml:
name: id
attribute: false
wrapped: false
street1:
type: string
xml:
name: street1
attribute: false
wrapped: false
street2:
type: string
xml:
name: street2
attribute: false
wrapped: false
city:
type: string
xml:
name: city
attribute: false
wrapped: false
state:
type: string
xml:
name: state
attribute: false
wrapped: false
zip:
type: string
xml:
name: zip
attribute: false
wrapped: false
country:
type: string
xml:
name: country
attribute: false
wrapped: false
ContactRec:
title: ContactRec
type: object
properties:
id:
type: integer
format: int32
xml:
name: id
attribute: false
wrapped: false
firstName:
type: string
xml:
name: firstName
attribute: false
wrapped: false
lastName:
type: string
xml:
name: lastName
attribute: false
wrapped: false
telephone:
type: string
xml:
name: telephone
attribute: false
wrapped: false
pager:
type: string
xml:
name: pager
attribute: false
wrapped: false
email:
type: string
xml:
name: email
attribute: false
wrapped: false
DNSServer:
title: DNSServer
required:
- name
type: object
properties:
name:
type: string
description: name
xml:
name: name
attribute: false
wrapped: false
role:
type: string
description: >-
Primary/Secondary DNS Server:
With P is for Primary and S is for Secondary
xml:
name: role
attribute: false
wrapped: false
secureUpdate:
type: boolean
description: 1 is turn on the flag of sending secure update 0 is not
xml:
name: secureUpdate
attribute: false
wrapped: false
description: Name of DNS server
DNSZoneSubOption:
title: DNSZoneSubOption
required:
- name
- value
type: object
properties:
name:
type: string
description: name
xml:
name: name
attribute: false
wrapped: false
value:
type: string
description: value
xml:
name: value
attribute: false
wrapped: false
DNSZoneOption:
title: DNSZoneOption
required:
- name
- value
type: object
properties:
name:
type: string
description: name
xml:
name: name
attribute: false
wrapped: false
value:
type: string
description: value
xml:
name: value
attribute: false
wrapped: false
subOption:
type: array
items:
$ref: '#/components/schemas/DNSZoneSubOption'
description: ''
xml:
attribute: false
wrapped: false
DNSZoneOptionGroups:
title: DNSZoneOptionGroups
required:
- name
type: object
properties:
name:
type: string
description: name
xml:
name: name
attribute: false
wrapped: false
option:
type: array
items:
$ref: '#/components/schemas/DNSZoneOption'
description: ''
xml:
attribute: false
wrapped: false
DNSZoneRec:
title: DNSZoneRec
required:
- name
- defaultTtl
- email
- expireTime
- negativeCacheTtl
- refreshTime
- retryTime
type: object
properties:
name:
type: string
description: Name of the zone.
xml:
name: name
attribute: false
wrapped: false
newName:
type: string
description: New name of the zone. This is used for updating a new name for a zone.
xml:
name: newName
attribute: false
wrapped: false
parentAddress:
type: string
description: Parent address of the splitted reverse zone.
xml:
name: parentAddress
attribute: false
wrapped: false
networkAddress:
type: string
description: Network address of the reverse zone.
xml:
name: networkAddress
attribute: false
wrapped: false
dnsServers:
type: array
items:
$ref: '#/components/schemas/DNSServer'
description: ''
xml:
attribute: false
wrapped: false
defaultTtl:
type: integer
description: DNS default TTL.
format: int32
xml:
name: defaultTtl
attribute: false
wrapped: false
email:
type: string
description: Email contact.
xml:
name: email
attribute: false
wrapped: false
expireTime:
type: integer
description: Email contact.
format: int32
xml:
name: expireTime
attribute: false
wrapped: false
negativeCacheTtl:
type: integer
description: DNS negative cache TTL.
format: int32
xml:
name: negativeCacheTtl
attribute: false
wrapped: false
postfixZoneExtension:
type: string
description: DNS postfix extension.
xml:
name: postfixZoneExtension
attribute: false
wrapped: false
prefixZoneExtension:
type: string
description: DNS prefix extention.
xml:
name: prefixZoneExtension
attribute: false
wrapped: false
refreshTime:
type: integer
description: DNS refresh time.
format: int32
xml:
name: refreshTime
attribute: false
wrapped: false
retryTime:
type: integer
description: DNS retry time.
format: int32
xml:
name: retryTime
attribute: false
wrapped: false
udas:
$ref: '#/components/schemas/NameValue'
groups:
$ref: '#/components/schemas/UdaGroup'
dnsZoneOptions:
type: array
items:
$ref: '#/components/schemas/DNSZoneOptionGroups'
description: ''
xml:
attribute: false
wrapped: false
description: "This section defines a group of operations for adding a global zone. Different messages, \nand capabilities, are provided to handle the adding. Add, Get and Update actions support \nare supported."
V6BlockRec:
title: V6BlockRec
required:
- name
- address
- prefixLength
- minPrefix
- maxPrefix
- defaultPrefix
- algorithmType
- poolName
- createType
type: object
properties:
name:
type: string
description: Block
xml:
name: name
attribute: false
wrapped: false
address:
type: string
description: IPv6 address
xml:
name: address
attribute: false
wrapped: false
prefixLength:
type: integer
description: Length of the seed block
format: int32
xml:
name: prefixLength
attribute: false
wrapped: false
minPrefix:
type: integer
description: Smallest block that can be assigned
format: int32
xml:
name: minPrefix
attribute: false
wrapped: false
maxPrefix:
type: integer
description: Largest block that can be assigned
format: int32
xml:
name: maxPrefix
attribute: false
wrapped: false
defaultPrefix:
type: integer
description: Default size of the block assigned
format: int32
xml:
name: defaultPrefix
attribute: false
wrapped: false
algorithmType:
type: string
description: BEST_FIT_FROM_START | BEST_FIT_FROM_END | SPARSE | CONTIGUOUS_SPARSE
xml:
name: algorithmType
attribute: false
wrapped: false
poolName:
type: string
description: Name of the pool
xml:
name: poolName
attribute: false
wrapped: false
createType:
type: integer
description: Keep value as 1 which refers to user initiated operation. It's required when create a V6Block
format: int32
xml:
name: createType
attribute: false
wrapped: false
createReverseZone:
type: boolean
description: true for create V6 Reverse Zone and vice versa (default is true).
udas:
type: array
items:
$ref: '#/components/schemas/NameValue'
description: ''
xml:
attribute: false
wrapped: false
groups:
type: array
items:
$ref: '#/components/schemas/UdaGroup'
description: ''
xml:
attribute: false
wrapped: false
V6BlockAssign:
title: V6BlockAssign
required:
- targetPool
- sourcePool
- sourceBlock
- assignmentType
- assignAlgorithm
- prefixLength
- newBlockName
- defaultPrefixLength
- startAddress
type: object
properties:
targetPool:
type: string
description: Name of target pool.
xml:
name: targetPool
attribute: false
wrapped: false
sourcePool:
type: string
description: Name of source pool.
xml:
name: sourcePool
attribute: false
wrapped: false
sourceBlock:
type: string
description: Name of source block.
xml:
name: sourceBlock
attribute: false
wrapped: false
assignmentType:
type: string
description: Method of assignment.
xml:
name: assignmentType
attribute: false
wrapped: false
assignAlgorithm:
type: string
description: Assignment algorithm used in the block.
xml:
name: assignAlgorithm
attribute: false
wrapped: false
prefixLength:
type: integer
description: Size of the assigned block.
format: int32
xml:
name: prefixLength
attribute: false
wrapped: false
newBlockName:
type: string
description: Name of the block assigned.
xml:
name: newBlockName
attribute: false
wrapped: false
defaultAlgorithm:
type: string
description: Assignment algorithm.
xml:
name: defaultAlgorithm
attribute: false
wrapped: false
defaultPrefixLength:
type: integer
description: Size of the assigned block.
format: int32
xml:
name: defaultPrefixLength
attribute: false
wrapped: false
startAddress:
type: string
description: IP Address string.
xml:
name: startAddress
attribute: false
wrapped: false
createReverseZone:
type: boolean
description: true for create V6 Reverse Zone and vice versa (default is false).
V6PoolRec:
title: V6PoolRec
required:
- name
- contact
- assignBlockType
- notificationType
- algorithmType
- minPrefix
- maxPrefix
- defaultPrefix
type: object
properties:
name:
type: string
description: "Name of the pool.\nYou should not enter a pool name with the last character is \\ \n\nThis will make the parent pool name get parsed incorrectly."
xml:
name: name
attribute: false
wrapped: false
newName:
type: string
description: Name of the pool - support change name of pool.
xml:
name: newName
attribute: false
wrapped: false
fullQualifiedParentPoolName:
type: string
description: full Qualified Parent name of Pool
xml:
name: fullQualifiedParentPoolName
attribute: false
wrapped: false
parentName:
type: string
description: >-
Name of parent pool.
If you want the / character to be a part of the pool name, it must be escaped using slash \ character.
xml:
name: parentName
attribute: false
wrapped: false
contact:
type: string
description: E-mail ID of the contact
xml:
name: contact
attribute: false
wrapped: false
assignBlockType:
type: string
description: APPROVAL_REQUIRED AUTOMATIC_ASSIGNMENT
xml:
name: assignBlockType
attribute: false
wrapped: false
notificationType:
type: string
description: NONE REQUESTS_AND_ASSIGNMENTS REQUESTS_ONLY ASSIGNMENTS_ONLY
xml:
name: notificationType
attribute: false
wrapped: false
algorithmType:
type: string
description: BEST_FIT_FROM_START BEST_FIT_FROM_END SPARSE
xml:
name: algorithmType
attribute: false
wrapped: false
minPrefix:
type: integer
description: Smallest block that can be assigned
format: int32
xml:
name: minPrefix
attribute: false
wrapped: false
maxPrefix:
type: integer
description: Largest block that can be assigned
format: int32
xml:
name: maxPrefix
attribute: false
wrapped: false
defaultPrefix:
type: integer
description: Default size of the block assigned
format: int32
xml:
name: defaultPrefix
attribute: false
wrapped: false
blockReqType:
type: string
description: MANUAL_PARENT_REQUEST AUTOMATIC_PARENT_REQUEST
xml:
name: blockReqType
attribute: false
wrapped: false
createReverseZone:
type: boolean
description: true for create V6 Reverse Zone and vice versa (default is false).
xml:
name: createReverseZone
attribute: false
wrapped: false
udas:
type: array
items:
$ref: '#/components/schemas/NameValue'
description: ''
xml:
attribute: false
wrapped: false
groups:
type: array
items:
$ref: '#/components/schemas/UdaGroup'
description: ''
xml:
attribute: false
wrapped: false
AlertRec:
title: AlertRec
required:
- alertType
- alertContent
- severity
type: object
properties:
alertType:
type: string
description: >-
A alert type
DNS TUNNELS: messages about DNS TUNNELS attacks
DNS DDOS: messages about DNS DDOS attacks
DNS SUBDOMAIN DDOS: messages about DNS SubDomain DDoS attacks
DNS REFLECTION AND AMPLIFICATION: messages about DNS REFLECTION AND AMPLIFICATION attacks
xml:
name: alertType
attribute: false
wrapped: false
alertContent:
type: string
description: Alert Content
xml:
name: alertContent
attribute: false
wrapped: false
timestamp:
type: string
description: Time when we was attacked
xml:
name: timestamp
attribute: false
wrapped: false
severity:
type: string
description: >-
Severity type
CRITICAL: critical problem messages.
WARNING: warning problem messages.
INFO: information messages.
xml:
name: severity
attribute: false
wrapped: false
description: Alert/Warning Messages
Content-Type:
title: Content-Type
enum:
- application/json
- application/xml
type: string
example: application/json
extension:
title: extension
enum:
- .json
- .xml
type: string
example: .json
tags:
- name: Authentication
- name: V4 Network
- name: V6 Subnet
- name: V6 Address
- name: V4 Subnet
- name: V4 Address
- name: RR
- name: Selected V4 Address
- name: Selected V6 Address
- name: Zone
- name: V6 Block
- name: V6 Range
- name: V6 Pool
description: ''