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

This adapter integrates with system described as: BlueCat ProteusAPI.

openapi: 3.0.0
info:
  title: BAM REST API
  contact: {}
  version: '9.2.0-919.GA.bcn@release-9.2#caa46e7d0c5f70ca0abedd2af01bf51ea596cb16 built 2020-04-15 22:42:24Z'
servers:
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com
paths:
  /v1/addAccessRight:
    post:
      tags:
      - bam_object_methods
      summary: addAccessRight
      description: Adds access rights to a specified object.
      operationId: addAccessRight
      parameters:
      - name: entityId
        in: query
        description: >-
          The object ID of the entity to which the access right is being added. Set

          to zero (0) if you are adding the access right to the root level default

          access rights.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: overrides
        in: query
        description: >-
          A list of type-specific overrides in the following format:

          <code>"objectType=accessValue|objectType=accessValue"</code>
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: >-
          A string including the following options:


          <ul>

          <li><b>workflowLevel</b> —valid values for this option are:


          <ul>

          <li><i>None</i> —changes made by the user or group take effect

          immediately.</li>


          <li><i>Recommend</i> —changes made by the user or group are saved as

          change requests and must be reviewed and approved before they take

          effect.</li>


          <li><i>Approve</i> —changes made by the user or group take effect

          immediately and the user or group can approve change requests from other

          users or groups.</li>

          </ul>

          </li>


          <li><b>deploymentAllowed</b> —either <i>true</i> or <i>false</i>, to indicate

          whether or not the user or group can perform a full deployment of data

          from the configuration to a managed server.</li>


          <li><b>quickDeploymentAllowed</b> —either <i>true</i> or <i>false</i>, to

          indicate whether or not the user or group can instantly deploy changed

          DNS resource records.</li>

          </ul>


          <note>

          <ul>

          <li>All of these properties are optional.</li>


          <li>The <b>deploymentAllowedproperty</b> is applicable only for

          configuration, server, or root with <i>Full</i> access rights.</li>


          <li>The <b>workflowLevelproperty</b> is applicable only for

          <i>Change</i>, <i>Add</i>, or <i>Full</i> access rights.</li>

          </ul>

          </note>
        style: form
        explode: true
        schema:
          type: string
      - name: userId
        in: query
        description: The object ID of the user to whom this access right applies.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: value
        in: query
        description: >-
          The value of the access right being added. Valid values for this

          parameter are listed in the <xref href= "../reference/ref_api_constants_access_right_values.dita"/> table.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Returns the object ID for the new access right.
          headers: {}
          content:
            application/json:
              schema:
                type: number
                format: double
      deprecated: false
  /v1/addDevice:
    post:
      tags:
      - bam_object_methods
      summary: addDevice
      description: Adds a device to a configuration.
      operationId: addDevice
      parameters:
      - name: configurationId
        in: query
        description: The object ID of the configuration in which the device is to be located.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: deviceSubtypeId
        in: query
        description: >-
          The object ID of the device sub-type with which the device is associated.

          The value can be 0 if you do not wish to associate a device sub-type to

          the device you are adding.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: deviceTypeId
        in: query
        description: >-
          The object ID of the device type with which the device is associated. The

          value can be 0 if you do not wish to associate a device type to the

          device you are adding.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: ip4Addresses
        in: query
        description: >-
          One or more IPv4 addresses to which the device is assigned. Specify

          multiple addresses in a comma-delimited list.
        style: form
        explode: true
        schema:
          type: string
      - name: ip6Addresses
        in: query
        description: >-
          One or more IPv6 addresses to which the device is assigned. Specify

          multiple addresses in a comma-delimited list.
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: The descriptive name of the device.
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: Adds object properties, including user-defined fields.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Returns the object ID of the new device.
          headers: {}
          content:
            application/json:
              schema:
                type: number
                format: double
      deprecated: false
  /v1/addDeviceSubtype:
    post:
      tags:
      - bam_object_methods
      summary: addDeviceSubtype
      description: >-
        Adds a device sub-type to Address Manager. Use device types and device

        sub-types to categorize and organize devices on the network.
      operationId: addDeviceSubtype
      parameters:
      - name: name
        in: query
        description: The descriptive name for the device sub-type.
        style: form
        explode: true
        schema:
          type: string
      - name: parentId
        in: query
        description: The object ID of the parent device type object.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: properties
        in: query
        description: Adds object properties, including user-defined fields.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Returns the object ID of the new device sub-type.
          headers: {}
          content:
            application/json:
              schema:
                type: number
                format: double
      deprecated: false
  /v1/addDeviceType:
    post:
      tags:
      - bam_object_methods
      summary: addDeviceType
      description: >-
        Adds a device type to Address Manager. Use device types and device sub-types

        to categorize and organize devices on the network.
      operationId: addDeviceType
      parameters:
      - name: name
        in: query
        description: The descriptive name for the device type.
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: Adds object properties, including user-defined fields.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Returns the object ID of the new device type.
          headers: {}
          content:
            application/json:
              schema:
                type: number
                format: double
      deprecated: false
  /v1/addMACAddress:
    post:
      tags:
      - bam_object_methods
      summary: addMACAddress
      description: Adds MAC addresses.
      operationId: addMACAddress
      parameters:
      - name: configurationId
        in: query
        description: The object ID of the parent configuration in which the MAC address resides.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: macAddress
        in: query
        description: >-
          The MAC address in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn, or

          nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value.
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: >-
          Adds object properties, including the name, MAC Pool ID macPool, and

          user-defined fields.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Returns the object ID for the new MAC address.
          headers: {}
          content:
            application/json:
              schema:
                type: number
                format: double
      deprecated: false
  /v1/addTag:
    post:
      tags:
      - bam_object_methods
      summary: addTag
      description: Adds object tags.
      operationId: addTag
      parameters:
      - name: name
        in: query
        description: The name of the object tag.
        style: form
        explode: true
        schema:
          type: string
      - name: parentId
        in: query
        description: >-
          The object ID of the parent for this object tag. The parent is either an

          object tag or an object tag group.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: properties
        in: query
        description: Adds object properties, including user-defined fields.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Returns the object ID for the new object tag.
          headers: {}
          content:
            application/json:
              schema:
                type: number
                format: double
      deprecated: false
  /v1/addTagGroup:
    post:
      tags:
      - bam_object_methods
      summary: addTagGroup
      description: Adds object tag groups.
      operationId: addTagGroup
      parameters:
      - name: name
        in: query
        description: The name of the tag group.
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: Adds object properties, including user-defined fields.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Returns the object ID for the new tag group.
          headers: {}
          content:
            application/json:
              schema:
                type: number
                format: double
      deprecated: false
  /v1/addUser:
    post:
      tags:
      - bam_object_methods
      summary: addUser
      description: Adds Address Manager users.
      operationId: addUser
      parameters:
      - name: password
        in: query
        description: >-
          The Address Manager password for the user. The password must be set even

          if the authenticator property option is defined.
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: >-
          A string containing user-defined fields and options listed in <i>List of

          options</i>. You can separate multiple property values with

          pipe character (|), for example, <i>my $properties = “email=$email

          phoneNumber=$tel authenticator=1368969 userAccessType=$accessType”</i>

          <note>You must add a pipe character at the end of the properties string.</note>
        style: form
        explode: true
        schema:
          type: string
      - name: username
        in: query
        description: The name of the user.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Returns the object ID for the new Address Manager user.
          headers: {}
          content:
            application/json:
              schema:
                type: number
                format: double
      deprecated: false
  /v1/addUserGroup:
    post:
      tags:
      - bam_object_methods
      summary: addUserGroup
      description: Adds user groups.
      operationId: addUserGroup
      parameters:
      - name: name
        in: query
        description: The name of the user group.
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: >-
          A string including the following option:


          <p>

          <ul>

          <li><b>isAdministrator</b> —either <i>true</i> or <i>false</i>, to indicate

          whether or not you wish to add an administrator user group to Address Manager.</li>

          </ul>

          </p>
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Returns the object ID for the new Address Manager user group.
          headers: {}
          content:
            application/json:
              schema:
                type: number
                format: double
      deprecated: false
  /v1/associateMACAddressWithPool:
    post:
      tags:
      - bam_object_methods
      summary: associateMACAddressWithPool
      description: Associates a MAC address with a MAC pool.
      operationId: associateMACAddressWithPool
      parameters:
      - name: configurationId
        in: query
        description: >-
          The object ID of the parent configuration in which the MAC address

          resides.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: macAddress
        in: query
        description: >-
          The MAC address in the format <b>nnnnnnnnnnnn</b>,

          <b>nn-nn-nn-nn-nn-nn</b>, or <b>nn:nn:nn:nn:nn:nn</b>, where nn is a

          hexadecimal value.
        style: form
        explode: true
        schema:
          type: string
      - name: poolId
        in: query
        description: The object ID of the MAC pool with which this MAC address is associated.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      responses:
        '201':
          description: None.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /v1/breakReplication:
    post:
      tags:
      - bam_object_methods
      summary: breakReplication
      description: Breaks replication and returns each server to its original stand-alone state.
      operationId: breakReplication
      parameters: []
      responses:
        '201':
          description: None.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /v1/configureStreamingReplication:
    post:
      tags:
      - bam_object_methods
      summary: configureStreamingReplication
      description: >-
        Enables database replication on a remote system in order to automate the

        setup of replication between two or three Address Manager systems. This API

        method must be run against the Address Manager system that will be primary.
      operationId: configureStreamingReplication
      parameters:
      - name: compressReplication
        in: query
        description: >-
          The boolean value. Set to <b>true</b> to compress the database

          replication files. <note>Compressing database replication files is a

          resource-intensive process that might affect system performance. Use

          caution when performing this action. By default, the compressReplication

          parameter is disabled.</note>
        style: form
        explode: true
        schema:
          type: boolean
      - name: latencyCriticalThreshold
        in: query
        description: >-
          A value to specify the threshold size of the replication break in seconds

          (sec). Valid values for this parameter range from 0 to any positive value.

          By default, the latencyCriticalThreshold parameter is set to 86400

          seconds.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: latencyWarningThreshold
        in: query
        description: >-
          A value to specify the threshold size of the replication directory in

          seconds (sec). Valid values for this parameter range from 0 to any

          positive value. By default, the latencyWarningThreshold parameter is set

          to 3600 seconds.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: properties
        in: query
        description: >-
          A string including the following option:


          <ul>

          <li><b>secondStandbyServer</b> —Used to add an additional standby

          server. The server's IP address is required. <note>When adding a standby

          server, the server cannot be part of an existing database replication

          environment or a removed standby server. You can only add a standby

          server if it is operating as a Standalone server. If you attempt to add a

          standby server that is not operating as a Standalone server, the

          following message is returned:

          <code>An error was encountered while configuring replication, Server

          <i>&lt;server_IP&gt;</i> is not a standalone server</code></note></li>

          </ul>
        style: form
        explode: true
        schema:
          type: string
      - name: standbyServer
        in: query
        description: >-
          The IP address of the standby server.


          <note>

          <ul>

          <li>To configure replication in Address Manager, you must have a standby

          server. An additional standby server can be added by using the

          secondStandbyServer property.</li>

          <li>When adding a standby server, the server cannot be part of an

          existing database replication environment or a removed standby server.

          You can only add a standby server if it is operating as a standalone

          server. If you attempt to add a standby server that is not operating as a

          standalone server, the following message is returned:

          <code>An error was encountered while configuring replication, Server

          <i>&lt;server_IP&gt;</i> is not a standalone server</code></li>

          </ul>

          </note>
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: None.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /v1/deleteAccessRight:
    delete:
      tags:
      - bam_object_methods
      summary: deleteAccessRight
      description: Deletes an access right for a specified object.
      operationId: deleteAccessRight
      parameters:
      - name: entityId
        in: query
        description: The object ID of the entity to which the access right is assigned.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: userId
        in: query
        description: The object ID of the user to whom this access right is applied.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: None.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /v1/denyMACAddress:
    put:
      tags:
      - bam_object_methods
      summary: denyMACAddress
      description: Denies MAC addresses.
      operationId: denyMACAddress
      parameters:
      - name: configurationId
        in: query
        description: >-
          The object ID of the parent configuration in which the MAC address

          resides.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: macAddress
        in: query
        description: >-
          The MAC address in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn or

          nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '204':
          description: None.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /v1/establishTrustRelationship:
    post:
      tags:
      - bam_object_methods
      summary: establishTrustRelationship
      description: >-
        Establishes a trust relationship between a maximum of three Address Manager

        servers, which is a prerequisite for configuring replication in Address

        Manager.
      operationId: establishTrustRelationship
      parameters:
      - name: password
        in: query
        description: The password for the API user logging into Address Manager.
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: Reserved for future use.
        style: form
        explode: true
        schema:
          type: string
      - name: remoteIP
        in: query
        description: >-
          The IP address of the standby server. <note>The standby server must be

          accessible from the primary server and must have database access from the

          primary server. To enable database access, refer to the Configuring

          database replication section in the <i>Address Manager Administration

          Guide</i>.</note>
        style: form
        explode: true
        schema:
          type: string
      - name: username
        in: query
        description: >-
          The username for the API user created using the Address Manager

          interface.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: None.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /v1/failoverReplication:
    post:
      tags:
      - bam_object_methods
      summary: failoverReplication
      description: Performs a manual replication failover.
      operationId: failoverReplication
      parameters:
      - name: properties
        in: query
        description: >-
          A string that includes the following option:


          <ul>

          <li><b>forceFailover</b> —either <i>true</i> or

          <i>false</i>; to indicate whether or not a forced failover will

          be performed. <note>If the latency of the database replication of the

          server relative to the Primary server is greater than 0, a forced

          failover can be performed.</note></li>

          </ul>
        style: form
        explode: true
        schema:
          type: string
      - name: standbyServer
        in: query
        description: >-
          The IP address of the standby server, which will become the primary BAM

          server once a failover has been performed.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: Performs a manual replication failover.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /v1/getAccessRight:
    get:
      tags:
      - bam_object_methods
      summary: getAccessRight
      description: Retrieves an access right for a specified object.
      operationId: getAccessRight
      parameters:
      - name: entityId
        in: query
        description: The object ID of the entity to which the access right is assigned.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: userId
        in: query
        description: The object ID of the user to whom the access right is applied.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns the access right for the specified object.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/APIAccessRight'
                - description: This class controls Access Right objects.
      deprecated: false
  /v1/getAccessRightsForEntity:
    get:
      tags:
      - bam_object_methods
      summary: getAccessRightsForEntity
      description: Returns an array of access rights for entities.
      operationId: getAccessRightsForEntity
      parameters:
      - name: count
        in: query
        description: The maximum number of access right child objects to return.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: entityId
        in: query
        description: The object ID of the entity whose access rights are returned.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: start
        in: query
        description: >-
          Indicates where in the list of child access right objects to start

          returning objects. The list begins at an index of 0.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Returns an array of access right objects.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIAccessRight'
                description: ''
      deprecated: false
  /v1/getAccessRightsForUser:
    get:
      tags:
      - bam_object_methods
      summary: getAccessRightsForUser
      description: Returns an array of access rights for a specified user.
      operationId: getAccessRightsForUser
      parameters:
      - name: count
        in: query
        description: The maximum number of access right child objects to return.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: start
        in: query
        description: >-
          Indicates where in the list of child access right objects to start

          returning objects. The list begins at an index of 0.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: userId
        in: query
        description: The object ID of the user whose access rights are returned.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Returns an array of access right objects.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIAccessRight'
                description: ''
      deprecated: false
  /v1/getAllUsedLocations:
    get:
      tags:
      - bam_object_methods
      summary: getAllUsedLocations
      description: >-
        Returns a list of location objects that are used to annotate

        other objects.
      operationId: getAllUsedLocations
      parameters: []
      responses:
        '200':
          description: Returns an array of location APIEntity objects.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntity'
                description: ''
      deprecated: false
  /v1/getConfigurationGroups:
    get:
      tags:
      - bam_object_methods
      summary: getConfigurationGroups
      description: Gets a list of all configuration groups in Address Manager.
      operationId: getConfigurationGroups
      parameters: []
      responses:
        '200':
          description: Returns a list of configuration groups.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: ''
      deprecated: false
  /v1/getConfigurationSetting:
    get:
      tags:
      - bam_object_methods
      summary: getConfigurationSetting
      description: Returns the configuration setting.
      operationId: getConfigurationSetting
      parameters:
      - name: configurationId
        in: query
        description: The object ID of the configuration in which the setting is to be located.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: settingName
        in: query
        description: >-
          The name of the specific setting to be read. Only the <i>option

          inheritance


          OPTION_INHERITANCE</i> setting is supported.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the properties of the setting of the configuration.
          headers: {}
          content:
            application/json:
              schema:
                type: string
      deprecated: false
  /v1/getConfigurationsByGroup:
    get:
      tags:
      - bam_object_methods
      summary: getConfigurationsByGroup
      description: >-
        Gets a list of configurations in Address Manager based on the name of a

        configuration group.
      operationId: getConfigurationsByGroup
      parameters:
      - name: groupName
        in: query
        description: >-
          The name of the configuration group in which the configurations

          are to be located. <note>Configuration group names are case

          sensitive.</note>
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: This is reserved for future use.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Returns a list of configurations based on the specified group.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntity'
                description: ''
      deprecated: false
  /v1/getLocationByCode:
    get:
      tags:
      - bam_object_methods
      summary: getLocationByCode
      description: >-
        Returns the location object with the specified hierarchical

        location code.
      operationId: getLocationByCode
      parameters:
      - name: code
        in: query
        description: >-
          The hierarchical location code consists of a set of 1 to 3 alpha-numeric

          strings separated by a space. The first two characters indicate a

          country, followed by next three characters which indicate a city in

          UN/LOCODE. New custom locations created under a UN/LOCODE city are

          appended to the end of the hierarchy. For example, <b>CA TOR OF1</b>

          indicates:


          <ul>

          <li><b>CA</b> —Canada</li>


          <li><b>TOR</b> —Toronto</li>


          <li><b>OF1</b> —Office 1</li>

          </ul>

          <note>The code is case-sensitive. It must be all <b>UPPER CASE</b>

          letters.

          <p>

          The county code and child location code should be alphanumeric strings.

          </p>

          </note>
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the entity that matches the specified hierarchical location code. If no entity is found, returns an <i>empty APIEntity</i>.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/APIEntity'
                - description: >-
                    This class represents all entities except options, roles, and access rights. It

                    manages all other types by passing the values for the object as a delimited

                    properties string of name–value pairs. The properties for each object are listed in <xref

                    href="../topic/top_bam_api_method_introduction.dita"/>.
      deprecated: false
  /v1/getMACAddress:
    get:
      tags:
      - bam_object_methods
      summary: getMACAddress
      description: Returns an APIEntity for a MAC address.
      operationId: getMACAddress
      parameters:
      - name: configurationId
        in: query
        description: The object ID of the configuration in which the MAC address is located.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: macAddress
        in: query
        description: >-
          The MAC address in the format nnnnnnnnnnnn, nn-nn-nn-nn-nn-nn or

          nn:nn:nn:nn:nn:nn, where nn is a hexadecimal value.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Returns an APIEntity for the MAC address. Returns an empty APIEntity if the MAC address does not exist.
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/APIEntity'
                - description: >-
                    This class represents all entities except options, roles, and access rights. It

                    manages all other types by passing the values for the object as a delimited

                    properties string of name–value pairs. The properties for each object are listed in <xref

                    href="../topic/top_bam_api_method_introduction.dita"/>.
      deprecated: false
  /v1/getReplicationInfo:
    get:
      tags:
      - bam_object_methods
      summary: getReplicationInfo
      description: >-
        Retrieves information regarding the status of replication in Address Manager

        through the API.
      operationId: getReplicationInfo
      parameters:
      - name: properties
        in: query
        description: Reserved for future use.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Returns a JSON string containing the hostname, status of replication, latency, the IP address of the Primary and standby servers, and cluster information.
          headers: {}
          content:
            application/json:
              schema:
                type: string
      deprecated: false
  /v1/purgeHistoryNow:
    put:
      tags:
      - bam_object_methods
      summary: purgeHistoryNow
      description: Runs the history purge function.
      operationId: purgeHistoryNow
      parameters:
      - name: numberOfDaysToKeep
        in: query
        description: >-
          The number of days for which the data will be preserved in the database.

          The valid value for this parameter is between 1 and 3650. Set this

          parameter to -1 if you are using either <b>untilWhenTimestamp</b>

          or <b>numberOfMonthsToKeep</b>. Using this parameter will

          archive all history that will be purged and overwrite existing archive

          files in the <b>/data/Archive</b> directory.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: numberOfMonthsToKeep
        in: query
        description: >-
          The number of months for which the data will be preserved in the

          database. The valid value for this parameter is between 0 to infinite

          months. Set this parameter to -1 if you are using either

          <b>untilWhenTimestamp</b> or <b>numberOfDaysToKeep</b>.

          Using this parameter will not archive any data.
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: untilWhenTimestamp
        in: query
        description: >-
          The string specifying the point in time after which history is to be

          preserved. The valid timestamp pattern is <i>YYYY-MM[-DD[

          HH:MM:SS[.mmm]]]</i>. Set this parameter with an empty string "" if you

          are using either <b>numbeOfDaysToKeep</b> or

          <b>numberOfMonthsToKeep</b>. Using this parameter will not

          archive any data.
        style: form
        explode: true
        schema:
          type: string
      - name: waitOption
        in: query
        description: >-
          The Boolean value. If set to <b>true</b>, the purge will be

          performed and the result will be returned when completed. The default

          value is <b>false</b>.
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '204':
          description: Returns 0 (zero) when the purge service has successfully completed.
          headers: {}
          content:
            application/json:
              schema:
                type: number
                format: double
      deprecated: false
  /v1/removeTrustRelationship:
    post:
      tags:
      - bam_object_methods
      summary: removeTrustRelationship
      description: >-
        Removes a remote Address Manager server from the trust relationship.


        You can remove Address Manager servers within the trust relationship one at a

        time.
      operationId: removeTrustRelationship
      parameters:
      - name: otherBAMIP
        in: query
        description: >-
          The IP address of the standby server. <note>If the Address Manager server is in

          replication, you must first remove it from replication in order to remove it from the trust relationship.</note>
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: Reserved for future use.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: None.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /v1/terminateUserSessions:
    post:
      tags:
      - bam_object_methods
      summary: terminateUserSessions
      description: Terminates all active user sessions in Address Manager.
      operationId: terminateUserSessions
      parameters:
      - name: properties
        in: query
        description: Reserved for future use.
        style: form
        explode: true
        schema:
          type: string
      - name: username
        in: query
        description: The username of the user for which all active sessions are terminated.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '201':
          description: None.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
            application/xml:
              schema:
                type: string
                format: binary
                xml:
                  name: response
                  attribute: false
                  wrapped: false
      deprecated: false
  /v1/updateAccessRight:
    put:
      tags:
      - bam_object_methods
      summary: updateAccessRight
      description: Updates access rights for a specified object.
      operationId: updateAccessRight
      parameters:
      - name: entityId
        in: query
        description: The object ID of the entity to which the access right is assigned.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: overrides
        in: query
        description: >-
          A list of potentially modified type-specific overrides in the following

          format: <code>"objectType=accessValue|objectType=accessValue"</code>
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: >-
          A string including the following options:


          <ul>

          <li><b>workflowLevel</b> —valid values for this option are as

          follows:


          <ul>

          <li><b>None</b> —changes made by the user or group take effect

          immediately.</li>


          <li><b>Recommend</b> —changes made by the user or group are saved as

          change requests and must be reviewed and approved before they take

          effect.</li>


          <li><b>Approve</b> —changes made by the user or group take effect

          immediately and the user or group can approve change requests from other

          users or groups.</li>

          </ul>

          </li>


          <li>deploymentAllowed—either <i>true</i> or <i>false</i>;

          to indicate whether or not the user or group can perform a full

          deployment of data from the configuration to a managed server</li>


          <li>quickDeploymentAllowed—either <i>true</i> or

          <i>false</i>; to indicate whether or not the user or group can

          instantly deploy changed DNS resource records.perform a full deployment

          of data from the configuration to a managed server.</li>

          </ul>


          <note>

          <ul>

          <li>All of these properties are <i>optional</i>.</li>


          <li>The <b>deploymentAllowed</b> property is applicable only for

          configuration, server or root with <i>Full</i> access.</li>


          <li>The <b>workflowLevel</b> property is applicable only for

          <i>Change</i>, <i>Add</i>, or <i>Full</i> access rights.</li>

          </ul>

          </note>
        style: form
        explode: true
        schema:
          type: string
      - name: userId
        in: query
        description: >-
          The object ID of the user to whom the access right is assigned. This

          value is not mutable.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: value
        in: query
        description: >-
          The new value for the access right. Valid entries are listed in

          <xref href="../reference/ref_api_constants_access_right_values.dita" />.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '204':
          description: None.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /v1/updateConfigurationSetting:
    put:
      tags:
      - bam_object_methods
      summary: updateConfigurationSetting
      description: Updates the configuration setting.
      operationId: updateConfigurationSetting
      parameters:
      - name: configurationId
        in: query
        description: The object ID of the configuration in which the setting is to be located.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: properties
        in: query
        description: >-
          The new properties of the configuration setting to be updated. Only the

          <i>disable DNS option inheritance disableDnsOptionInheritance</i>

          property is supported. If set to <b>true</b>, DNS options that

          have been configured on a zone are not inherited by the child zone. In

          the reverse space, DNS options that have been configured on a block are

          not inherited by the child block or network.


          <note>

          <ul>

          <li>Disabling DNS option inheritance only affect options attached to a

          zone or block and the inheritance of those options by child zones,

          blocks, or networks.</li>


          <li>You cannot disable the inheritance of DNS options that are attached

          to a configuration, view, or server. These DNS options will continue to

          be inherited by all zones, blocks, or networks found under the

          object.</li>

          </ul>

          </note>
        style: form
        explode: true
        schema:
          type: string
      - name: settingName
        in: query
        description: >-
          The name of the specific setting to be read. Only the <i>option

          inheritance


          OPTION_INHERITANCE</i> setting is supported.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '204':
          description: Update the configuration setting.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
      deprecated: false
  /v1/updateUserPassword:
    put:
      tags:
      - bam_object_methods
      summary: updateUserPassword
      description: >-
        Updates an Address Manager user password.


        You must be an Address Manager administrator to invoke this method.
      operationId: updateUserPassword
      parameters:
      - name: newPassword
        in: query
        description: The new password for the user.
        style: form
        explode: true
        schema:
          type: string
      - name: options
        in: query
        description: Reserved for future use.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: userId
        in: query
        description: >-
          The user ID of an application user who is either a primary or a secondary

          authenticator.
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: None.
          headers: {}
          content:
            application/json:
              schema:
                type: string
                format: binary
            application/xml:
              schema: