@itentialopensource/adapter-nokia_vitalqip

{ "swagger": "2.0", "info": { "version": "1.0.0", "title": "VitalQIP REST Interface", "description": "Sample call for RESTful APIs" }, "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": "Notification Block Change" }, { "name": "V6 Block" }, { "name": "V6 Range" }, { "name": "SAML Identity Provider" }, { "name": "Utilities" } ], "basePath": "/api", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "paths": { "/v1/{orgName}/v4network/{networkInfo}{extension}": { "get": { "description": "Get V4 network by name or address", "summary": "Get V4 network", "operationId": "getV4Network", "tags": [ "V4 Network" ], "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "networkInfo", "description": "Network info (address or name of V4 network)", "required": true, "type": "string" }, { "in": "path", "name": "extension", "description": ".json for a response in JSON format. \n.xml for a response in XML format.\n", "required": true, "type": "string", "enum": [ ".json", ".xml" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/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)\n" }, "404": { "description": "Network not found: [address=<address>]\n" } } } }, "/v1/{orgName}/v4network/{networkInfo}": { "delete": { "description": "Delete V4 network by name or address", "summary": "Delete V4 network", "operationId": "deleteV4Network", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Network" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "networkInfo", "description": "Network info (address or name of V4 network)", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Network does not exist." } } } }, "/v1/{orgName}/v4network": { "post": { "description": "Create a new V4 network", "summary": "Add new V4 network", "operationId": "addV4Network", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Network" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "in": "path", "name": "orgName", "description": "Organization name", "required": true, "type": "string" }, { "name": "requestBody", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/V4NetworkRec" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Created" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Bad" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFound" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Conflict" } } } }, "put": { "description": "Modify V4 network name, warning type, warning percent...", "summary": "Update V4 network", "operationId": "modifyV4Network", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Network" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "in": "path", "name": "orgName", "description": "Organization name", "required": true, "type": "string" }, { "name": "requestBody", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/V4NetworkRec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OK" } }, "400": { "description": "<address> is not an IPV4 Network Address\n\nMissing Network IP Address\n\nGiven Network <address> contains invalid Threshold Value: <warningPercent> or WarningType: <warningType>\n\nInvalid Attribute(s): <name>\n\nUDA <name>'s Value <value> is not an valid Boolean Value\n\nAddress ranges must not be duplicated", "schema": { "$ref": "#/definitions/Bad" } }, "404": { "description": "Network not found: [address=<address&gt]", "schema": { "$ref": "#/definitions/NotFound" } } } } }, "/v1/{orgName}/v4network{extension}": { "get": { "description": "Search V4 Network by name or address. \n*Notes:* If the number of returned V4 Networks is less than or equal to the page size, the page index parameter is not honored.", "summary": "Search V4 network", "operationId": "searchV4Network", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Network" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "extension", "description": ".json for a response in JSON format. \n.xml for a response in XML format.\n", "required": true, "type": "string", "enum": [ ".json", ".xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "query", "name": "address", "description": "V4 network address", "required": false, "type": "string" }, { "in": "query", "name": "name", "description": "V4 network name", "required": false, "type": "string" }, { "in": "query", "name": "pageSize", "description": "page size of response", "required": false, "type": "string" }, { "in": "query", "name": "pageIndex", "description": "page index of response", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/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)\n" }, "404": { "description": "Network not found: [address=<address>]\n" } } } }, "/v1/{orgName}/v6subnet/{address}/{prefixLength}{extension}": { "get": { "description": "Get V6 subnet get by address and prefix length.", "summary": "Get V6 Subnet by address", "operationId": "getV6SubnetByAddress", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "address", "description": "Address of V6 subnet", "required": true, "type": "string" }, { "in": "path", "name": "prefixLength", "description": "prefix length of v6 subnet", "required": true, "type": "string" }, { "in": "path", "name": "extension", "description": ".json for a response in JSON format. \n.xml for a response in XML format.\n", "required": true, "type": "string", "enum": [ ".json", ".xml" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/V6SubnetRec" } }, "404": { "description": "Subnet not found" } } } }, "/v1/{orgName}/v6subnet/{address}/{prefixLength}": { "delete": { "description": "Delete V6 Subnet by address and prefix length.", "summary": "Delete V6 Subnet", "operationId": "deleteV6SubnetByAddress", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "address", "description": "Address of V6 subnet", "required": true, "type": "string" }, { "in": "path", "name": "prefixLength", "description": "prefix length of v6 subnet", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OK" } }, "404": { "description": "Subnet not found" } } } }, "/v1/{orgName}/v6subnet/{address}/{prefixLength}/v6addresses{extension}": { "get": { "description": "Get list v6 address in v6 subnet by address and prefixlength.", "summary": "Get list V6 Address of a V6 Subnet", "operationId": "getV6AddressInV6SubnetByAddress", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "address", "description": "Address of V6 subnet", "required": true, "type": "string" }, { "in": "path", "name": "prefixLength", "description": "prefix length of v6 subnet", "required": true, "type": "string" }, { "in": "path", "name": "extension", "description": ".json for a response in JSON format. \n.xml for a response in XML format.\n", "required": true, "type": "string", "enum": [ ".json", ".xml" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/V6AddressRec" } } }, "404": { "description": "Not found" } } } }, "/v1/{orgName}/v6subnet/{address}/{prefixLength}/ranges{extension}": { "get": { "description": "Get list range in v6 subnet by address and prefixlength.", "summary": "Get list range of a V6 Subnet", "operationId": "getListRangeInV6SubnetByAddress", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "address", "description": "Address of V6 subnet", "required": true, "type": "string" }, { "in": "path", "name": "prefixLength", "description": "prefix length of v6 subnet", "required": true, "type": "string" }, { "in": "path", "name": "extension", "description": ".json for a response in JSON format. \n.xml for a response in XML format.\n", "required": true, "type": "string", "enum": [ ".json", ".xml" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/V6AddressRec" } } }, "404": { "description": "Not found" } } } }, "/v1/{orgName}/v6subnet/{subnetName}{extension}": { "get": { "description": "Get V6 subnet by name", "summary": "Get V6 Subnet by name", "operationId": "getV6SubnetByName", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "subnetName", "description": "Name of V6 subnet", "required": true, "type": "string" }, { "in": "path", "name": "extension", "description": ".json for a response in JSON format. \n.xml for a response in XML format.\n", "required": true, "type": "string", "enum": [ ".json", ".xml" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/V6SubnetRec" } }, "404": { "description": "Subnet not found" } } } }, "/v1/{orgName}/v6subnet/{subnetName}": { "delete": { "description": "Delete V6 Subnet by name", "summary": "Delete V6 Subnet by name", "operationId": "deleteV6SubnetByName", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "subnetName", "description": "V6 Subnet's name", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OK" } }, "404": { "description": "Subnet not found" } } } }, "/v1/{orgName}/v6subnet": { "post": { "description": "Creates a new V6 Subnet. Subnet Name and Address pairs are returned after adding subnets successfully. \n*Note:* Should not test this API on Swagger. Please use another REST Client (cURL, Postman).", "summary": "Add new V6 Subnet", "operationId": "addV6Subnet", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "in": "path", "name": "orgName", "description": "Organization name", "required": true, "type": "string" }, { "name": "requestBody", "in": "body", "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, "schema": { "$ref": "#/definitions/V6CreateSubnetRec" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/v6SubnetCreated" } }, "400": { "description": "Bad request\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.\n\nNo value specified for: [value]\n\nInvalid Create Subnet Type: [{0}].\n\nInvalid Allocation Algorithm. Algorithm [{0}] is not supported.\n\nValue can be either true or false.", "schema": { "$ref": "#/definitions/Bad" } }, "404": { "description": "Pool not found: [name=<name>, parent=<name>] \nBlock not found\n", "schema": { "$ref": "#/definitions/NotFound" } }, "409": { "description": "Subnet already Exists in the Parent Pool.", "schema": { "$ref": "#/definitions/Conflict" } } } }, "put": { "description": "Modify a V6 Subnet", "summary": "Update V6 Subnet", "operationId": "updateV6Subnet", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "in": "path", "name": "orgName", "description": "Organization name", "required": true, "type": "string" }, { "name": "requestBody", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/V6SubnetRec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OK" } }, "400": { "description": "Bad request\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\nNo value specified for: [udaGroupName]\n\nNo value specified for: [udaName]\n\nNo value specified for: [udaValue]\n\nBlock invalid.\n\nNo value specified for: [value]\n\nNot a valid state.\n\nInvalid Allocation Algorithm. Algorithm [value] is not supported.\n\nInvalid Address Selection Algorithm.", "schema": { "$ref": "#/definitions/Bad" } }, "404": { "description": "Pool not found: [name=<name>, parent=<name>] \nBlock not found\n", "schema": { "$ref": "#/definitions/NotFound" } }, "409": { "description": "Subnet already Exists in the Parent Pool.", "schema": { "$ref": "#/definitions/Conflict" } } } } }, "/v1/{orgName}/v6subnet{extension}": { "get": { "description": "Search V6 Subnet by name or address. \n*Notes:* If the number of returned V6 Subnets is less than or equal to the page size, the page index parameter is not honored.", "summary": "Search V6 Subnet", "operationId": "searchV6Subnet", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "extension", "description": ".json for a response in JSON format. \n.xml for a response in XML format.\n", "required": true, "type": "string", "enum": [ ".json", ".xml" ] }, { "in": "query", "name": "address", "description": "V6 Subnet address", "required": false, "type": "string" }, { "in": "query", "name": "name", "description": "V6 Subnet name", "required": false, "type": "string" }, { "in": "query", "name": "pageSize", "description": "page size of response", "required": false, "type": "string" }, { "in": "query", "name": "pageIndex", "description": "page index of response", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/V6SubnetRec" } } }, "404": { "description": "Subnet not found\n" } } } }, "/v1/{orgName}/v6address": { "post": { "description": "Creates V6 Address", "summary": "Add new V6 Address", "operationId": "addV6Address", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Address" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "in": "path", "name": "orgName", "description": "Organization name", "required": true, "type": "string" }, { "name": "requestBody", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/V6AddressRec" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Created" } }, "400": { "description": "Required Field(s) Missing: [field]\n DUID [<DUID>] already exists \n\nInvalid IP Address Type. IP Address Type [{0}] is not supported.\n", "schema": { "$ref": "#/definitions/Bad" } }, "404": { "description": "Range not found.", "schema": { "$ref": "#/definitions/NotFound" } }, "409": { "description": "IPv6 address with the given IAID and DUID combination already exists within the parent subnet subnetAddress.", "schema": { "$ref": "#/definitions/Conflict" } } } }, "put": { "description": "Modify V6 Address", "summary": "Update V6 Address", "operationId": "updateV6Address", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Address" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "in": "path", "name": "orgName", "description": "Organization name", "required": true, "type": "string" }, { "name": "requestBody", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/V6AddressRec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Created" } }, "400": { "description": "Invalid IP Address Type. IP Address Type [{0}] is not supported.", "schema": { "$ref": "#/definitions/Bad" } }, "404": { "description": "Address not found. \nUDA group not found: [name=<groupName>]. \nUser Defined Attribute not found: [name=<udaName>].\n", "schema": { "$ref": "#/definitions/NotFound" } } } } }, "/v1/{orgName}/v6address/{addressInfo}/": { "delete": { "description": "Delete V6 Address by name or address. The trailing slash is required.", "summary": "Delete V6 Address", "operationId": "deleteV6Address", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Address" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "addressInfo", "description": "V6 address or name", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OK" } }, "404": { "description": "Address not found." } } } }, "/v1/{orgName}/v6address/{addressInfo}{extension}": { "get": { "description": "Get V6 address by address or by name", "summary": "Get V6 Address", "operationId": "getV6Address", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V6 Address" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "addressInfo", "description": "Address OR object name and domain name of V6 Address", "required": true, "type": "string" }, { "in": "path", "name": "extension", "description": ".json for a response in JSON format. \n.xml for a response in XML format.\n", "required": true, "type": "string", "enum": [ ".json", ".xml" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/V6AddressRec" } }, "404": { "description": "Address not found.\n" } } } }, "/v1/{orgName}/v4subnet": { "post": { "description": "Creates V4 Subnet", "summary": "Add new V4 Subnet", "operationId": "addV4Subnet", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "in": "path", "name": "orgName", "description": "Organization name", "required": true, "type": "string" }, { "name": "requestBody", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/V4SubnetRec" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Created" } }, "400": { "description": "Required Field(s) Missing: [field]\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.", "schema": { "$ref": "#/definitions/Bad" } }, "404": { "description": "Subnet Organization not found: [field]" }, "409": { "description": "Subnet address already exists", "schema": { "$ref": "#/definitions/Conflict" } } } }, "put": { "description": "Modify V4 Subnet", "summary": "Update V4 Subnet", "operationId": "updateV4Subnet", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "in": "path", "name": "orgName", "description": "Organization name", "required": true, "type": "string" }, { "name": "isUpdate", "in": "query", "description": "update", "required": true, "type": "boolean" }, { "name": "requestBody", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/V4SubnetRec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Created" } }, "400": { "description": "Or \"<routeAddress>\" is not an IPv4 address \nOr Invalid Attribute(s): <attributeName> \nOr The threshold is invalid. Valid warning type is in 0 - 3. Valid warning percent is in 0 - 99. \nOr Invalid input specified for [checkUsage] parameter. Required [true | false], Received [false1].\n", "schema": { "$ref": "#/definitions/Bad" } }, "404": { "description": "Or Subnet having address \"<address>\" does not exist. \nOr Domain <domainName> not found. \nOr The time server object <timeServer> does not exist. \nOr DHCP Server <dhcpServer> does not exist. \nOr DHCP Option Template not found: [dhcpOptionTemplate] \nOr DHCP Policy Template not found: [dhcpPolicyTemplate] \nOr DNS Server not found: [<dnsServerName>] \nOr Subnet Organization not found: [field]" }, "409": { "description": "Subnet address already exists", "schema": { "$ref": "#/definitions/Conflict" } } } } }, "/v1/{orgName}/v4subnet{extension}": { "get": { "description": "Search V4 subnet by name, address or UDA value.", "summary": "Search V4 Subnet", "operationId": "searchV4Subnet", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "query", "name": "address", "description": "V4 Subnet address", "required": false, "type": "string" }, { "in": "query", "name": "name", "description": "V4 Subnet name", "required": false, "type": "string" }, { "in": "query", "name": "udaName", "description": "udaName", "required": false, "type": "string" }, { "in": "query", "name": "udaValue", "description": "udaValue", "required": false, "type": "string" }, { "in": "path", "name": "extension", "description": ".json for a response in JSON format. \n.xml for a response in XML format.\n", "required": true, "type": "string", "enum": [ ".json", ".xml" ] }, { "in": "query", "name": "pageIndex", "description": "Page index. Default value is 1. Minimum value is 1", "required": false, "type": "integer", "minimum": 1 }, { "in": "query", "name": "pageSize", "description": "Page size of response. Default value is 25.", "required": false, "type": "integer", "minimum": 0, "maximum": 10000 } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/V4SubnetRec" } } }, "400": { "description": "Required Field(s) Missing: [UdaName or UdaValue]\n" } } } }, "/v1/{orgName}/v4subnet/split": { "post": { "description": "Split V4 subnet.", "summary": "Split V4 Subnet", "operationId": "splitV4Subnet", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "name": "requestBody", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/SplitV4AlterSubnetRec" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "400": { "description": "Invalid subnet address.", "schema": { "type": "string" } }, "404": { "description": "Subnet having address <subnetAddress> does not exist.", "schema": { "type": "string" } } } } }, "/v1/{orgName}/v4subnet/join": { "post": { "description": "Join V4 subnet.", "summary": "Join V4 Subnet", "operationId": "JoinV4Subnet", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "name": "requestBody", "in": "body", "description": "Request body", "required": true, "schema": { "$ref": "#/definitions/JoinV4AlterSubnetRec" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "400": { "description": "Required Field(s) Missing: <Field>.", "schema": { "type": "string" } }, "404": { "description": "Subnet having address <subnetAddress> does not exist.", "schema": { "type": "string" } } } } }, "/v1/{orgName}/v4subnet/{subnetAddress}{extension}": { "get": { "description": "Get V4 subnet by subnet address. Get objects usage information of a subnet using ?usage parameter", "summary": "Get V4 Subnet and Subnet Statistics Information", "operationId": "getV4Subnet", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "subnetAddress", "description": "Subnet address", "required": true, "type": "string" }, { "in": "path", "name": "extension", "description": ".json for a response in JSON format. \n.xml for a response in XML format.\n", "required": true, "type": "string", "enum": [ ".json", ".xml" ] }, { "in": "query", "name": "usage", "description": "Add this parameter to show subnet statistics information", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/V4SubnetRec" } }, "404": { "description": "Subnet not found" } } } }, "/v1/{orgName}/v4subnet/{subnetInfo}/": { "delete": { "description": "Delete V4 Subnet by name or by address. The trailing slash is required.", "summary": "Delete V4 Subnet", "operationId": "deleteV4SubnetByName", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "name": "subnetInfo", "description": "V4 Subnet's name or address", "required": true, "type": "string" }, { "in": "query", "name": "multipleDelete", "description": "Multiple delete", "required": false, "type": "boolean" }, { "in": "query", "name": "deleteReserveObjects", "description": "delete reserve objects", "required": false, "type": "boolean" }, { "in": "query", "name": "application", "description": "application name", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "404": { "description": "Subnet having address <subnetAddress> does not exist.", "schema": { "type": "string" } } } } }, "/v1/{orgName}/v4subnet/{subnetAddress}/v4addresses{extension}": { "get": { "description": "Get list V4 address of a V4 Subnet by subnet address", "summary": "Get list V4 Address of a V4 Subnet", "operationId": "getListAddressV4Subnet", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/json", "application/xml" ], "tags": [ "V4 Subnet" ], "parameters": [ { "name": "Authentication", "in": "header", "description": "Token tokenValue or \nBasic username:password or \nLeave blank if using Client Certificate Authentication\n", "required": false, "type": "string", "format": "string" }, { "name": "Content-Type", "in": "header", "description": "application/xml \napplication/json\n", "required": true, "type": "string", "format": "string", "enum": [ "application/json", "application/xml" ] }, { "in": "path", "name": "orgName", "description": "Organization Name", "required": true, "type": "string" }, { "in": "path", "