@itentialopensource/adapter-ns1_enterprise

{ "openapi": "3.0.0", "info": { "title": "NS1_Enterprise", "contact": { "email": "support@itential.com" }, "version": "1.0.0" }, "servers": [ { "url": "https://api.mycompany.net/v1/", "variables": {} } ], "paths": { "/ops/bootstrap": { "post": { "tags": [ "Operations" ], "summary": "Bootstrap the first operator user", "description": "When no operator users exist in the main database, the bootstrap endpoint is enabled. This is the only endpoint which does not require authentication. Note: Bootstrap can only be performed once. If the returned API key is lost, the system must be deployed again.", "operationId": "Bootstrapthefirstoperatoruser", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatorUser" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewOperatorUser" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/operators": { "get": { "tags": [ "Operations" ], "summary": "View all operator users", "description": "Returns a list of all operator users in the system.", "operationId": "Viewalloperatorusers", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorUser" }, "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "put": { "tags": [ "Operations" ], "summary": "Create a new operator user", "description": "Create a new operator user for the system. In addition to creating other operators, organizations, and services; operators can act as administrators on behalf of any organization in the system where users within a tenant organization only have access to that organization’s resources (e.g. zones, records, API keys, etc.).", "operationId": "Createanewoperatoruser", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatorUser" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatorUser" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/operators/{operator-id}": { "get": { "tags": [ "Operations" ], "summary": "View operator details", "description": "Returns information about the operator user.", "operationId": "Viewoperatordetails", "parameters": [ { "name": "operator-id", "in": "path", "description": "Operator ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatorUser" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "post": { "tags": [ "Operations" ], "summary": "Modify details of an operator", "description": "Updates an operator's information.", "operationId": "Modifydetailsofanoperator", "parameters": [ { "name": "operator-id", "in": "path", "description": "Operator ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatorUser" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperatorUser" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "delete": { "tags": [ "Operations" ], "summary": "Delete an operator", "description": "Removes another operator from the system. An operator cannot remove themselves.", "operationId": "Deleteanoperator", "parameters": [ { "name": "operator-id", "in": "path", "description": "Operator ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {} }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/orgs": { "get": { "tags": [ "Operations" ], "summary": "View a list of organizations", "description": "Returns a list of the tenant organizations.", "operationId": "Viewalistoforganizations", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" }, "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "put": { "tags": [ "Operations" ], "summary": "Create an organization", "description": "Create a new tenant organization.", "operationId": "Createanorganization", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/orgs/{orgid}": { "get": { "tags": [ "Operations" ], "summary": "View organization details", "description": "Returns the details of an organization.", "operationId": "Vieworganizationdetails", "parameters": [ { "name": "orgid", "in": "path", "description": "Organization ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "post": { "tags": [ "Operations" ], "summary": "Modify an organization", "description": "Modify the organization's name.", "operationId": "Modifyanorganization", "parameters": [ { "name": "orgid", "in": "path", "description": "Organization ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "delete": { "tags": [ "Operations" ], "summary": "Delete an organization", "description": "Delete a tenant organization. This operation requires adding the token parameter with the operator's 2FA TOTP token.", "operationId": "Deleteanorganization", "parameters": [ { "name": "orgid", "in": "path", "description": "Organization ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "token", "in": "query", "description": "2FA TOTP token", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {} }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/orgs/{orgid}/service/groups": { "get": { "tags": [ "Operations" ], "summary": "View service groups associated with an organization", "description": "Returns a list of all service groups associated with an organization.", "operationId": "Viewservicegroupsassociatedwithanorganization", "parameters": [ { "name": "orgid", "in": "path", "description": "Organization ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceGroup" }, "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/service/defs": { "get": { "tags": [ "Service Definitions" ], "summary": "View list of service definitions", "description": "Returns a list of all services of every type.", "operationId": "Viewlistofservicedefinitions", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceDefinition" }, "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "put": { "tags": [ "Service Definitions" ], "summary": "Create a new service definition", "description": "Create a new service definition (e.g. DNS Pools or DHCP Service). Service definitions groups application data for propagation to edge nodes.", "operationId": "Createanewservicedefinition", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceDefinition" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceDefinition" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/service/defs/{definitionid}": { "get": { "tags": [ "Service Definitions" ], "summary": "View service definition details", "description": "Returns the details of a service definition.", "operationId": "Viewservicedefinitiondetails", "parameters": [ { "name": "definitionid", "in": "path", "description": "Service Definition ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceDefinition" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "post": { "tags": [ "Service Definitions" ], "summary": "Modify a service definition", "description": "Modify a service definition's information.", "operationId": "Modifyaservicedefinition", "parameters": [ { "name": "definitionid", "in": "path", "description": "Service Definition ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Service Definition Object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceDefinition" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceDefinition" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "delete": { "tags": [ "Service Definitions" ], "summary": "Delete a service definition", "description": "Delete a service definition.", "operationId": "Deleteaservicedefinition", "parameters": [ { "name": "definitionid", "in": "path", "description": "Service Definition ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "object", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/service/groups": { "get": { "tags": [ "Service Groups" ], "summary": "View a list of service groups", "description": "Returns a list of all service groups.", "operationId": "Viewalistofservicegroups", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceGroup" }, "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "put": { "tags": [ "Service Groups" ], "summary": "Create a service group", "description": "Creates a new service group.", "operationId": "Createaservicegroup", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceGroup" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/service/groups/{servicegroupid}": { "get": { "tags": [ "Service Groups" ], "summary": "View service group details", "description": "Returns details of a service group.", "operationId": "Viewservicegroupdetails", "parameters": [ { "name": "servicegroupid", "in": "path", "description": "Service Group ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceGroup" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "post": { "tags": [ "Service Groups" ], "summary": "Modify a service group", "description": "Modify a service group's name.", "operationId": "Modifyaservicegroup", "parameters": [ { "name": "servicegroupid", "in": "path", "description": "Service Group ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceGroup" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "delete": { "tags": [ "Service Groups" ], "summary": "Delete a service group", "description": "Deletes a service group from the system.", "operationId": "Deleteaservicegroup", "parameters": [ { "name": "servicegroupid", "in": "path", "description": "Service Group ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "object", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/service/groups/{servicegroupid}/org/{orgid}": { "post": { "tags": [ "Service Groups" ], "summary": "Associate with an organization", "description": "Associate a service group with an organization. The tenant organization will have access to resources in this service group such as its DNS Pools and DHCP services.", "operationId": "Associatewithanorganization", "parameters": [ { "name": "servicegroupid", "in": "path", "description": "Service Group ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "orgid", "in": "path", "description": "Organization ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ops/service/groups/{servicegroupid}/orgs": { "get": { "tags": [ "Service Groups" ], "summary": "View organizations associated with a service group", "description": "Returns a list of organizations with access to this service group.", "operationId": "Vieworganizationsassociatedwithaservicegroup", "parameters": [ { "name": "servicegroupid", "in": "path", "description": "Service Group ID", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" }, "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/network": { "get": { "tags": [ "IPAM" ], "summary": "View a list of networks", "description": "Returns a list of all networks", "operationId": "Viewalistofnetworks", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Network" }, "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "put": { "tags": [ "IPAM" ], "summary": "Create a network", "description": "Create a network", "operationId": "Createanetwork", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/network/{networkId}": { "get": { "tags": [ "IPAM" ], "summary": "View a network", "description": "View a network", "operationId": "Viewanetwork", "parameters": [ { "name": "networkId", "in": "path", "description": "Network ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "post": { "tags": [ "IPAM" ], "summary": "Update a network", "description": "Update a network", "operationId": "Updateanetwork", "parameters": [ { "name": "networkId", "in": "path", "description": "Network ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "delete": { "tags": [ "IPAM" ], "summary": "Remove a network", "description": "Remove a network", "operationId": "Removeanetwork", "parameters": [ { "name": "networkId", "in": "path", "description": "Network ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "object", "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/network/{networkId}/report": { "get": { "tags": [ "IPAM" ], "summary": "View a network report", "description": "Get a report of network usage", "operationId": "Viewanetworkreport", "parameters": [ { "name": "networkId", "in": "path", "description": "Network ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkReport" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/address": { "get": { "tags": [ "IPAM" ], "summary": "View a list of root addresses", "description": "Returns a list of all root addresses (i.e. indent == 0) in all networks for the requesting organization.", "operationId": "Viewalistofrootaddresses", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subnet" }, "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "put": { "tags": [ "IPAM" ], "summary": "Create a subnet", "description": "Create a subnet", "operationId": "Createasubnet", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnet" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnet" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/address/search": { "get": { "tags": [ "IPAM" ], "summary": "Search for an address object", "description": "Returns a list of matching objects in the IP address management.", "operationId": "Searchforanaddressobject", "parameters": [ { "name": "network", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "max", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "tag", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "order_by", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "asc_desc", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "mask", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "prefix", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subnet" }, "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/address/{addressId}": { "get": { "tags": [ "IPAM" ], "summary": "View a subnet", "description": "View a subnet", "operationId": "Viewasubnet", "parameters": [ { "name": "addressId", "in": "path", "description": "Address ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnet" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "post": { "tags": [ "IPAM" ], "summary": "Edit a subnet", "description": "Edit a subnet", "operationId": "Editasubnet", "parameters": [ { "name": "addressId", "in": "path", "description": "Address ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnet" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnet" } } } }, "400": { "description": "failed operation" } }, "deprecated": false }, "delete": { "tags": [ "IPAM" ], "summary": "Delete a subnet", "description": "Delete a subnet", "operationId": "Deleteasubnet", "parameters": [ { "name": "addressId", "in": "path", "description": "Address ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnet" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/address/{addressId}/split": { "post": { "tags": [ "IPAM" ], "summary": "Split a subnet", "description": "Splitting an entire block of unassigned IP space into equal pieces. This will not function with ranges or individual hosts. Normal breaking out of a subnet is done with the standard PUT route. (Eg. root address is a /24 and request for /29s will break it into 32 /29s)\n\n- Only planned subnets can be split\n- Name and description will be unset on children\n- KVPS and options will be copied; tags will be inherited as per normal\n", "operationId": "Splitasubnet", "parameters": [ { "name": "addressId", "in": "path", "description": "Address ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnet" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnet" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/address/{addressId}/merge": { "post": { "tags": [ "IPAM" ], "summary": "Merge a subnet", "description": "Merge a subnet", "operationId": "Mergeasubnet", "parameters": [ { "name": "addressId", "in": "path", "description": "Address ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/body" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnet" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/address/{addressId}/children": { "get": { "tags": [ "IPAM" ], "summary": "View address children", "description": "Request a list of all child addresses (or subnets) for the specified IP address.", "operationId": "Viewaddresschildren", "parameters": [ { "name": "addressId", "in": "path", "description": "Address ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subnet" }, "description": "successful operation" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/address/{addressId}/parent": { "get": { "tags": [ "IPAM" ], "summary": "View address parent", "description": "Request a list of all parent addresses (or subnets) for the specified IP address.", "operationId": "Viewaddressparent", "parameters": [ { "name": "addressId", "in": "path", "description": "Address ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subnet" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/address/{addressId}/adjacent": { "get": { "tags": [ "IPAM" ], "summary": "View next (or previous) available prefix", "description": "Retrieves next or previous (aka adjacent) available IP address.", "operationId": "Viewnext(orprevious)availableprefix", "parameters": [ { "name": "addressId", "in": "path", "description": "Address ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "previous", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "X-NSONE-Key", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200_1" } } } }, "400": { "description": "failed operation" } }, "deprecated": false } }, "/ipam/address/{subnet_id}/pool": { "get": { "tags": [ "IPAM" ], "summary": "View a subnet", "description": "View a subnet", "operationId": "GetViewasubnet", "parameters": [ { "name": "subnet_id", "in": "path", "description": "Subnet ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation",