v1/esim_activation_codes

The v1/esim_activation_codes API allows you to register and manage eSIM activation codes in Digi Remote Manager. Once an eSIM activation code, and secret is registered, it can be automatically applied to devices using the web UI, programmatically via the API, or using automations or configuration templates.

You receive activation codes from Digi or your cellular network carrier or provider.

After activation codes have been downloaded to a device, they will be automatically removed from the system after some period of time. The removal of a downloaded activation code will not affect the device that they have been downloaded to.

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.

Warning: Be careful in specifying the Service Provider Network SPN in the carrier field. An eSIM profile may not report the same SPN as the full name from the supplier of the activation code. For example, the carrier providing an activation code might be “Fred’s Fast Wireless Service”, but the SPN reported by the eSIM profile might be “Mobile”. This discrepancy could cause confusion in your API and UI usage. If you try to activate “Fred’s Fast Wireless Service” profile on a device but the system sees only “Mobile” being reported, it may attempt to activate another profile.

URI

https://<hostname>/ws/v1/esim_activation_codes

Formats

HTTP method Format Description Parameters
GET /ws/v1/esim_activation_codes Get a summary of the esim_activation_codes APIs. None
GET /ws/v1/esim_activation_codes/inventory/{iccid} Retrieve an activation code by ICCID. None
GET /ws/v1/esim_activation_codes/bulk Retrieve activation codes for the current user’s account in CSV format. fields size query orderby
GET /ws/v1/esim_activation_codes/inventory Retrieve activation codes for the current user’s account. cursor size query orderby
POST /ws/v1/esim_activation_codes Register a new eSIM activation code. None
POST /ws/v1/esim_activation_codes/bulk Register multiple eSIM activation codes. None
PUT /ws/v1/esim_activation_codes/inventory/{iccid} Modify an activation code by ICCID. None
DELETE /ws/v1/esim_activation_codes/{iccid} Delete an activation code by ICCID. None

Activation Code Data

Each activation code stores a variety of information about an eSIM profile available to be activated on a device, or the device and operation that applied the operation.

  • activation_code - The activation code secret (required for a create operation, input only)
  • carrier - The service provider network (SPN) of the eSIM profile (required for a create operation)
  • completed - The date and time the activation code operation was completed (optional)
  • customer_id - The account in which the activation code is loaded
  • downloaded_by - The user or system task that downloaded the activation code (optional)
  • downloaded_device_id - The device ID of the device that downloaded the activation code (optional)
  • downloaded_eid - The eSIM profile’s EID (optional)
  • downloaded - The date and time the activation code was downloaded (optional)
  • eid - The eSIM profile’s EID (optional) if the activation code is downloaded or available only for that EID.
  • iccid - The ICCID of the eSIM profile associated with the activation code (required for a create operation)
  • name - A user-friendly name of the eSIM profile associated with the activation code (optional)
  • normalized_carrier - The normalized service provider network (SPN) of the eSIM profile (output only, created by the system for display and matching purposes)
  • status - The status of the activation code operation. Output only. Possible values are available, downloading, downloaded, failed.
  • tx - The transaction ID of the activation code download operation (optional). The transaction can be used in the /ws/v1/esim_profile/progress API to monitor the progress of the download operation

Parameters

Parameters for the v1/esim_activation_codes/inventory and v1/esim_activation_codes/bulk APIs include the following:

Name Type Description
cursor string If a full page is returned and more activation codes 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 activation 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.