Update user-defined link - BlueCat Integrity - 9.5.0

Address Manager Legacy v1 API Guide

Locale
English
Product name
BlueCat Integrity
Version
9.5.0

Update a user-defined link definition.

API method: PUT /v1/updateUserDefinedLink

Example

{
    "linkType" : "UniqueLinkTypeName",
    "displayName" : "My Link Type",
    "sourceEntityTypes" : ["IP4Ranged", "IP4Network"],
    "destinationEntityTypes" : ["IP4Ranged", "IP4Block"]
}
Example (with description)
{
    "linkType" : "UniqueLinkTypeName",
    "displayName" : "My Link Type",
    "description" : "My Link Type updated description",
    "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 must enter a defined user-defined link.
  • displayName—enter the name for the user-defined link that will be displayed in Address Manager.
  • description—(optional) enter a description for the user-defined link.
    Note:
    • The maximum length of this field is 512 characters.
    • If the description field is not specfied, it will be null.
    • On upgrade from Address Manager v9.3.0, the description for the existing links will be populated as null.
  • sourceEntityTypes— enter the source entity name for the user-defined link.
  • destinationEntityTypes— enter the destination entity name for the user-defined link.
Note: If you're updating a user-defined link, you cannot update a link with any associated entity links.