Add user-defined link definition.
API method:
POST
/v1/addUserDefinedLink
Example
{ "linkType" : "UniqueLinkTypeName", "displayName" : "My Link Type", "sourceEntityTypes" : ["IP4Ranged", "IP4Network"], "destinationEntityTypes" : ["IP4Ranged", "IP4Block"] }
Parameters
- linkType—enter a unique name for the user-defined link.Note:
- You cannot enter a name that is a reserved link type name. For a list of reserved link type names, refer to Reference: Reserved link type names.
- You cannot enter a name that begins with the prefix "BCN_".
- You cannot enter a name that already exists.
- The name is not case-sensitive. For example, if you entered "UniqueLinkTypeName" as a name for linkType previously, you cannot enter "UniqueLINKTypeNAME" for a new linkType.
For more UDL name best practices, see Best practices for UDF and UDL names.
- displayName—enter the name for the user-defined link that will be displayed in Address Manager.
- sourceEntityTypes— enter the source entity name for the user-defined link.
- destinationEntityTypes— enter the destination entity name for the user-defined link.