@itentialopensource/adapter-ns1_enterprise/report/adapter-openapi.yaml

This adapter integrates with system described as: 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: Bootstrapthefirstoperatoruser
      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
          headers: {}
          content: {}
      deprecated: false
  /ops/operators:
    get:
      tags:
      - Operations
      summary: Viewalloperatorusers
      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
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Operations
      summary: Createanewoperatoruser
      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
          headers: {}
          content: {}
      deprecated: false
  /ops/operators/{operator-id}:
    get:
      tags:
      - Operations
      summary: Viewoperatordetails
      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
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Operations
      summary: Modifydetailsofanoperator
      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
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Operations
      summary: Deleteanoperator
      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: {}
          content: {}
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ops/orgs:
    get:
      tags:
      - Operations
      summary: Viewalistoforganizations
      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
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Operations
      summary: Createanorganization
      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
          headers: {}
          content: {}
      deprecated: false
  /ops/orgs/{orgid}:
    get:
      tags:
      - Operations
      summary: Vieworganizationdetails
      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
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Operations
      summary: Modifyanorganization
      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
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Operations
      summary: Deleteanorganization
      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: {}
          content: {}
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ops/orgs/{orgid}/service/groups:
    get:
      tags:
      - Operations
      summary: Viewservicegroupsassociatedwithanorganization
      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
          headers: {}
          content: {}
      deprecated: false
  /ops/service/defs:
    get:
      tags:
      - Service Definitions
      summary: Viewlistofservicedefinitions
      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
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Service Definitions
      summary: Createanewservicedefinition
      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
          headers: {}
          content: {}
      deprecated: false
  /ops/service/defs/{definitionid}:
    get:
      tags:
      - Service Definitions
      summary: Viewservicedefinitiondetails
      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
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Service Definitions
      summary: Modifyaservicedefinition
      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:
              allOf:
              - $ref: '#/components/schemas/ServiceDefinition'
              - description: Service Definition Object
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceDefinition'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Service Definitions
      summary: Deleteaservicedefinition
      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
          headers: {}
          content: {}
      deprecated: false
  /ops/service/groups:
    get:
      tags:
      - Service Groups
      summary: Viewalistofservicegroups
      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
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Service Groups
      summary: Createaservicegroup
      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
          headers: {}
          content: {}
      deprecated: false
  /ops/service/groups/{servicegroupid}:
    get:
      tags:
      - Service Groups
      summary: Viewservicegroupdetails
      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
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Service Groups
      summary: Modifyaservicegroup
      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
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Service Groups
      summary: Deleteaservicegroup
      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
          headers: {}
          content: {}
      deprecated: false
  /ops/service/groups/{servicegroupid}/org/{orgid}:
    post:
      tags:
      - Service Groups
      summary: Associatewithanorganization
      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
          headers: {}
          content: {}
      deprecated: false
  /ops/service/groups/{servicegroupid}/orgs:
    get:
      tags:
      - Service Groups
      summary: Vieworganizationsassociatedwithaservicegroup
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/network:
    get:
      tags:
      - IPAM
      summary: Viewalistofnetworks
      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
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - IPAM
      summary: Createanetwork
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/network/{networkId}:
    get:
      tags:
      - IPAM
      summary: Viewanetwork
      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
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - IPAM
      summary: Updateanetwork
      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
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - IPAM
      summary: Removeanetwork
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/network/{networkId}/report:
    get:
      tags:
      - IPAM
      summary: Viewanetworkreport
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/address:
    get:
      tags:
      - IPAM
      summary: Viewalistofrootaddresses
      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
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - IPAM
      summary: Createasubnet
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/address/search:
    get:
      tags:
      - IPAM
      summary: Searchforanaddressobject
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/address/{addressId}:
    get:
      tags:
      - IPAM
      summary: Viewasubnet
      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
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - IPAM
      summary: Editasubnet
      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
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - IPAM
      summary: Deleteasubnet
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/address/{addressId}/split:
    post:
      tags:
      - IPAM
      summary: Splitasubnet
      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)


        - Only planned subnets can be split

        - Name and description will be unset on children

        - KVPS and options will be copied; tags will be inherited as per normal
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/address/{addressId}/merge:
    post:
      tags:
      - IPAM
      summary: Mergeasubnet
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/address/{addressId}/children:
    get:
      tags:
      - IPAM
      summary: Viewaddresschildren
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/address/{addressId}/parent:
    get:
      tags:
      - IPAM
      summary: Viewaddressparent
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/address/{addressId}/adjacent:
    get:
      tags:
      - IPAM
      summary: Viewnext(orprevious)availableprefix
      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
          headers: {}
          content: {}
      deprecated: false
  /ipam/address/{subnet_id}/pool:
    get:
      tags:
      - IPAM
      summary: GetViewasubnet
      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
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PoolOfIPAddresses'
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - IPAM
      summary: Createapool(IPrange)withinasubnet
      description: Creates a pool (range of IP addresses) under a given subnet.
      operationId: Createapool(IPrange)withinasubnet
      parameters:
      - name: subnet_id
        in: path
        description: Subnet ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PoolOfIPAddresses'
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PoolOfIPAddresses'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ipam/address/{subnet_id}/pool/{pool_id}:
    get:
      tags:
      - IPAM
      summary: Viewapool(IPrange)withinasubnet
      description: Returns a pool (range of IP addresses) under a given subnet.
      operationId: Viewapool(IPrange)withinasubnet
      parameters:
      - name: subnet_id
        in: path
        description: Subnet ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      - name: pool_id
        in: path
        description: Pool ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PoolOfIPAddresses'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - IPAM
      summary: Updateapool(IPrange)withinasubnet
      description: Updates a pool (range of IP addresses) under a given subnet.
      operationId: Updateapool(IPrange)withinasubnet
      parameters:
      - name: subnet_id
        in: path
        description: Subnet ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      - name: pool_id
        in: path
        description: Pool ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PoolOfIPAddresses'
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PoolOfIPAddresses'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - IPAM
      summary: Deleteapool(IPrange)withinasubnet
      description: Deletes a pool (range of IP addresses) under a given subnet.
      operationId: Deleteapool(IPrange)withinasubnet
      parameters:
      - name: subnet_id
        in: path
        description: Subnet ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      - name: pool_id
        in: path
        description: Pool ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ipam/tags:
    get:
      tags:
      - IPAM
      summary: Viewalltags
      description: Get a list of all tags used by this organization
      operationId: Viewalltags
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ipam/keys:
    get:
      tags:
      - IPAM
      summary: Viewallorganizationkeys
      description: Get a list of all keys used by this organization for key-value pairs
      operationId: Viewallorganizationkeys
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /dhcp/scope:
    get:
      tags:
      - DHCP
      summary: Generatealistoftheactivescopes
      description: Generate a list of the active scopes
      operationId: Generatealistoftheactivescopes
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Scope'
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - DHCP
      summary: Createascope
      description: >
        Create a scope.


        **Note**: The DHCP server, if enabled, will allocate addresses from the associated IP address, grant any DHCP options associated with the address. The address and scope group must each meet certain invariants or else the request will result in a **422**.


        The address must:
          - be of type `assignment`.
          - not already be assigned to another scope group

        `options` should be supported for the address' protocol.
      operationId: Createascope
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Scope'
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scope'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /dhcp/scope/{scopeID}:
    get:
      tags:
      - DHCP
      summary: Viewscopedetails
      description: Request details about a specific scope.
      operationId: Viewscopedetails
      parameters:
      - name: scopeID
        in: path
        description: Scope ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scope'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - DHCP
      summary: Modifyascope
      description: Modify a scope
      operationId: Modifyascope
      parameters:
      - name: scopeID
        in: path
        description: Scope ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Scope'
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scope'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - DHCP
      summary: Removeascope
      description: Once removed, the address will no longer be used for leases and any current leases will be reclaimed.
      operationId: Removeascope
      parameters:
      - name: scopeID
        in: path
        description: Scope ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scope'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /dhcp/scope/group:
    get:
      tags:
      - DHCP
      summary: Listscopegroups
      description: Request a list of all scope groups
      operationId: Listscopegroups
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScopeGroup'
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - DHCP
      summary: Createascopegroup
      description: Creates a scope group with global settings and options.Options must be valid for the address's IP protocol. If the option has already been set, this request will overwrite it.
      operationId: Createascopegroup
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScopeGroup'
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopeGroup'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /dhcp/scopegroup/{scopegroupID}:
    get:
      tags:
      - DHCP
      summary: Viewscopegroup
      description: Request information about a scope groups using its unique ID.
      operationId: Viewscopegroup
      parameters:
      - name: scopegroupID
        in: path
        description: Scope Group ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopeGroup'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - DHCP
      summary: UpdatescopegroupbyID
      description: Update scope group by ID
      operationId: UpdatescopegroupbyID
      parameters:
      - name: scopegroupID
        in: path
        description: Scope Group ID
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScopeGroup'
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopeGroup'
        '400':
          description: failed operation