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

This adapter integrates with system described as: efficientip solidserver

openapi: 3.0.0
info:
  title: SOLIDserver API
  description: OpenAPI 3.0.2 API definition for SOLIDserver service from EfficientIP.<p>Copyright © 2000-2020 EfficientIP</p><p><em>All specifications and information regarding the products in  this document are subject to change without notice and should not be  construed as a commitment by EfficientIP. EfficientIP assumes no  responsibility or liability for any mistakes or inaccuracies that may appear  in this document. All statements and recommendations in this document are  believed to be accurate but are presented without warranty. Users must take  full responsibility for their application of any product.</em></p>
  contact:
    name: Support
    url: https://www.efficientip.com/services/support/
    email: support@efficientip.com
  version: '2.0'
servers:
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com
paths:
  /ipam_space_list:
    get:
      tags:
      - ipam
      summary: getIpamSpaceList
      description: This service allows to list the objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamSpaceList
      parameters:
      - name: orderby
        in: query
        description: 'A clause that allows to sort the result. You can include any output parameter of the service in this clause, except class parameters.To sort the result using class parameters, you must tag them first. For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as follows: &lt;parameter&gt;=&#039;&lt;value&gt;&#039;. The clause must be encoded in URL format.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value&#039;s name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.'
        style: form
        explode: true
        schema:
          type: string
      - name: where
        in: query
        description: 'A clause that allows to filter the result. You can include any output parameter of the service in this clause, except class parameters.To filter the result using class parameters, you must tag them first It is no longer possible to use the structure &lt;object-name&gt;_class_parameters like &lt;value&gt; directly in the clause WHERE. . For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : &lt;parameter&gt;=&#039;&lt;value&gt;&#039; or &lt;parameter&gt; IS NOT NULL. The clause must be encoded in URL format.'
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: tags
        in: query
        description: The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format &lt;object-type&gt;.&lt;parameter&gt;, e.g. site.decription .
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamSpaceListResponse'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_space_count:
    get:
      tags:
      - ipam
      summary: getIpamSpaceCount
      description: This service allows to return the number of objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamSpaceCount
      parameters:
      - name: where
        in: query
        description: 'A clause that allows to filter the result. You can include any output parameter of the service *_list of the object in this clause, except class parameters.To filter the result using class parameters, you must tag them first It is no longer possible to use the structure &lt;object-name&gt;_class_parameters like &lt;value&gt; directly in the clause WHERE. . For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : &lt;parameter&gt;=&#039;&lt;value&gt;&#039; or &lt;parameter&gt; IS NOT NULL. The clause must be encoded in URL format.'
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format &lt;object-type&gt;.&lt;parameter&gt;, e.g. site.decription .
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: result operation count
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCountResponseSuccess'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_space_info:
    get:
      tags:
      - ipam
      summary: getIpamSpaceInfo
      description: This service allows to display the properties of an object.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamSpaceInfo
      parameters:
      - name: space_id
        in: query
        description: The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamSpaceInfoResponse'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_space_add:
    post:
      tags:
      - ipam
      summary: createIpamSpace
      description: 'This service allows to add objects. A call can only add one object. To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.</br></br><b>Mandatory Parameters</b>: space_name'
      operationId: createIpamSpace
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpamSpaceAddRequest'
        required: false
      responses:
        '200':
          description: successful object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamSpaceAddResponse'
        '400':
          description: error object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamSpaceAdd400Error1'
      deprecated: false
  /ipam_space_edit:
    put:
      tags:
      - ipam
      summary: updateIpamSpace
      description: 'This service allows to edit existing objects using their identifier. All the input parameters and their value specified in input edit the identified object, any parameter not specified is left unchanged. A call can only edit one object.  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.</br></br><b>Mandatory Parameters</b>: (space_id || space_name)'
      operationId: updateIpamSpace
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpamSpaceEditRequest'
        required: false
      responses:
        '200':
          description: successful object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamSpaceEditResponse'
        '400':
          description: error object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamSpaceEdit400Error1'
      deprecated: false
  /ipam_space_delete:
    delete:
      tags:
      - ipam
      summary: deleteIpamSpace
      description: 'This service allows to delete an object. A call can only delete one object.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.</br></br><b>Mandatory Parameters</b>: (space_id || space_name)'
      operationId: deleteIpamSpace
      parameters:
      - name: space_id
        in: query
        description: The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: space_name
        in: query
        description: The name of the space.
        style: form
        explode: true
        schema:
          type: string
      - name: warnings
        in: query
        description: A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/warnings2'
          - description: A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.
      responses:
        '200':
          description: successful object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamSpaceDeleteResponse'
        '400':
          description: error object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamSpaceDelete400Error1'
      deprecated: false
  /ipam_network_list:
    get:
      tags:
      - ipam
      summary: getIpamNetworkList
      description: This service allows to list the objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamNetworkList
      parameters:
      - name: orderby
        in: query
        description: 'A clause that allows to sort the result. You can include any output parameter of the service in this clause, except class parameters.To sort the result using class parameters, you must tag them first. For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as follows: &lt;parameter&gt;=&#039;&lt;value&gt;&#039;. The clause must be encoded in URL format.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value&#039;s name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.'
        style: form
        explode: true
        schema:
          type: string
      - name: where
        in: query
        description: 'A clause that allows to filter the result. You can include any output parameter of the service in this clause, except class parameters.To filter the result using class parameters, you must tag them first It is no longer possible to use the structure &lt;object-name&gt;_class_parameters like &lt;value&gt; directly in the clause WHERE. . For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : &lt;parameter&gt;=&#039;&lt;value&gt;&#039; or &lt;parameter&gt; IS NOT NULL. The clause must be encoded in URL format.'
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: tags
        in: query
        description: The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format &lt;object-type&gt;.&lt;parameter&gt;, e.g. site.decription .
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamNetworkListResponse'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_network_count:
    get:
      tags:
      - ipam
      summary: getIpamNetworkCount
      description: This service allows to return the number of objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamNetworkCount
      parameters:
      - name: where
        in: query
        description: 'A clause that allows to filter the result. You can include any output parameter of the service *_list of the object in this clause, except class parameters.To filter the result using class parameters, you must tag them first It is no longer possible to use the structure &lt;object-name&gt;_class_parameters like &lt;value&gt; directly in the clause WHERE. . For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : &lt;parameter&gt;=&#039;&lt;value&gt;&#039; or &lt;parameter&gt; IS NOT NULL. The clause must be encoded in URL format.'
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format &lt;object-type&gt;.&lt;parameter&gt;, e.g. site.decription .
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: result operation count
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCountResponseSuccess'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_network_info:
    get:
      tags:
      - ipam
      summary: getIpamNetworkInfo
      description: This service allows to display the properties of an object.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamNetworkInfo
      parameters:
      - name: network_id
        in: query
        description: The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamNetworkInfoResponse'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_network_add:
    post:
      tags:
      - ipam
      summary: createIpamNetwork
      description: 'This service allows to add objects. A call can only add one object.  If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.Note that to add a block-type network, setting the input parameter subnet_level to 0 is mandatory.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.</br></br><b>Mandatory Parameters</b>: (network_addr && (network_end_addr || network_size || network_mask || network_prefix) && (space_id || space_name || parent_network_id))'
      operationId: createIpamNetwork
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpamNetworkAddRequest'
        required: false
      responses:
        '200':
          description: successful object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamNetworkAddResponse'
        '400':
          description: error object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamNetworkAdd400Error1'
      deprecated: false
  /ipam_network_edit:
    put:
      tags:
      - ipam
      summary: updateIpamNetwork
      description: 'This service allows to edit existing ones. A call can only edit one object.  If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.Note that to add a block-type network, setting the input parameter subnet_level to 0 is mandatory.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.</br></br><b>Mandatory Parameters</b>: (network_id || (network_addr && (network_end_addr || network_size || network_mask || network_prefix) && (space_id || space_name || parent_network_id)))'
      operationId: updateIpamNetwork
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpamNetworkEditRequest'
        required: false
      responses:
        '200':
          description: successful object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamNetworkEditResponse'
        '400':
          description: error object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamNetworkEdit400Error1'
      deprecated: false
  /ipam_network_delete:
    delete:
      tags:
      - ipam
      summary: deleteIpamNetwork
      description: 'This service allows to delete an object. A call can only delete one object.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.</br></br><b>Mandatory Parameters</b>: (network_id || (network_addr && (network_end_addr || network_size || network_mask || network_prefix) && (space_id || space_name || parent_network_id)))'
      operationId: deleteIpamNetwork
      parameters:
      - name: parent_network_id
        in: query
        description: The database identifier (ID) of the parent IPv4 network. Use the ID to specify the parent IPv4 network of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: space_id
        in: query
        description: The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: space_name
        in: query
        description: The name of the space.
        style: form
        explode: true
        schema:
          type: string
      - name: network_addr
        in: query
        description: The start IP address of the IPv4 network, its first IP address.
        style: form
        explode: true
        schema:
          type: string
      - name: network_end_addr
        in: query
        description: The end IP address of the IPv4 network, its last IP address.
        style: form
        explode: true
        schema:
          type: string
      - name: network_id
        in: query
        description: The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: network_mask
        in: query
        description: The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.
        style: form
        explode: true
        schema:
          type: string
      - name: network_prefix
        in: query
        description: The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.
        style: form
        explode: true
        schema:
          type: string
      - name: network_size
        in: query
        description: The size of the IPv4 network, the number of IP addresses it contains.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: relative_position
        in: query
        description: 'The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position: use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces. use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: network_level
        in: query
        description: 'The level of the network within the space: Set it to 0 for a block-type network. Set it to a value between 1 and n for a subnet-type network. If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.'
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: network_name
        in: query
        description: The name of the IPv4 network.
        style: form
        explode: true
        schema:
          type: string
      - name: use_reversed_relative_position
        in: query
        description: A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: warnings
        in: query
        description: A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/warnings2'
          - description: A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.
      responses:
        '200':
          description: successful object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamNetworkDeleteResponse'
        '400':
          description: error object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamNetworkDelete400Error1'
      deprecated: false
  /ipam_pool_list:
    get:
      tags:
      - ipam
      summary: getIpamPoolList
      description: This service allows to list the objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamPoolList
      parameters:
      - name: orderby
        in: query
        description: 'A clause that allows to sort the result. You can include any output parameter of the service in this clause, except class parameters.To sort the result using class parameters, you must tag them first. For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as follows: &lt;parameter&gt;=&#039;&lt;value&gt;&#039;. The clause must be encoded in URL format.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value&#039;s name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.'
        style: form
        explode: true
        schema:
          type: string
      - name: where
        in: query
        description: 'A clause that allows to filter the result. You can include any output parameter of the service in this clause, except class parameters.To filter the result using class parameters, you must tag them first It is no longer possible to use the structure &lt;object-name&gt;_class_parameters like &lt;value&gt; directly in the clause WHERE. . For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : &lt;parameter&gt;=&#039;&lt;value&gt;&#039; or &lt;parameter&gt; IS NOT NULL. The clause must be encoded in URL format.'
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: tags
        in: query
        description: The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format &lt;object-type&gt;.&lt;parameter&gt;, e.g. site.decription .
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamPoolListResponse'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_pool_count:
    get:
      tags:
      - ipam
      summary: getIpamPoolCount
      description: This service allows to return the number of objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamPoolCount
      parameters:
      - name: where
        in: query
        description: 'A clause that allows to filter the result. You can include any output parameter of the service *_list of the object in this clause, except class parameters.To filter the result using class parameters, you must tag them first It is no longer possible to use the structure &lt;object-name&gt;_class_parameters like &lt;value&gt; directly in the clause WHERE. . For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : &lt;parameter&gt;=&#039;&lt;value&gt;&#039; or &lt;parameter&gt; IS NOT NULL. The clause must be encoded in URL format.'
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format &lt;object-type&gt;.&lt;parameter&gt;, e.g. site.decription .
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: result operation count
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCountResponseSuccess'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_pool_info:
    get:
      tags:
      - ipam
      summary: getIpamPoolInfo
      description: This service allows to display the properties of an object.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamPoolInfo
      parameters:
      - name: pool_id
        in: query
        description: The database identifier (ID) of the IPv4 pool, a unique numeric key value automatically incremented when you add an IPv4 pool. Use the ID to specify the IPv4 pool of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamPoolInfoResponse'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_pool_add:
    post:
      tags:
      - ipam
      summary: createIpamPool
      description: 'This service allows to add objects. A call can only add one object. To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.</br></br><b>Mandatory Parameters</b>: (pool_start_ip_addr && (pool_end_ip_addr || pool_size) && (network_id || space_id || space_name))'
      operationId: createIpamPool
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpamPoolAddRequest'
        required: false
      responses:
        '200':
          description: successful object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamPoolAddResponse'
        '400':
          description: error object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamPoolAdd400Error1'
      deprecated: false
  /ipam_pool_edit:
    put:
      tags:
      - ipam
      summary: updateIpamPool
      description: 'This service allows to edit existing objects using their identifier. All the input parameters and their value specified in input edit the identified object, any parameter not specified is left unchanged. A call can only edit one object.  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.</br></br><b>Mandatory Parameters</b>: (pool_id || (pool_start_ip_addr && (pool_end_ip_addr || pool_size) && (network_id || space_id || space_name)))'
      operationId: updateIpamPool
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpamPoolEditRequest'
        required: false
      responses:
        '200':
          description: successful object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamPoolEditResponse'
        '400':
          description: error object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamPoolEdit400Error1'
      deprecated: false
  /ipam_pool_delete:
    delete:
      tags:
      - ipam
      summary: deleteIpamPool
      description: 'This service allows to delete an object. A call can only delete one object.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.</br></br><b>Mandatory Parameters</b>: (pool_id || (pool_start_ip_addr && (pool_end_ip_addr || pool_size) && (network_id || space_id || space_name)))'
      operationId: deleteIpamPool
      parameters:
      - name: pool_end_ip_addr
        in: query
        description: The last IP address of the pool.
        style: form
        explode: true
        schema:
          type: string
      - name: pool_id
        in: query
        description: The database identifier (ID) of the IPv4 pool, a unique numeric key value automatically incremented when you add an IPv4 pool. Use the ID to specify the IPv4 pool of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: pool_size
        in: query
        description: The size of the pool, the number of IP addresses it contains.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: space_id
        in: query
        description: The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: space_name
        in: query
        description: The name of the space.
        style: form
        explode: true
        schema:
          type: string
      - name: pool_start_ip_addr
        in: query
        description: The first IP address of the pool.
        style: form
        explode: true
        schema:
          type: string
      - name: network_id
        in: query
        description: The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: warnings
        in: query
        description: A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/warnings2'
          - description: A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.
      responses:
        '200':
          description: successful object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamPoolDeleteResponse'
        '400':
          description: error object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamPoolDelete400Error1'
      deprecated: false
  /ipam_address_list:
    get:
      tags:
      - ipam
      summary: getIpamAddressList
      description: This service allows to list the objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamAddressList
      parameters:
      - name: orderby
        in: query
        description: 'A clause that allows to sort the result. You can include any output parameter of the service in this clause, except class parameters.To sort the result using class parameters, you must tag them first. For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as follows: &lt;parameter&gt;=&#039;&lt;value&gt;&#039;. The clause must be encoded in URL format.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value&#039;s name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.'
        style: form
        explode: true
        schema:
          type: string
      - name: where
        in: query
        description: 'A clause that allows to filter the result. You can include any output parameter of the service in this clause, except class parameters.To filter the result using class parameters, you must tag them first It is no longer possible to use the structure &lt;object-name&gt;_class_parameters like &lt;value&gt; directly in the clause WHERE. . For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : &lt;parameter&gt;=&#039;&lt;value&gt;&#039; or &lt;parameter&gt; IS NOT NULL. The clause must be encoded in URL format.'
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: tags
        in: query
        description: The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format &lt;object-type&gt;.&lt;parameter&gt;, e.g. site.decription .
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamAddressListResponse'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_address_count:
    get:
      tags:
      - ipam
      summary: getIpamAddressCount
      description: This service allows to return the number of objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamAddressCount
      parameters:
      - name: where
        in: query
        description: 'A clause that allows to filter the result. You can include any output parameter of the service *_list of the object in this clause, except class parameters.To filter the result using class parameters, you must tag them first It is no longer possible to use the structure &lt;object-name&gt;_class_parameters like &lt;value&gt; directly in the clause WHERE. . For more details, refer to the section .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : &lt;parameter&gt;=&#039;&lt;value&gt;&#039; or &lt;parameter&gt; IS NOT NULL. The clause must be encoded in URL format.'
        style: form
        explode: true
        schema:
          type: string
      - name: tags
        in: query
        description: The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format &lt;object-type&gt;.&lt;parameter&gt;, e.g. site.decription .
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: result operation count
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCountResponseSuccess'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_address_info:
    get:
      tags:
      - ipam
      summary: getIpamAddressInfo
      description: This service allows to display the properties of an object.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
      operationId: getIpamAddressInfo
      parameters:
      - name: address_id
        in: query
        description: The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamAddressInfoResponse'
        '400':
          description: error executing the action
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      deprecated: false
  /ipam_address_add:
    post:
      tags:
      - ipam
      summary: createIpamAddress
      description: 'This service allows to add objects. A call can only add one object. To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.</br></br><b>Mandatory Parameters</b>: (address_hostaddr && (space_id || space_name))'
      operationId: createIpamAddress
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpamAddressAddRequest'
        required: false
      responses:
        '200':
          description: successful object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamAddressAddResponse'
        '400':
          description: error object edition
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpamAddressAdd400Error1'
      deprecated: false
  /ipam_address_edit:
    put:
      tags:
      - ipam
      summary: updateIpamAddress
      description: 'This service allows to edit exis