> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/apn_settings.md). # APN settings by tracker Look up the mobile-internet settings for a registered tracker, by its ID rather than its phone number. An access point name, or APN, is the mobile-internet configuration a SIM needs before the device holding it can reach the Navixy platform. This operation looks those settings up for a tracker that is already registered. The difference from [APN settings](/docs/navixy-api/user-api/resources/tracking/apn_settings.md) is what you have to hand. That one takes a phone number and works for any number, registered or not. This one takes a tracker ID and resolves the number from the tracker. ## API actions API base path: `/tracker/apn_settings`. *** *Required sub-user rights:* `tracker_register`. ## Read APN settings by tracker > Get the APN name, user and password configured for a tracker's SIM. The APN is what tells the device how to reach the mobile network.\ > \ > This is the by-tracker form. \`apn\_settings/read\`, at the top level, does the same thing by phone number and needs no authentication.\ > \ > Requires the \`tracker\_register\` right. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Trackers","description":"Trackers, the devices the platform tracks, together with the geo links that share their live location with people outside the account. Resources under the /tracker/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/tracker/apn_settings/read":{"post":{"tags":["Trackers"],"summary":"Read APN settings by tracker","description":"Get the APN name, user and password configured for a tracker's SIM. The APN is what tells the device how to reach the mobile network.\n\nThis is the by-tracker form. `apn_settings/read`, at the top level, does the same thing by phone number and needs no authentication.\n\nRequires the `tracker_register` right.","operationId":"trackerApnSettingsRead","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tracker_id":{"type":"integer","description":"ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked."}},"required":["tracker_id"]}}}},"responses":{"200":{"description":"The APN settings","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"value":{"type":"object","description":"The APN configuration.","properties":{"name":{"type":"string","description":"APN name."},"user":{"type":"string","description":"APN user."},"password":{"type":"string","description":"APN password."}}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 201: no tracker, or no APN settings for it. Error 208: the tracker exists but is blocked, normally because its tariff ended. Error 214: the device has no GSM module, or uses a bundled SIM whose details are hidden from the user.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` #### Errors These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes): * 201 - No tracker, or no APN settings for it. * 208 - The tracker exists but is blocked, normally because its tariff ended. * 214 - The device has no GSM module, or uses a bundled SIM whose details are hidden from the user. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/tracking/tracker/apn_settings.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.