Create IP location

POST 
/api/web/v1/iplocations

Gets IP location information for an IP address. The IP location can be used to create an ExpectedLocation. Caller requires the USERRBASETTINGS:ADD permission.

Request

application/json

Body

required

cityName string

The city name--always returned in upper-case.

countryCode string

A two-character (alpha-2) ISO 3166-1 country code.

ipAddress string

The IPv4 Address.

isp string

The ISP name--always returned in upper-case.

latitude float

The latitude.

longitude float

The longitude.

privateIpAddress boolean

Whether the IP provided is a private IP Address. The value is only available when resolving an IP address to an IpLocation.

Responses

200

Successful

application/json

Schema

Schema

cityName string

The city name--always returned in upper-case.

countryCode string

A two-character (alpha-2) ISO 3166-1 country code.

ipAddress string

The IPv4 Address.

isp string

The ISP name--always returned in upper-case.

latitude float

The latitude.

longitude float

The longitude.

privateIpAddress boolean

Whether the IP provided is a private IP Address. The value is only available when resolving an IP address to an IpLocation.

Example (from schema)

{
  "cityName": "string",
  "countryCode": "string",
  "ipAddress": "string",
  "isp": "string",
  "latitude": 0,
  "longitude": 0,
  "privateIpAddress": true
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...