@itentialopensource/adapter-nokia_vitalqip
Version:
This adapter integrates with system described as: Nokia Vital QIP
1,677 lines • 323 kB
JSON
{
"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": {
"$ref": "#/components/schemas/QIPUser"
}
}
},
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/Content-Type"
}
},
{
"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<br> \n.xml to reponse with XML format",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/extension"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V4NetworkRec"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/V4NetworkRec"
}
}
}
},
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/Content-Type"
}
},
{
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave 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": {
"$ref": "#/components/schemas/V4NetworkRec"
}
}
},
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/xml<br>\napplication/json",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/Content-Type"
}
},
{
"name": "extension",
"in": "path",
"description": ".json or null if you want to reponse with JSON format<br> \n.xml to reponse with XML format",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/extension"
}
},
{
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/xml<br>\napplication/json",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/Content-Type"
}
},
{
"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<br> \n.xml to reponse with XML format",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/extension"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V6SubnetRec"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/V6SubnetRec"
}
}
}
},
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/Content-Type"
}
},
{
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/xml<br>\napplication/json",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/Content-Type"
}
},
{
"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<br> \n.xml to reponse with XML format",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/extension"
}
}
],
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/xml<br>\napplication/json",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/Content-Type"
}
},
{
"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<br> \n.xml to reponse with XML format",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/extension"
}
}
],
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/Content-Type"
}
},
{
"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<br> \n.xml to reponse with XML format",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/extension"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V6SubnetRec"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/V6SubnetRec"
}
}
}
},
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/Content-Type"
}
},
{
"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.<br>\n*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<br>or<br>\nBasic username:password<br>or<br>\nLeave 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": {
"$ref": "#/components/schemas/V6CreateSubnetRec"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successfully created subnets - <subnetsNo><br>\n<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>]<br>\nBlock 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<br>or<br>\nBasic username:password<br>or<br>\nLeave 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": {
"$ref": "#/components/schemas/V6SubnetRec"
}
}
},
"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>]<br>\nBlock 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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/xml<br>\napplication/json",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/Content-Type"
}
},
{
"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<br> \n.xml to reponse with XML format",
"required": true,
"style": "simple",
"schema": {
"$ref": "#/components/schemas/extension"
}
},
{
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave 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": {
"$ref": "#/components/schemas/V6AddressRec"
}
}
},
"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<br>or<br>\nBasic username:password<br>or<br>\nLeave 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": {
"$ref": "#/components/schemas/V6AddressRec"
}
}
},
"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.<br>\nUDA group not found: [name=<groupName>].<br>\nUser 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<br>or<br>\nBasic username:password<br>or<br>\nLeave blank if using Client Certificate Authentication",
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "application/xml<br>\napplication/json",
"required": true,
"style": "s