emnify subpackage_sim API
The subpackage_sim API from emnify — 9 operation(s) for subpackage_sim.
emnify subpackage_sim API is one of 29 APIs that emnify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 5 JSON Schema definitions.
Tagged areas include subpackage_sim. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.
This API exposes 12 operations across 9 paths, and defines 97 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://cdn.emnify.net.
12 operations
9 paths
97 schemas
2 DELETE7 GET2 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
emnify subpackage_sim API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
By default, every request must be authenticated.
BearerAuth— Retrieve a JWT via POST /api/v1/authenticate using an applicationtoken or user credentials, then send it as Authorization: Bearer .
Paths & Operations 12
Across 9 paths, the API surfaces 12 operations — 2 DELETE, 7 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
subpackage_sim 12
GET
/api/v1/sim
List SIMs
POST
/api/v1/sim/migration/workspace
Migrate SIMs between Workspaces
DELETE
/api/v1/sim/multi
Bulk delete SIMs
GET
/api/v1/sim/status
List SIM statuses
GET
/api/v1/sim/{sim_id}
SIM details
DELETE
/api/v1/sim/{sim_id}
Delete a SIM
PATCH
/api/v1/sim/{sim_id}
Update a SIM
GET
/api/v1/sim/{sim_id}/event
List SIM events
GET
/api/v1/sim/{sim_id}/stats
SIM usage and cost statistics
GET
/api/v1/sim/{sim_id}/stats/daily
Daily SIM usage statistics
GET
/api/v1/sim_batch/bic/{bic}
Validate SIM batch by BIC
PATCH
/api/v1/sim_batch/bic/{bic}
Register a given batch by BIC
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are SIM_ValidateSIMBatchByBIC_Response_200 (14 properties), ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItems (13 properties), ApiV1SimGetResponsesContentApplicationJsonSchemaItems (13 properties), SIM_SimByIdGet_Response_200 (13 properties). Each schema is shown below with its type and property counts.
SIM_RegisterSIMBatchByBIC_Response_200
object
1 property
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaEndpoint
object
1 property
ApiV1SimBatchBicBicGetResponsesContentApplicationJsonSchemaStatus
object
2 properties
1 required
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsCurrentMonthDataCurrency
object
3 properties
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaResellerOrgCountry
object
7 properties
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsResellerOrgCountry
object
7 properties
ApiV1SimGetResponsesContentApplicationJsonSchemaItems
object
13 properties
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaModel
object
5 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastHourData
object
12 properties
SIM_SimMigrationWorkspace_Response_200
object
6 properties
5 required
ApiV1SimSimIdPatchRequestBodyContentApplicationJsonSchemaIssuerOrg
object
1 property
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaSimsItemsSourceWorkspace
object
The source Workspace of the SIM
2 properties
2 required
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaSimsItemsEndpoint
object
The device currently attached to the SIM. Defaults to undefined if no device is attached.
2 properties
2 required
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsModel
object
5 properties
ApiV1SimMigrationWorkspacePostRequestBodyContentApplicationJsonSchemaAllowedSimStatusesItems
object
1 property
1 required
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastHourDataCurrency
object
3 properties
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsResellerOrgCountry
object
7 properties
ApiV1SimSimIdPatchRequestBodyContentApplicationJsonSchemaStatus
object
2 properties
1 required
ApiV1SimMultiDeleteRequestBodyContentApplicationJsonSchemaItems
object
1 property
1 required
ApiV1SimBatchBicBicGetResponsesContentApplicationJsonSchemaModel
object
5 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastHourSms
object
12 properties
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsModelManufacturer
object
2 properties
ApiV1SimSimIdPatchRequestBodyContentApplicationJsonSchemaCustomerOrg
object
1 property
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaTargetWorkspace
object
The targetworkspace specified in the request
2 properties
2 required
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaErrorsItemsSimsItemsStatus
object
2 properties
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsStatus
object
2 properties
1 required
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsIssuerOrgCountry
object
7 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsCurrentMonthDataTrafficType
object
3 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastHourDataTrafficType
object
3 properties
ApiV1SimMigrationWorkspacePostRequestBodyContentApplicationJsonSchemaIccidRange
object
ICCID range to migrate. All SIMs within the range must belong to the source Workspace. The range may include up to 500 ICCIDs. The end value must be greater th…
2 properties
2 required
ApiV1SimBatchBicBicPatchRequestBodyContentApplicationJsonSchemaSimStatus
object
2 properties
1 required
ApiV1SimSimIdEventGetResponsesContentApplicationJsonSchemaItems
object
11 properties
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItems
object
13 properties
ApiV1SimSimIdEventGetResponsesContentApplicationJsonSchemaItemsImsi
object
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsCustomerOrg
object
3 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsCurrentMonthSms
object
12 properties
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsModelFormfactor
object
2 properties
ApiV1SimSimIdEventGetResponsesContentApplicationJsonSchemaItemsSim
object
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaErrorsItemsSimsItemsEndpoint
object
The device currently attached to the SIM. Only present if a device is attached.
2 properties
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsResellerOrg
object
3 properties
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsStatus
object
2 properties
1 required
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsCustomerOrgCountry
object
7 properties
ApiV1SimSimIdEventGetResponsesContentApplicationJsonSchemaItemsEndpoint
object
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsModelFormfactor
object
2 properties
ApiV1SimSimIdEventGetResponsesContentApplicationJsonSchemaItemsOrganisation
object
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaAllowedSimStatusesItems
object
2 properties
2 required
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastMonthDataCurrency
object
3 properties
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsIssuerOrgCountry
object
7 properties
SimByIdPatchRequestBadRequestError
object
3 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastHour
object
2 properties
ApiV1SimStatusGetResponsesContentApplicationJsonSchemaItems
object
2 properties
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
3 required
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastMonthDataTrafficType
object
3 properties
ApiV1SimMigrationWorkspacePostRequestBodyContentApplicationJsonSchemaTargetWorkspace
object
Target Workspace to migrate SIMs to. Must be an enterprise Workspace. The calling user must have Administrator permissions on the target Workspace.
1 property
1 required
ApiV1SimBatchBicBicGetResponsesContentApplicationJsonSchemaModelManufacturer
object
2 properties
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsResellerOrg
object
3 properties
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaModelFormfactor
object
2 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItems
object
3 properties
3 required
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsCustomerOrgCountry
object
7 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastHourSmsCurrency
object
3 properties
ApiV1SimSimIdEventGetResponsesContentApplicationJsonSchemaItemsEventSource
object
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaCustomerOrg
object
3 properties
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaErrorsItemsSimsItemsSourceWorkspace
object
The source Workspace of the SIM
2 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsCurrentMonthSmsTrafficType
object
3 properties
ApiV1SimMigrationWorkspacePostRequestBodyContentApplicationJsonSchemaSimsItems
object
1 property
1 required
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsCurrentMonth
object
2 properties
ApiV1SimSimIdEventGetResponsesContentApplicationJsonSchemaItemsEventType
object
SimMigrationWorkspaceRequestConflictError
object
3 properties
3 required
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsEndpoint
object
1 property
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaCustomerOrgCountry
object
7 properties
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaIssuerOrg
object
3 properties
SIM_ValidateSIMBatchByBIC_Response_200
object
14 properties
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaSimsItemsStatus
object
2 properties
2 required
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaIssuerOrgCountry
object
7 properties
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaSimsItems
object
6 properties
1 required
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaStatus
object
2 properties
1 required
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsEndpoint
object
1 property
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastMonth
object
2 properties
ApiV1SimSimIdEventGetResponsesContentApplicationJsonSchemaItemsEventSeverity
object
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsCurrentMonthData
object
12 properties
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsIssuerOrg
object
3 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsCurrentMonthSmsCurrency
object
3 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastMonthSmsCurrency
object
3 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastMonthSmsTrafficType
object
3 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastHourSmsTrafficType
object
3 properties
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaModelManufacturer
object
2 properties
ApiV1SimSimIdGetResponsesContentApplicationJsonSchemaResellerOrg
object
3 properties
ApiV1SimGetResponsesContentApplicationJsonSchemaItemsCustomerOrg
object
3 properties
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsIssuerOrg
object
3 properties
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsModelManufacturer
object
2 properties
ApiV1SimSimIdPatchRequestBodyContentApplicationJsonSchemaResellerOrg
object
1 property
ApiV1SimMigrationWorkspacePostResponsesContentApplicationJsonSchemaErrorsItemsSimsItems
object
6 properties
SIM_SimByIdGet_Response_200
object
13 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastMonthData
object
12 properties
ApiV1SimBatchBicBicGetResponsesContentApplicationJsonSchemaModelFormfactor
object
2 properties
ApiV1SimBatchBicBicPatchResponsesContentApplicationJsonSchemaSimItemsModel
object
5 properties
ApiV1SimSimIdStatsGetResponsesContentApplicationJsonSchemaItemsLastMonthSms
object
12 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from emnify 12
Other APIs emnify publishes across the network.
emnify GraphQL API
emnify Data Streamer
emnify Documentation MCP Server
emnify subpackage_applicationTokens API
emnify subpackage_authentication API
emnify subpackage_automations API
emnify subpackage_cloudConnect API
emnify subpackage_customEvents API
emnify subpackage_endpoint API
emnify subpackage_euicc API
emnify subpackage_euiccOperation API
emnify subpackage_events API
#subpackage_sim