> 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/apn_settings.md).

# APN settings

Mobile-internet settings a SIM needs before a device on it can reach the Navixy platform, looked up by phone number.

An access point name, or APN, is the mobile-internet configuration a SIM needs before the device holding it can reach the platform. This resource looks those settings up from a phone number.

The lookup is by number rather than by device, so the number does not have to belong to a registered tracker. Settings are resolved against the dealer that the current account belongs to.

## API actions

API base path: `/apn_settings`.

***

## Read APN settings

> Look up the mobile-internet APN settings for a phone number, so a device on that SIM can be configured to reach the platform.\
> \
> The lookup is by number, not by tracker: the number does not have to belong to a registered device. Settings are resolved against the dealer the current account belongs to.\
> \
> Also accepts GET with the same parameters as query-string values.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Tracking services","description":"Services supporting tracking rather than the trackers themselves: APN lookup, BLE beacon data, delivery tracking, geocoding, map layers and data forwarding. Resources under the /apn_settings/, /beacon/, /delivery/, /geocoder/, /map_layer/ and /retranslator/ paths."}],"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"}},"schemas":{"ApnSettings":{"type":"object","description":"Mobile-internet access point settings for a SIM, together with the operator they belong to.","properties":{"name":{"type":"string","description":"APN name, for example `internet`."},"user":{"type":"string","description":"APN user name. Empty when the operator needs none."},"password":{"type":"string","description":"APN password. Empty when the operator needs none."},"operator_name":{"type":"string","description":"Name of the mobile operator the number belongs to."}}}},"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":{"/apn_settings/read":{"post":{"tags":["Tracking services"],"summary":"Read APN settings","description":"Look up the mobile-internet APN settings for a phone number, so a device on that SIM can be configured to reach the platform.\n\nThe lookup is by number, not by tracker: the number does not have to belong to a registered device. Settings are resolved against the dealer the current account belongs to.\n\nAlso accepts GET with the same parameters as query-string values.","operationId":"apnSettingsRead","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string","description":"A valid international phone number **without the leading `+`**, digits only, for example `1234567890`."}},"required":["phone"]}}}},"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":{"$ref":"#/components/schemas/ApnSettings"}}}}}},"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"},"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 - The phone number is not found in the database.


---

# 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/apn_settings.md?ask=<question>&goal=<endgoal>
```

`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.