Edits a perimeter in the organizational structure.
URL
{RMUrl}/api/Organization/perimeters/<PerimeterCode>
REQUEST METHOD
PUT
URL PARAMETER
PerimeterCode: This parameter is provided in the URL and does not need to be sent through PUT.
FORM CONTENT
Name (Optional): Name of the perimeter. Limit of 400 characters.
Description (Optional): Description of the perimeter.
AdditionalInformation (Optional): Additional information on the perimeter.
Responsible (Optional): Person responsible for the perimeter.
Latitude (Optional; Required if the "Longitude" field is completed): Latitude of the perimeter’s location. Valid values: from -90.0 to +90.0. The decimal mark must be represented by a period and not a comma.
Longitude (Optional; Required if the "Latitude" field is completed): Longitude of the perimeter’s location. Valid values: from -180.0 to +180.0. The decimal mark must be represented by a period and not a comma.
GeolocationDescription (Optional): Description of the perimeter’s location. The limit is 1,000 characters.
ZoomLevel (Optional): Zoom level applied to the map of the perimeter’s location. Valid values: whole numbers between 0 and 21.
CustomAttributes (Optional): List of objects with information on the perimeter's attributes. Each attribute is referenced by its variable name. Relationship-type attributes can be referenced by the Id field, the Caption field, or both. If both fields are provided, they must refer to the same object. It is recommended to use the Id field whenever possible. See Appendix 2: Format for Completing Attributes for the list of formats for the Id and Caption fields.
To move a perimeter in the organizational structure, the fields below can be used in the form:
Path (Optional): Path in the organizational structure of the perimeter’s new location. The limit is 400 characters for each perimeter in the path.
ParentPerimeter (Optional): ID of the perimeter’s new parent perimeter.
MappingCriteria
NetbiosName (Optional): Used to indicate how vulnerabilities for all assets in the perimeter will be mapped. In this case, by default, the NetBIOS names identified by a scanner will be mapped to assets according to the value selected. Valid values: Inherited, Disabled, AssetName, HostAddress, or Text attributes created for Technology assets.
IPAddress (Optional): Used to indicate how vulnerabilities for all assets in the perimeter will be mapped. In this case, by default, the IP addresses identified by a scanner will be mapped to assets according to the value selected. Valid values: Inherited, Disabled, AssetName, HostAddress, or Text attributes created for Technology assets.
DNSName (Optional): Used to indicate how vulnerabilities for all assets in the perimeter will be mapped. In this case, by default, the DNS names identified by a scanner will be mapped to assets according to the value selected. Valid values: Inherited, Disabled, AssetName, HostAddress, or Text attributes created for Technology assets
Note: The "null" value in CustomAttributes fields indicates that the inserted values will be deleted. In the other fields, the "null" value means they will be ignored.
FORM CONTENT EXAMPLE
Edit the attributes of a perimeter:
{
"Name":"Marketing Perimeter",
"Description":"description",
"AdditionalInformation":"Additional Information",
"Latitude":-23.761163,
"Longitude":-53.299314,
"GeolocationDescription":"Company headquarters",
"ZoomLevel":8,
"Responsible":{"Name":"John Smith"},
"MappingCriteria":
{
"IpAddress": null,
"DnsName": { "Type": "AssetName" },
"NetbiosName": { "Type": "Attribute", "AttributeName": "text_perimeter" }
},
"CustomAttributes": {
"datetime_attribute":"\/Date(1320335183486)\/",
"email_attribute":"info@example.com",
"link_attribute":"http://www.example.com",
"number_attribute":"999",
"attribute_paragraph":"Important information",
"attribute_text":"attribute content",
"singleselection_attribute":"singleoption",
"multipleselection_attribute":["option1","option2"],
"outline_attribute":["option1","option2"]
"multiplerelationship_group_attribute":[{"Caption":"Finance Dept"},{"Caption":"Information Tech"},{"Caption":"Financial"},{"Caption":"Human Resources"}]
}
}
SUCCESS RESPONSE
HTTP status code 204: NoContent