HomeGuidesAPI Reference
API Reference

Create or update user-defined Address Map entry

Creates or updates a user-defined IP Intelligence Classification entry (Address Map) for the specified IP address range. The ipStart and ipEnd query parameters must match the ip_start and ip_end values in the request body. On failure, the previous configuration is automatically restored.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
required
0 to 4294967295

Starting IPv4 address in 32-bit unsigned integer format. Must be less than or equal to ipEnd and match ip_start in request body. Valid range: 0 to 4294967295.

int64
required
0 to 4294967295

Ending IPv4 address in 32-bit unsigned integer format. Must be greater than or equal to ipStart and match ip_end in request body. Valid range: 0 to 4294967295.

Body Params

IP Intelligence entry containing application definition details for the IP range.

IP Intelligence Classification entry representing an application definition for an IP address range.

int64
required
0 to 4294967295

Starting IPv4 address in 32-bit unsigned integer format. Must match the ipStart query parameter. Valid range: 0 to 4294967295.

int64
required
0 to 4294967295

Ending IPv4 address in 32-bit unsigned integer format. Must be >= ip_start and match the ipEnd query parameter. Valid range: 0 to 4294967295.

string
required
length ≤ 31
^[a-zA-Z0-9_\-\.]+$

Application name. Required field that must contain only alphanumeric characters, hyphens, underscores, or periods. Maximum length: 31 characters.

string

Optional description of the application. Cannot contain pipe (|), newline, or carriage return characters.

string

Country name associated with the IP range. Cannot contain pipe (|), newline, or carriage return characters.

string

Two-letter country code (ISO 3166-1 alpha-2). Cannot contain pipe (|), newline, or carriage return characters.

string

Organization name associated with the IP range. Cannot contain pipe (|), newline, or carriage return characters.

integer
required
1 to 100

Classification priority/confidence level. Higher values indicate higher confidence. Valid range: 1 to 100.

string
Defaults to {"msinstance":"","mscategory":"","proxy":"0"}

JSON-formatted string containing additional application attributes. If empty or '{}', default values are applied. Must include required keys: msinstance, mscategory, proxy.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json