@itentialopensource/adapter-bluecat

{ "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\nto zero (0) if you are adding the access right to the root level default\naccess 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:\n<code>\"objectType=accessValue|objectType=accessValue\"</code>", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "properties", "in": "query", "description": "A string including the following options:\n\n<ul>\n<li>workflowLevel —valid values for this option are:\n\n<ul>\n<li>None —changes made by the user or group take effect\nimmediately.</li>\n\n<li>Recommend —changes made by the user or group are saved as\nchange requests and must be reviewed and approved before they take\neffect.</li>\n\n<li>Approve —changes made by the user or group take effect\nimmediately and the user or group can approve change requests from other\nusers or groups.</li>\n</ul>\n</li>\n\n<li>deploymentAllowed —either true or false, to indicate\nwhether or not the user or group can perform a full deployment of data\nfrom the configuration to a managed server.</li>\n\n<li>quickDeploymentAllowed —either true or false, to\nindicate whether or not the user or group can instantly deploy changed\nDNS resource records.</li>\n</ul>\n\n<note>\n<ul>\n<li>All of these properties are optional.</li>\n\n<li>The deploymentAllowedproperty is applicable only for\nconfiguration, server, or root with Full access rights.</li>\n\n<li>The workflowLevelproperty is applicable only for\nChange, Add, or Full access rights.</li>\n</ul>\n</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\nparameter 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.\nThe value can be 0 if you do not wish to associate a device sub-type to\nthe 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\nvalue can be 0 if you do not wish to associate a device type to the\ndevice 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\nmultiple 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\nmultiple 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\nsub-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\nto 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\nnn: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\nuser-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\nobject 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\nif 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 List of\noptions. You can separate multiple property values with\npipe character (|), for example, my $properties = “email=$email\nphoneNumber=$tel authenticator=1368969 userAccessType=$accessType”\n<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:\n\n\n<ul>\n<li>isAdministrator —either true or false, to indicate\nwhether or not you wish to add an administrator user group to Address Manager.</li>\n</ul>\n", "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\nresides.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "macAddress", "in": "query", "description": "The MAC address in the format nnnnnnnnnnnn,\nnn-nn-nn-nn-nn-nn, or nn:nn:nn:nn:nn:nn, where nn is a\nhexadecimal 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\nsetup of replication between two or three Address Manager systems. This API\nmethod 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 true to compress the database\nreplication files. <note>Compressing database replication files is a\nresource-intensive process that might affect system performance. Use\ncaution when performing this action. By default, the compressReplication\nparameter 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\n(sec). Valid values for this parameter range from 0 to any positive value.\nBy default, the latencyCriticalThreshold parameter is set to 86400\nseconds.", "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\nseconds (sec). Valid values for this parameter range from 0 to any\npositive value. By default, the latencyWarningThreshold parameter is set\nto 3600 seconds.", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "properties", "in": "query", "description": "A string including the following option:\n\n<ul>\n<li>secondStandbyServer —Used to add an additional standby\nserver. The server's IP address is required. <note>When adding a standby\nserver, the server cannot be part of an existing database replication\nenvironment or a removed standby server. You can only add a standby\nserver if it is operating as a Standalone server. If you attempt to add a\nstandby server that is not operating as a Standalone server, the\nfollowing message is returned:\n<code>An error was encountered while configuring replication, Server\n<server_IP> is not a standalone server</code></note></li>\n</ul>", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "standbyServer", "in": "query", "description": "The IP address of the standby server.\n\n<note>\n<ul>\n<li>To configure replication in Address Manager, you must have a standby\nserver. An additional standby server can be added by using the\nsecondStandbyServer property.</li>\n<li>When adding a standby server, the server cannot be part of an\nexisting database replication environment or a removed standby server.\nYou can only add a standby server if it is operating as a standalone\nserver. If you attempt to add a standby server that is not operating as a\nstandalone server, the following message is returned:\n<code>An error was encountered while configuring replication, Server\n<server_IP> is not a standalone server</code></li>\n</ul>\n</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\nresides.", "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\nnn: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\nservers, which is a prerequisite for configuring replication in Address\nManager.", "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\naccessible from the primary server and must have database access from the\nprimary server. To enable database access, refer to the Configuring\ndatabase replication section in the Address Manager Administration\nGuide.</note>", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "The username for the API user created using the Address Manager\ninterface.", "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:\n\n<ul>\n<li>forceFailover —either true or\nfalse; to indicate whether or not a forced failover will\nbe performed. <note>If the latency of the database replication of the\nserver relative to the Primary server is greater than 0, a forced\nfailover can be performed.</note></li>\n</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\nserver 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": { "$ref": "#/components/schemas/APIAccessRight" } } } } }, "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\nreturning 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\nreturning 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\nother 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 option\ninheritance\n\nOPTION_INHERITANCE 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\nconfiguration group.", "operationId": "getConfigurationsByGroup", "parameters": [ { "name": "groupName", "in": "query", "description": "The name of the configuration group in which the configurations\nare to be located. <note>Configuration group names are case\nsensitive.</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\nlocation code.", "operationId": "getLocationByCode", "parameters": [ { "name": "code", "in": "query", "description": "The hierarchical location code consists of a set of 1 to 3 alpha-numeric\nstrings separated by a space. The first two characters indicate a\ncountry, followed by next three characters which indicate a city in\nUN/LOCODE. New custom locations created under a UN/LOCODE city are\nappended to the end of the hierarchy. For example, CA TOR OF1\nindicates:\n\n<ul>\n<li>CA —Canada</li>\n\n<li>TOR —Toronto</li>\n\n<li>OF1 —Office 1</li>\n</ul>\n<note>The code is case-sensitive. It must be all UPPER CASE\nletters.\n\nThe county code and child location code should be alphanumeric strings.\n\n</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 empty APIEntity.", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEntity" } } } } }, "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\nnn: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": { "$ref": "#/components/schemas/APIEntity" } } } } }, "deprecated": false } }, "/v1/getReplicationInfo": { "get": { "tags": [ "bam_object_methods" ], "summary": "getReplicationInfo", "description": "Retrieves information regarding the status of replication in Address Manager\nthrough 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.\nThe valid value for this parameter is between 1 and 3650. Set this\nparameter to -1 if you are using either untilWhenTimestamp\nor numberOfMonthsToKeep. Using this parameter will\narchive all history that will be purged and overwrite existing archive\nfiles in the /data/Archive 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\ndatabase. The valid value for this parameter is between 0 to infinite\nmonths. Set this parameter to -1 if you are using either\nuntilWhenTimestamp or numberOfDaysToKeep.\nUsing 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\npreserved. The valid timestamp pattern is YYYY-MM[-DD[\nHH:MM:SS[.mmm]]]. Set this parameter with an empty string \"\" if you\nare using either numbeOfDaysToKeep or\nnumberOfMonthsToKeep. Using this parameter will not\narchive any data.", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "waitOption", "in": "query", "description": "The Boolean value. If set to true, the purge will be\nperformed and the result will be returned when completed. The default\nvalue is false.", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "204": {