v1/esims
The v1/esims API allows you to view eSIMs being reported by the devices in your account.
Digi Remote Manager only shows eSIMs that are provided by Digi and registered for your device. If a device reports an eSIM that is not allowed in the system, it will not be shown.
The bulk API returns at most 20,000 records and sets the Truncated HTTP header if the data is truncated.
Use the query parameter to limit the data returned.
URI
https://<hostname>/ws/v1/esims
Formats
| HTTP method | Format | Description | Parameters |
|---|---|---|---|
| GET | /ws/v1/esims | Get a summary of the eSIM APIs. | None |
| GET | /ws/v1/esims/inventory/{eid} | Retrieve an eSIM by EID | None |
| GET | /ws/v1/esims/bulk | Retrieve eSIMs for the current user’s account in CSV format. | fields size query orderby |
| GET | /ws/v1/esims/inventory | Retrieve eSIMs for the current user’s account. | cursor size query orderby |
eSIM Data
customer_id- The account in which the eSIM is loadeddevice_id- The device ID of the device that reported the eSIMeid- The eSIM profile’s EID.
Parameters
| Name | Type | Description |
|---|---|---|
| cursor | string | If a full page is returned and more eSIMs are available a cursor value is returned in the full page. The cursor parameter can be used to continue with the same query parameters and fetch the next page. For example, cursor=d7eec0d4-557a-11e9-ab8e-d20bcc91db8a |
| fields | string | Comma-separated list of fields to return for bulk API |
| orderby | string | A field in the eSIM code to sort by. Specify “asc field” or “desc field” to change the sort order |
| query | string | The Remote Manager query language query condition used to filter results |
| size | integer | Number of items to return. The maximum and default is 1000. |