@itentialopensource/adapter-bluecat
Version:
This adapter integrates with system described as: BlueCat ProteusAPI.
1,342 lines • 469 kB
JSON
{
"swagger": "2.0",
"info" : {
"version" : "9.2.0-919.GA.bcn@release-9.2#caa46e7d0c5f70ca0abedd2af01bf51ea596cb16 built 2020-04-15 22:42:24Z",
"title" : "BAM REST API"
},
"schemes" : [],
"tags" : [
{
"name" : "bam_object_methods"
}
,
{
"name" : "data_collection_methods"
}
,
{
"name" : "dhcp_methods"
}
,
{
"name" : "dns_methods"
}
,
{
"name" : "generic_deployment_option_methods"
}
,
{
"name" : "generic_methods"
}
,
{
"name" : "ipam_methods"
}
,
{
"name" : "migration_methods"
}
,
{
"name" : "server_deployment_methods"
}
,
{
"name" : "tftp_methods"
}
,
{
"name" : "udf_methods"
}
,
{
"name" : "undocumented"
}
,
{
"name" : "xha_methods"
}
],
"definitions" : {
"json_APIAccessRight" : {
"type" : "object",
"title" : "APIAccessRight",
"properties" : {
"entityId" : {
"readOnly" : false,
"description" : "The database ID of the object to which the access right\napplies. This value must be greater than 0.",
"type" : "integer",
"format" : "int64"
},
"userId" : {
"readOnly" : false,
"description" : "The database ID of the owner of the access right. This\nvalue must be greater than 0.",
"type" : "integer",
"format" : "int64"
},
"value" : {
"readOnly" : false,
"description" : "The default access right (HIDE, VIEW, ADD, CHANGE, or\nFULL). This field cannot be null.",
"type" : "string"
},
"overrides" : {
"readOnly" : false,
"description" : "Indicates the types that are to be overridden in the\naccess right in the format\n<i>objectType=accessRightValue<\/i> where\n<i>objectType<\/i> is the same object type used in\nAPIEntity and <i>accessRightValue<\/i> is one of HIDE, VIEW,\nADD, CHANGE or FULL. Multiple override elements are\nseparated by a | (pipe) character.",
"type" : "string"
},
"properties" : {
"readOnly" : false,
"description" : "A string containing extra properties for the object in\nthe format <i>attribute=value<\/i>.",
"type" : "string"
}
},
"example" : {
"entityId" : 12345,
"userId" : 12345,
"value" : "...",
"overrides" : "...",
"properties" : "..."
},
"description" : "This class controls Access Right objects."
}
,
"json_APIData" : {
"type" : "object",
"title" : "APIData",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "The name of the probe to collect data. Values are\nNETWORK_BLOOM or LEASE_COUNT_PER_DATE.",
"type" : "string"
},
"properties" : {
"readOnly" : false,
"description" : "A string containing extra properties for the object in\nthe format <i>attribute: value<\/i>.",
"type" : "string"
}
},
"example" : {
"name" : "...",
"properties" : "..."
},
"description" : "API Data with a timestamp."
}
,
"json_APIDeploymentOption" : {
"type" : "object",
"title" : "APIDeploymentOption",
"properties" : {
"id" : {
"readOnly" : false,
"description" : "The database ID of the option in Address Manager.",
"type" : "integer",
"format" : "int64"
},
"type" : {
"readOnly" : false,
"description" : "The option type listed in <xref\nkeyref=\"bam.api.constants.option.types\">Option\nTypes<\/xref>. This field cannot be null.",
"type" : "string"
},
"name" : {
"readOnly" : false,
"description" : "The name of the option.",
"type" : "string"
},
"value" : {
"readOnly" : false,
"description" : "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type" : "string"
},
"properties" : {
"readOnly" : false,
"description" : "A string containing additional properties. This is used\nfor user-defined fields on most objects, but also passes\nsome values that do not have their own specific\nparameter.",
"type" : "string"
}
},
"example" : {
"id" : 12345,
"type" : "...",
"name" : "...",
"value" : "...",
"properties" : "..."
},
"description" : "Deployment options configure both DHCP and DNS services on the network. They are\navailable as DHCP client and service options, including standard DNS options.\nDeployment options support the standard object functions."
}
,
"json_APIDeploymentRole" : {
"type" : "object",
"title" : "APIDeploymentRole",
"properties" : {
"id" : {
"readOnly" : false,
"description" : "The database ID of the deployment role in Address Manager.",
"type" : "integer",
"format" : "int64"
},
"type" : {
"readOnly" : false,
"description" : "The type of the role (NONE, MASTER, MASTER_HIDDEN, SLAVE,\nSLAVE_STEALTH, FORWARDER, STUB, RECURSION, PEER, or AD\nMASTER). This field cannot be null.",
"type" : "string"
},
"service" : {
"readOnly" : false,
"description" : "DNS, DHCP, or TFTP. This field cannot be null.",
"type" : "string"
},
"entityId" : {
"readOnly" : false,
"description" : "The database ID of the entity. This value must be greater\nthan 0.",
"type" : "integer",
"format" : "int64"
},
"serverInterfaceId" : {
"readOnly" : false,
"description" : "The database ID of the sever interface. This value must\nbe greater than 0.",
"type" : "integer",
"format" : "int64"
},
"properties" : {
"readOnly" : false,
"description" : "A string containing extra properties for the object in\nthe format <i>attribute=value<\/i>. This field can be null if\nused for forward space. A ViewId property must be provided\nto assign DNS Roles to a Network or Block for a particular\nDNS View (reverse space). Multiple properties are separated\nby a | (pipe) character.",
"type" : "string"
}
},
"example" : {
"id" : 12345,
"type" : "...",
"service" : "...",
"entityId" : 12345,
"serverInterfaceId" : 12345,
"properties" : "..."
},
"description" : "Manages the deployment roles that control the services provided by Address\nManager-managed servers. These objects support the standard object\nfunctions."
}
,
"json_APIEntity" : {
"type" : "object",
"title" : "APIEntity",
"properties" : {
"id" : {
"readOnly" : false,
"description" : "The database ID of the object in Address Manager.",
"type" : "integer",
"format" : "int64"
},
"name" : {
"readOnly" : false,
"description" : "The field name, which might be null.",
"type" : "string"
},
"type" : {
"readOnly" : false,
"description" : "The class name of the object. For example, a\nconfiguration object has a type equal to\n<b>Configuration<\/b>. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type" : "string"
},
"properties" : {
"readOnly" : false,
"description" : "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as <b>ttl=123|comments=my\ncomment|<\/b>. This field can be null.",
"type" : "string"
}
},
"example" : {
"id" : 12345,
"name" : "...",
"type" : "...",
"properties" : "..."
},
"description" : "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in <xref\nhref=\"../topic/top_bam_api_method_introduction.dita\"/>."
}
,
"json_APIUserDefinedField" : {
"type" : "object",
"title" : "APIUserDefinedField",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "The internal name of the user-defined field.",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"description" : "The name of the user-defined field that appears to users in the\nAddress Manager interface.",
"type" : "string"
},
"type" : {
"readOnly" : false,
"description" : "The type of the user-defined field. Types are available\nas constants in the <i>UserDefinedFieldType<\/i> class. For\navailable constants, refer to <xref\nkeyref=\"bam.api.constants.udf.type\"/>.",
"type" : "string"
},
"defaultValue" : {
"readOnly" : false,
"description" : "The default value for the user-defined field.",
"type" : "string"
},
"validatorProperties" : {
"readOnly" : false,
"description" : "The validation properties for the user-defined field.\nProperty names are available as constants in the\n<i>UserDefinedFieldValidatorProperties<\/i> class. For\navailable constants, refer to <xref\nkeyref=\"bam.api.constants.udf.validator.properties\"/>.",
"type" : "string"
},
"properties" : {
"readOnly" : false,
"description" : "The following property can be used:<ul id=\"ul_v3c_zcw_s3b\">\n<li>locales=en-US,ja-JP,zh-CN<\/li>\n<\/ul>\n<note>You must enable the supported locales in the global settings of\nthe Address Manager user interface before you can use them within UDFs.\n<\/note>",
"type" : "string"
},
"predefinedValues" : {
"readOnly" : false,
"description" : "The preset values for the user-defined field separated by a | (pipe)\ncharacter and ending with a pipe character. For example, <b>value1|value2|<\/b>.",
"type" : "string"
},
"required" : {
"readOnly" : false,
"description" : "The boolean value. If set to true, users must enter data\nin the field.",
"type" : "boolean"
},
"renderAsRadioButton" : {
"readOnly" : false,
"description" : "This has been deprecated.",
"type" : "boolean"
},
"hideFromSearch" : {
"readOnly" : false,
"description" : "The boolean value. If set to true, the user-defined field\nis hidden from the search.",
"type" : "boolean"
}
},
"example" : {
"name" : "...",
"displayName" : "...",
"type" : "...",
"defaultValue" : "...",
"validatorProperties" : "...",
"properties" : "...",
"predefinedValues" : "...",
"required" : true,
"hideFromSearch" : true
},
"description" : "User-defined fields can be added to each of the Address Manager object types.\nThis class allows API users to query and gather user-defined fields\ninformation for a specified object type."
}
,
"json_JsonableObject" : {
"type" : "object",
"title" : "JsonableObject",
"example" : { },
"description" : ""
}
,
"json_ResponsePolicySearchResult" : {
"type" : "object",
"title" : "ResponsePolicySearchResult",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "The name of the Response Policy item.",
"type" : "string"
},
"policyType" : {
"readOnly" : false,
"description" : "The type of response policy. For example, whitelist, blacklist,\nredirect or blackhole.",
"type" : "string"
},
"parentIds" : {
"readOnly" : false,
"description" : "Comma-separated values of the parent Response Policy or RP\nZone object(s) ID. If policy item is associated with a Response Policy,\nit is the Response Policy object ID. If policy item is associated with\nBlueCat Security feed data, it is the RP Zone object ID.",
"type" : "string"
},
"category" : {
"readOnly" : false,
"description" : "The name of the BlueCat Security feed category associated with the\npolicy item. For example, Malicious, Spam or Botnet command and control.\nFor local response policy items, this will be null.",
"type" : "string"
},
"configId" : {
"readOnly" : false,
"description" : "The object ID of the parent configuration in which the Response Policy\nitem is configured.",
"type" : "integer",
"format" : "int64"
}
},
"example" : {
"name" : "...",
"policyType" : "...",
"parentIds" : "...",
"category" : "...",
"configId" : 12345
},
"description" : "Represents the Response Policy items that are configured either in local\nResponse Policies or BlueCat Security feed data."
}
,
"json_TrustKeyBundle" : {
"type" : "object",
"title" : "TrustKeyBundle",
"allOf" : [
{
"$ref" : "#/definitions/json_JsonableObject"
},
{
"properties" : {
"IP" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"ip" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sshUser" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"hostPublicKey" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"hostPublicKeyGeneratedTimestamp" : {
"readOnly" : false,
"description" : "",
"type" : "number"
},
"userPublicKey" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"userPublicKeyGeneratedTimestamp" : {
"readOnly" : false,
"description" : "",
"type" : "number"
}
}
}
],
"example" : {
"IP" : "...",
"ip" : "...",
"sshUser" : "...",
"hostPublicKey" : "...",
"hostPublicKeyGeneratedTimestamp" : 12345,
"userPublicKey" : "...",
"userPublicKeyGeneratedTimestamp" : 12345
},
"description" : ""
}
,
"xml_ns0_APIAccessRight" : {
"type" : "object",
"title" : "APIAccessRight",
"allOf" : [
{
"properties" : {
"entityId" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The database ID of the object to which the access right\napplies. This value must be greater than 0.",
"type" : "integer",
"format" : "int64"
},
"overrides" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "Indicates the types that are to be overridden in the\naccess right in the format\n<i>objectType=accessRightValue<\/i> where\n<i>objectType<\/i> is the same object type used in\nAPIEntity and <i>accessRightValue<\/i> is one of HIDE, VIEW,\nADD, CHANGE or FULL. Multiple override elements are\nseparated by a | (pipe) character.",
"type" : "string"
},
"properties" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "A string containing extra properties for the object in\nthe format <i>attribute=value<\/i>.",
"type" : "string"
},
"userId" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The database ID of the owner of the access right. This\nvalue must be greater than 0.",
"type" : "integer",
"format" : "int64"
},
"value" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The default access right (HIDE, VIEW, ADD, CHANGE, or\nFULL). This field cannot be null.",
"type" : "string"
}
}
}
],
"description" : "This class controls Access Right objects."
}
,
"xml_ns0_APIData" : {
"type" : "object",
"title" : "APIData",
"allOf" : [
{
"properties" : {
"name" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The name of the probe to collect data. Values are\nNETWORK_BLOOM or LEASE_COUNT_PER_DATE.",
"type" : "string"
},
"properties" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "A string containing extra properties for the object in\nthe format <i>attribute: value<\/i>.",
"type" : "string"
}
}
}
],
"description" : "API Data with a timestamp."
}
,
"xml_ns0_APIDeploymentOption" : {
"type" : "object",
"title" : "APIDeploymentOption",
"allOf" : [
{
"properties" : {
"id" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The database ID of the option in Address Manager.",
"type" : "integer",
"format" : "int64"
},
"name" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The name of the option.",
"type" : "string"
},
"properties" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "A string containing additional properties. This is used\nfor user-defined fields on most objects, but also passes\nsome values that do not have their own specific\nparameter.",
"type" : "string"
},
"type" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The option type listed in <xref\nkeyref=\"bam.api.constants.option.types\">Option\nTypes<\/xref>. This field cannot be null.",
"type" : "string"
},
"value" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The single or multiple field value of the option;\nmultiple values are comma-separated. This field cannot be\nnull.",
"type" : "string"
}
}
}
],
"description" : "Deployment options configure both DHCP and DNS services on the network. They are\navailable as DHCP client and service options, including standard DNS options.\nDeployment options support the standard object functions."
}
,
"xml_ns0_APIDeploymentRole" : {
"type" : "object",
"title" : "APIDeploymentRole",
"allOf" : [
{
"properties" : {
"entityId" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The database ID of the entity. This value must be greater\nthan 0.",
"type" : "integer",
"format" : "int64"
},
"id" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The database ID of the deployment role in Address Manager.",
"type" : "integer",
"format" : "int64"
},
"properties" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "A string containing extra properties for the object in\nthe format <i>attribute=value<\/i>. This field can be null if\nused for forward space. A ViewId property must be provided\nto assign DNS Roles to a Network or Block for a particular\nDNS View (reverse space). Multiple properties are separated\nby a | (pipe) character.",
"type" : "string"
},
"serverInterfaceId" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The database ID of the sever interface. This value must\nbe greater than 0.",
"type" : "integer",
"format" : "int64"
},
"service" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "DNS, DHCP, or TFTP. This field cannot be null.",
"type" : "string"
},
"type" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The type of the role (NONE, MASTER, MASTER_HIDDEN, SLAVE,\nSLAVE_STEALTH, FORWARDER, STUB, RECURSION, PEER, or AD\nMASTER). This field cannot be null.",
"type" : "string"
}
}
}
],
"description" : "Manages the deployment roles that control the services provided by Address\nManager-managed servers. These objects support the standard object\nfunctions."
}
,
"xml_ns0_APIEntity" : {
"type" : "object",
"title" : "APIEntity",
"allOf" : [
{
"properties" : {
"id" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The database ID of the object in Address Manager.",
"type" : "integer",
"format" : "int64"
},
"name" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The field name, which might be null.",
"type" : "string"
},
"properties" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "A string that contains properties for the object in\nattribute=value format, with each separated by a | (pipe)\ncharacter. For example, a host record object may have a\nproperties field such as <b>ttl=123|comments=my\ncomment|<\/b>. This field can be null.",
"type" : "string"
},
"type" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The class name of the object. For example, a\nconfiguration object has a type equal to\n<b>Configuration<\/b>. This field cannot be null. A list\nof types is part of the API client (Java and Perl).",
"type" : "string"
}
}
}
],
"description" : "This class represents all entities except options, roles, and access rights. It\nmanages all other types by passing the values for the object as a delimited\nproperties string of name–value pairs. The properties for each object are listed in <xref\nhref=\"../topic/top_bam_api_method_introduction.dita\"/>."
}
,
"xml_ns0_APIIP4ReconciliationPolicy" : {
"type" : "object",
"title" : "APIIP4ReconciliationPolicy",
"allOf" : [
{
}
],
"description" : ""
}
,
"xml_ns0_APITrustBundle" : {
"type" : "object",
"title" : "APITrustBundle",
"allOf" : [
{
"properties" : {
"establishedTime" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "",
"type" : "string"
},
"hostKey" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "",
"type" : "string"
},
"ip" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "",
"type" : "string"
},
"pubKey" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "",
"type" : "string"
}
}
}
],
"description" : ""
}
,
"xml_ns0_APITrustBundleFinalSetting" : {
"type" : "object",
"title" : "APITrustBundleFinalSetting",
"allOf" : [
{
"properties" : {
"error" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "",
"type" : "string"
},
"errorCode" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"responceCode" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "",
"type" : "string"
}
}
}
],
"description" : ""
}
,
"xml_ns0_APIUserDefinedField" : {
"type" : "object",
"title" : "APIUserDefinedField",
"allOf" : [
{
"properties" : {
"defaultValue" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The default value for the user-defined field.",
"type" : "string"
},
"displayName" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The name of the user-defined field that appears to users in the\nAddress Manager interface.",
"type" : "string"
},
"hideFromSearch" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The boolean value. If set to true, the user-defined field\nis hidden from the search.",
"type" : "boolean"
},
"name" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The internal name of the user-defined field.",
"type" : "string"
},
"predefinedValues" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The preset values for the user-defined field separated by a | (pipe)\ncharacter and ending with a pipe character. For example, <b>value1|value2|<\/b>.",
"type" : "string"
},
"properties" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The following property can be used:<ul id=\"ul_v3c_zcw_s3b\">\n<li>locales=en-US,ja-JP,zh-CN<\/li>\n<\/ul>\n<note>You must enable the supported locales in the global settings of\nthe Address Manager user interface before you can use them within UDFs.\n<\/note>",
"type" : "string"
},
"renderAsRadioButton" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "This has been deprecated.",
"type" : "boolean"
},
"required" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The boolean value. If set to true, users must enter data\nin the field.",
"type" : "boolean"
},
"type" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The type of the user-defined field. Types are available\nas constants in the <i>UserDefinedFieldType<\/i> class. For\navailable constants, refer to <xref\nkeyref=\"bam.api.constants.udf.type\"/>.",
"type" : "string"
},
"validatorProperties" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The validation properties for the user-defined field.\nProperty names are available as constants in the\n<i>UserDefinedFieldValidatorProperties<\/i> class. For\navailable constants, refer to <xref\nkeyref=\"bam.api.constants.udf.validator.properties\"/>.",
"type" : "string"
}
}
}
],
"description" : "User-defined fields can be added to each of the Address Manager object types.\nThis class allows API users to query and gather user-defined fields\ninformation for a specified object type."
}
,
"xml_ns0_ResponsePolicySearchResult" : {
"type" : "object",
"title" : "ResponsePolicySearchResult",
"allOf" : [
{
"properties" : {
"category" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The name of the BlueCat Security feed category associated with the\npolicy item. For example, Malicious, Spam or Botnet command and control.\nFor local response policy items, this will be null.",
"type" : "string"
},
"configId" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The object ID of the parent configuration in which the Response Policy\nitem is configured.",
"type" : "integer",
"format" : "int64"
},
"name" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The name of the Response Policy item.",
"type" : "string"
},
"parentIds" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "Comma-separated values of the parent Response Policy or RP\nZone object(s) ID. If policy item is associated with a Response Policy,\nit is the Response Policy object ID. If policy item is associated with\nBlueCat Security feed data, it is the RP Zone object ID.",
"type" : "string"
},
"policyType" : {
"xml" : {
"namespace" : ""
},
"readOnly" : false,
"description" : "The type of response policy. For example, whitelist, blacklist,\nredirect or blackhole.",
"type" : "string"
}
}
}
],
"description" : "Represents the Response Policy items that are configured either in local\nResponse Policies or BlueCat Security feed data."
}
},
"paths": {
"\/v1/addACL" : {
"post" : {
"tags" : [ "dns_methods" ],
"summary" : "Adds an Access Control List (ACL) to a view.",
"description" : "Adds an Access Control List (ACL) to a view.",
"operationId" : "addACL",
"produces" : [ "application/json" ],
"parameters" : [
{
"name" : "configurationId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The object ID of the configuration on which ACL need to be added."
},
{
"name" : "name",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "The name of the ACL."
},
{
"name" : "properties",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "A string containing the comma-separated list of options in the following\nformat:\n<code>aclValues=IP4Address, IP6Address, IP4Network’s CIDR, IP6Network’s CIDR, ACL’s name,\nTSIG key’s name, Predefined BIND ACL values<\/code> where:\n\n<ul>\n<li><b>IP4Address<\/b> —the IPv4 address.<\/li>\n\n<li><b>IP6Address<\/b> —the IPv6 address.<\/li>\n\n<li><b>IP4Network’s CIDR<\/b> —the CIDR notation defining the IPv4\nnetwork.<\/li>\n\n<li><b>IP6Network’s CIDR<\/b> —the CIDR notation defining the IPv6\nnetwork.<\/li>\n\n<li><b>ACL’s name<\/b> —the name of the ACL Example: acl aclName.<\/li>\n\n<li><b>TSIG key’s name<\/b> —the name of the TSIG key Example: key\nTSIGName.<\/li>\n\n<li><b>Predefined BIND ACL values<\/b> —Example: ‘none’, 'any',\n'localhost', 'localnets' or 'All', 'None', 'Local Host', 'Local\nNetworks'.<\/li>\n<\/ul>\n<note>Use an exclamation mark (!) to exclude a certain option. For example,\n!none, !acl aclName, !10/ 24, etc.<\/note>"
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "Returns the object ID for the new ACL object.",
"type" : "number"
},
"description" : "Returns the object ID for the new ACL object."
}
}
}
}
,
"\/v1/addAccessRight" : {
"post" : {
"tags" : [ "bam_object_methods" ],
"summary" : "Adds access rights to a specified object.",
"description" : "Adds access rights to a specified object.",
"operationId" : "addAccessRight",
"produces" : [ "application/json" ],
"parameters" : [
{
"name" : "entityId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"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."
},
{
"name" : "overrides",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "A list of type-specific overrides in the following format:\n<code>\"objectType=accessValue|objectType=accessValue\"<\/code>"
},
{
"name" : "properties",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "A string including the following options:\n\n<ul>\n<li><b>workflowLevel<\/b> —valid values for this option are:\n\n<ul>\n<li><i>None<\/i> —changes made by the user or group take effect\nimmediately.<\/li>\n\n<li><i>Recommend<\/i> —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><i>Approve<\/i> —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><b>deploymentAllowed<\/b> —either <i>true<\/i> or <i>false<\/i>, 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><b>quickDeploymentAllowed<\/b> —either <i>true<\/i> or <i>false<\/i>, 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 <b>deploymentAllowedproperty<\/b> is applicable only for\nconfiguration, server, or root with <i>Full<\/i> access rights.<\/li>\n\n<li>The <b>workflowLevelproperty<\/b> is applicable only for\n<i>Change<\/i>, <i>Add<\/i>, or <i>Full<\/i> access rights.<\/li>\n<\/ul>\n<\/note>"
},
{
"name" : "userId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The object ID of the user to whom this access right applies."
},
{
"name" : "value",
"in" : "query",
"required" : false,
"type" : "string",
"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."
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "Returns the object ID for the new access right.",
"type" : "number"
},
"description" : "Returns the object ID for the new access right."
}
}
}
}
,
"\/v1/addAdditionalIPAddresses" : {
"post" : {
"tags" : [ "ipam_methods" ],
"summary" : "Adds additional IPv4 addresses and loopback addresses to the Services\ninterface for DNS service.",
"description" : "Adds additional IPv4 addresses and loopback addresses to the Services\ninterface for DNS service.",
"operationId" : "addAdditionalIPAddresses",
"produces" : [ "application/json" ],
"parameters" : [
{
"name" : "ipsToAdd",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "The list of IP addresses you wish to add. You can specify multiple IP\naddresses with a separator. The supported format is\n<b>[IP,serviceType|IP,serviceType]<\/b>. For example,\n10.0.0.10/32,loopback|11.0.0.3/24,service|12.0.0.3,loopback."
},
{
"name" : "properties",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Adds object properties. Currently there are no supported properties; this is reserved for future use."
},
{
"name" : "serverId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The database object ID of the server to which you will add the additional IP addresses."
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "None.",
"type" : "file"
},
"description" : "None."
}
}
}
}
,
"\/v1/addAliasRecord" : {
"post" : {
"tags" : [ "dns_methods" ],
"summary" : "Adds alias records.",
"description" : "Adds alias records.",
"operationId" : "addAliasRecord",
"produces" : [ "application/json" ],
"parameters" : [
{
"name" : "absoluteName",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "The FQDN of the alias. If you are adding a record in a zone that is\nlinked to an incremental naming policy, you must add a single hash (#) sign\nat the appropriate location in the FQDN. Depending on the policy order\nvalue, the location of the single hash sign varies."
},
{
"name" : "linkedRecordName",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "The name of the record to which this alias will link."
},
{
"name" : "properties",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Adds object properties, including comments and user-defined fields."
},
{
"name" : "ttl",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The time-to-live (TTL) value for the record. To ignore the TTL, set the value to <b>-1<\/b>."
},
{
"name" : "viewId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The object ID for the parent view to which this record is being added."
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "Returns the object ID for the new alias resource record.",
"type" : "number"
},
"description" : "Returns the object ID for the new alias resource record."
}
}
}
}
,
"\/v1/addBulkHostRecord" : {
"post" : {
"tags" : [ "dns_methods" ],
"summary" : "Adds bulk host records using auto-increment from the specific starting address.",
"description" : "Adds bulk host records using auto-increment from the specific starting address.",
"operationId" : "addBulkHostRecord",
"produces" : [ "application/json" ],
"parameters" : [
{
"name" : "absoluteName",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "The FQDN of the host record. If you are adding a record in a zone that\nis linked to an incremental naming policy, you must add a single hash sign (#)\nat the appropriate location in the FQDN. Depending on the policy\norder value, the location of the single hash # sign varies."
},
{
"name" : "networkId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The network receiving the available IP addresses. Each address is used\nfor one host record."
},
{
"name" : "numberOfAddresses",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int32",
"description" : "The number of addresses."
},
{
"name" : "properties",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "<b>excludeDHCPRange<\/b> = <i>true/false<\/i>. If true, then IP\naddresses within a DHCP range will be skipped. This argument can also\ncontain user-defined fields."
},
{
"name" : "startAddress",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "The starting IPv4 address for getting the available addresses."
},
{
"name" : "ttl",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The time-to-live (TTL) value for the record. To ignore the TTL, set the value\nto <b>-1<\/b>."
},
{
"name" : "viewId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The object ID for the parent view to which you are adding the record."
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "Returns an array of host record APIEntity objects based on available addresses and number of IP addresses required. If no addresses are available, an error will be shown.",
"type" : "array",
"items" : {
"$ref" : "#/definitions/json_APIEntity"
}
},
"example" : {
"id" : 12345,
"name" : "...",
"type" : "...",
"properties" : "..."
},
"description" : "Returns an array of host record APIEntity objects based on available addresses and number of IP addresses required. If no addresses are available, an error will be shown."
}
}
}
}
,
"\/v1/addCustomOptionDefinition" : {
"post" : {
"tags" : [ "dhcp_methods" ],
"summary" : "Adds a custom deployment option.",
"description" : "Adds a custom deployment option.",
"operationId" : "addCustomOptionDefinition",
"produces" : [ "application/json" ],
"parameters" : [
{
"name" : "allowMultiple",
"in" : "query",
"required" : false,
"type" : "boolean",
"description" : "This parameter determines whether or not the custom option requires multiple values. The\ndefault value is false;\n<p>\nIn Perl script, only an empty string and zero (0) are considered as\n<b>false<\/b>; other values are considered as <b>true<\/b>.\nTherefore, a string containing the word <i>false<\/i> is\nconsidered to be <b>true<\/b> because the string is not empty. In\nPerl, set the <i>allowMultiple<\/i> data type to <i>string<\/i> and\nset the value to either <b>true<\/b> or <b>false<\/b>:\n<code>SOAP::Data->type ('string') ->\nname ('allowMultiple') ->\nvalue (\"false\") ->\nattr ({xmlns => ''})<\/code> Or, set the <i>allowMultiple<\/i>\ndata type to <i>boolean<\/i>. Set the value to either <b>0<\/b> or an empty\nstring to represent <b>false<\/b>. Set the value to any other text\nto represent <b>true<\/b>.\n<code>SOAP::Data->type ('boolean') ->\nname ('allowMultiple') ->\nvalue (0) ->\nattr ({xmlns => ''})<\/code>\n<\/p>"
},
{
"name" : "configurationId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The object ID of the parent configuration."
},
{
"name" : "name",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "The name of the custom deployment option."
},
{
"name" : "optionId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The option code for the custom deployment option. This value must be\nwithin the range of 151 to 174, 178 to 207, 212 to 219, 222 to 223, or\n224 to 254."
},
{
"name" : "optionType",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "The type of custom deployment option. This value must be one of the items\nlisted in <xref href=\n\"../reference/ref_api_constants_DHCP_custom_option_types.dita\"/>."
},
{
"name" : "properties",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Adds object properties, including user-defined fields"
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "Returns the object ID of the new option defined.",
"type" : "number"
},
"description" : "Returns the object ID of the new option defined."
}
}
}
}
,
"\/v1/addDHCP4Range" : {
"post" : {
"tags" : [ "dhcp_methods" ],
"summary" : "Adds IPv4 DHCP ranges.",
"description" : "Adds IPv4 DHCP ranges.",
"operationId" : "addDHCP4Range",
"produces" : [ "application/json" ],
"parameters" : [
{
"name" : "end",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "An IP address defining the highest address or end of the range."
},
{
"name" : "networkId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The object ID for the network in which this DHCP range is located."
},
{
"name" : "properties",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Adds object properties, including the object name and user-defined\nfields."
},
{
"name" : "start",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "An IP address defining the lowest address or start of the range."
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "Returns the object ID for the new DHCPv4 range.",
"type" : "number"
},
"description" : "Returns the object ID for the new DHCPv4 range."
}
}
}
}
,
"\/v1/addDHCP4RangeBySize" : {
"post" : {
"tags" : [ "dhcp_methods" ],
"summary" : "Adds IPv4 DHCP ranges by offset and percentage.",
"description" : "Adds IPv4 DHCP ranges by offset and percentage.",
"operationId" : "addDHCP4RangeBySize",
"produces" : [ "application/json" ],
"parameters" : [
{
"name" : "networkId",
"in" : "query",
"required" : false,
"type" : "integer",
"format" : "int64",
"description" : "The object ID for the network in which this DHCP range is located."
},
{
"name" : "offset",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "An integer value specifying the point where the range should begin. The\npositive values indicate that the starting IP address of the range will\nbe counted from the Network ID first IP address and forward in the range.\nThe negative values indicate that the starting IP address of the range\nwill be counted from the Network Broadcast Address last IP address and\nbackward in the range."
},
{
"name" : "properties",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Optional object properties that can contain the object name, the value of\n<i>defineRangeBy<\/i>, and user-defined fields. The possible\nvalues for <i>defineRangeBy<\/i> are <b>OFFSET_AND_SIZE<\/b> and\n<b>OFFSET_AND_PERCENTAGE<\/b>. <note><b>OFFSET_AND_SIZE<\/b> is reserved\nfor future use.<\/note>"
},
{
"name" : "size",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "The size of the range. Currently, you can only specify the range size in