Using Our APIs
Information Requests
Query Fixed IP
5 min
purpose returns the fixed private ip address assigned to the sim specified in the \<iccid> element some customers connect their sims via a virtual private network (vpn) in these cases, devices are addressable within a private ip address space, and a fixed private ip may be assigned to each sim typically, the fixed ip address is assigned when sims are provisioned into the pending group, or when sims are activated into a live group the exact behaviour depends on the customer’s configuration if a fixed ip has been assigned, it will be returned in the \<fixed ip> element if no fixed ip is assigned (or not yet provisioned), the response will contain an empty \<fixed ip> element the \<fixed ip> value is returned in standard ipv4 format if no fixed ip is available, the element will be present but empty fixed ip allocation depends on the sim’s provisioning and vpn configuration endpoint post https //api m2miportal com content type application/xml accept application/xml request (xml) \<query fixed ip version="1" api id="123456"> \<authentication> \<username>username\</username> \<password>password\</password> \</authentication> \<iccid>1234567890123456789\</iccid> \</query fixed ip> response (success) \<query fixed ip response api id="123456"> \<api outcome>success\</api outcome> \<fixed ip>10 0 0 1\</fixed ip> \</query fixed ip response> response (failure) if a request cannot be processed, the response will include api outcome indicating failure an error description explaining the reason failure responses may occur due to invalid authentication credentials invalid or unknown identifiers (for example iccid or msisdn) invalid or missing parameters values not permitted for the specified sim type or account configuration insufficient permissions integrating systems should validate input data before submission and implement appropriate error handling and logging