emnify subpackage_endpoint API
The subpackage_endpoint API from emnify — 16 operation(s) for subpackage_endpoint.
emnify subpackage_endpoint 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_endpoint. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.
This API exposes 31 operations across 16 paths, and defines 149 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.
31 operations
16 paths
149 schemas
7 DELETE14 GET3 PATCH6 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
emnify subpackage_endpoint 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 31
Across 16 paths, the API surfaces 31 operations — 7 DELETE, 14 GET, 3 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
subpackage_endpoint 31
GET
/api/v1/endpoint
List endpoints
POST
/api/v1/endpoint
Create an endpoint
GET
/api/v1/endpoint/status
List endpoint statuses
GET
/api/v1/endpoint/{endpoint_id}
Endpoint details
DELETE
/api/v1/endpoint/{endpoint_id}
Delete an endpoint
PATCH
/api/v1/endpoint/{endpoint_id}
Update an endpoint
GET
/api/v1/endpoint/{endpoint_id}/connectivity
Endpoint connectivity status
PATCH
/api/v1/endpoint/{endpoint_id}/connectivity
Reset endpoint connectivity
GET
/api/v1/endpoint/{endpoint_id}/connectivity_info
Retrieve connectivity information for an endpoint
GET
/api/v1/endpoint/{endpoint_id}/event
List endpoint events
GET
/api/v1/endpoint/{endpoint_id}/operator_blacklist
List operator blacklist for endpoint
PUT
/api/v1/endpoint/{endpoint_id}/operator_blacklist/{operator_id}
Add an operator to the blacklist
DELETE
/api/v1/endpoint/{endpoint_id}/operator_blacklist/{operator_id}
Remove an operator from the blacklist
GET
/api/v1/endpoint/{endpoint_id}/quota/data
Retrieve data quota details
POST
/api/v1/endpoint/{endpoint_id}/quota/data
Set data quota
DELETE
/api/v1/endpoint/{endpoint_id}/quota/data
Remove data quota
GET
/api/v1/endpoint/{endpoint_id}/quota/sms
Show SMS quota details
POST
/api/v1/endpoint/{endpoint_id}/quota/sms
Set SMS quota
DELETE
/api/v1/endpoint/{endpoint_id}/quota/sms
Remove SMS quota
GET
/api/v1/endpoint/{endpoint_id}/sms
List sent and received SMS
POST
/api/v1/endpoint/{endpoint_id}/sms
Send SMS to an endpoint
GET
/api/v1/endpoint/{endpoint_id}/sms/{sms_id}
SMS details
DELETE
/api/v1/endpoint/{endpoint_id}/sms/{sms_id}
Cancel SMS
GET
/api/v1/endpoint/{endpoint_id}/stats
Endpoint usage and cost statistics
GET
/api/v1/endpoint/{endpoint_id}/stats/daily
Retrieve daily usage statistics for an endpoint
GET
/api/v1/endpoint/{endpoint_id}/traffic_limit_extension
List active traffic limit extensions
POST
/api/v1/endpoint/{endpoint_id}/traffic_limit_extension
Create traffic limit extension
DELETE
/api/v1/endpoint/{endpoint_id}/traffic_limit_extension
Delete all traffic limit extensions for an endpoint
POST
/api/v2/endpoint/multi
Bulk create endpoints
DELETE
/api/v2/endpoint/multi
Bulk delete endpoints
PATCH
/api/v2/endpoint/multi
Bulk update endpoints
Schemas 149
The contract defines 149 schemas that model the data the API accepts and returns. The most detailed are ApiV1EndpointEndpointIdSmsGetResponsesContentApplicationJsonSchemaItems (23 properties), Endpoint_EndpointSmsByEndpointIdAndSmsIdGet_Response_200 (23 properties), ApiV1EndpointGetResponsesContentApplicationJsonSchemaItems (16 properties), ApiV2EndpointMultiPostResponsesContentApplicationJsonSchemaItems (14 properties). Each schema is shown below with its type and property counts.
ApiV2EndpointMultiPostResponsesContentApplicationJsonSchemaItemsImeiWithLuhn
object
ApiV2EndpointMultiPatchRequestBodyContentApplicationJsonSchemaItemsServiceProfile
object
1 property
ApiV2EndpointMultiPostRequestBodyContentApplicationJsonSchemaStatus
object
Applies to all endpoints.
1 property
1 required
Endpoint_EndpointQuotaSmsByEndpointIdPost_Response_201
object
Empty response body
ApiV1EndpointEndpointIdConnectivityGetResponsesContentApplicationJsonSchemaLocation
object
ApiV1EndpointEndpointIdQuotaSmsPostRequestBodyContentApplicationJsonSchemaActionOnExhaustion
object
2 properties
1 required
ApiV1EndpointEndpointIdQuotaDataGetResponsesContentApplicationJsonSchemaActionOnExhaustionId
string
ApiV1EndpointEndpointIdSmsGetResponsesContentApplicationJsonSchemaItemsSmsType
object
ApiV1EndpointEndpointIdStatsDailyGetResponsesContentApplicationJsonSchemaItemsDataTrafficType
object
Information about the traffic type.
3 properties
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsTagAssignmentsItemsTagColor
object
Color assigned to this tag for UI display.
1 property
ApiV1EndpointEndpointIdQuotaDataPostRequestBodyContentApplicationJsonSchemaActionOnExhaustion
object
2 properties
1 required
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsSimSimProfileType
object
Type of SIM profile.
1 property
ApiV1EndpointEndpointIdPatchRequestBodyContentApplicationJsonSchemaServiceProfile
object
1 property
1 required
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsServiceProfile
object
Service profile that determines network access settings for this endpoint.
2 properties
1 required
ApiV1EndpointEndpointIdEventGetResponsesContentApplicationJsonSchemaItemsImsi
object
ApiV2EndpointMultiPostResponsesContentApplicationJsonSchemaItemsServiceProfile
object
2 properties
2 required
ApiV2EndpointMultiPatchRequestBodyContentApplicationJsonSchemaItemsTariffProfile
object
1 property
ApiV1EndpointEndpointIdEventGetResponsesContentApplicationJsonSchemaItemsEventType
object
ApiV2EndpointMultiPatchRequestBodyContentApplicationJsonSchemaItemsSim
object
2 properties
ApiV1EndpointEndpointIdSmsSmsIdGetResponsesContentApplicationJsonSchemaEndpoint
object
ApiV2EndpointMultiPatchRequestBodyContentApplicationJsonSchemaItemsStatus
object
Endpoint status: 0 (Enabled) or 1 (Disabled)
1 property
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItems
object
16 properties
3 required
ApiV1EndpointEndpointIdOperatorBlacklistGetResponsesContentApplicationJsonSchemaItems
object
5 properties
ApiV1EndpointPostRequestBodyContentApplicationJsonSchemaServiceProfile
object
Service profile that determines network access settings. Must belong to your organization.
1 property
1 required
ApiV1EndpointEndpointIdQuotaSmsPostRequestBodyContentApplicationJsonSchemaActionOnExhaustionDescription
string
ApiV2EndpointMultiPatchRequestBodyContentApplicationJsonSchemaItemsIpAddressSpace
object
Required when setting ipaddress
1 property
ApiV1EndpointEndpointIdQuotaDataPostRequestBodyContentApplicationJsonSchemaActionOnExhaustionId
string
ApiV1EndpointPostRequestBodyContentApplicationJsonSchemaOrganisation
object
Organization to create the endpoint in. Required only for reseller accounts creating endpoints in sub-organizations.
1 property
1 required
ApiV1EndpointPostResponsesContentApplicationJsonSchemaSimStatus
object
SIM activation status.
2 properties
ApiV1EndpointEndpointIdQuotaDataPostRequestBodyContentApplicationJsonSchemaStatus
object
2 properties
1 required
ApiV1EndpointEndpointIdQuotaDataGetResponsesContentApplicationJsonSchemaStatusId
string
ApiV1EndpointEndpointIdGetResponsesContentApplicationJsonSchemaSimStatus
object
2 properties
1 required
Endpoint_GetConnectivityInfoByEndpointId_Response_200
ApiV1EndpointEndpointIdOperatorBlacklistGetResponsesContentApplicationJsonSchemaItemsTapcodeItems
object
ApiV1EndpointEndpointIdQuotaDataPostRequestBodyContentApplicationJsonSchemaStatusDescription
string
ApiV1EndpointEndpointIdSmsPostRequestBodyContentApplicationJsonSchemaSourceAddressType
object
Defines the format of sourceaddress. Required when using alphanumeric sender IDs.
1 property
ApiV1EndpointEndpointIdConnectivityGetResponsesContentApplicationJsonSchemaStatus
object
ApiV1EndpointEndpointIdQuotaDataGetResponsesContentApplicationJsonSchemaActionOnExhaustionDescription
string
ApiV1EndpointPostResponsesContentApplicationJsonSchemaServiceProfile
object
Service profile assigned to this endpoint.
2 properties
2 required
ApiV1EndpointEndpointIdSmsGetResponsesContentApplicationJsonSchemaItemsSourceAddressType
object
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsStatus
object
Endpoint connectivity status. Values are 0 (Enabled), 1 (Disabled), or 2 (Deleted).
2 properties
1 required
ApiV1EndpointEndpointIdStatsDailyGetResponsesContentApplicationJsonSchemaItemsSmsTrafficType
object
Information about the traffic type.
3 properties
ApiV1EndpointEndpointIdEventGetResponsesContentApplicationJsonSchemaItems
object
11 properties
ApiV1EndpointEndpointIdGetResponsesContentApplicationJsonSchemaTariffProfile
object
2 properties
1 required
ApiV2EndpointMultiPostRequestBodyContentApplicationJsonSchemaServiceProfile
object
Applies to all endpoints.
1 property
1 required
ApiV1EndpointEndpointIdQuotaSmsPostRequestBodyContentApplicationJsonSchemaActionOnExhaustionId
string
ApiV1EndpointEndpointIdEventGetResponsesContentApplicationJsonSchemaItemsOrganisation
object
ApiV1EndpointEndpointIdSmsGetResponsesContentApplicationJsonSchemaItems
object
23 properties
ApiV1EndpointEndpointIdQuotaDataPostRequestBodyContentApplicationJsonSchemaActionOnExhaustionDescription
string
ApiV1EndpointEndpointIdStatsDailyGetResponsesContentApplicationJsonSchemaItemsDataCurrency
object
Currency used for cost calculations.
3 properties
ApiV1EndpointPostResponsesContentApplicationJsonSchemaSim
object
SIM card assigned to this endpoint. null if no SIM is assigned.
7 properties
ApiV1EndpointPostRequestBodyContentApplicationJsonSchemaTariffProfile
object
Tariff profile that determines pricing and data limits. Must belong to your organization.
1 property
1 required
Endpoint_EndpointSmsByEndpointIdAndSmsIdDelete_Response_200
object
Empty response body
ApiV1EndpointEndpointIdSmsGetResponsesContentApplicationJsonSchemaItemsStatus
object
ApiV1EndpointEndpointIdStatsDailyGetResponsesContentApplicationJsonSchemaItemsSms
object
SMS usage for this day.
6 properties
ApiV2EndpointMultiPostResponsesContentApplicationJsonSchemaItemsSim
object
ApiV1EndpointEndpointIdConnectivityInfoGetResponsesContentApplicationJsonSchemaOneOf0SubscriberInfoLocationCellGlobalId
object
4 properties
EndpointByIdPatchRequestUnprocessableEntityError
object
4 properties
4 required
EndpointQuotaDataByEndpointIdPostRequestUnprocessableEntityError
object
1 property
EndpointGetConnectivityInfoByEndpointIdResponse2002
object
3 properties
BulkUpdateEndpointRequestUnprocessableEntityError
object
4 properties
4 required
ApiV2EndpointMultiPostRequestBodyContentApplicationJsonSchemaEndpointsItems
object
Each item represents an endpoint to create.
6 properties
Endpoint_EndpointQuotaDataByEndpointIdPost_Response_201
object
Empty response body
Endpoint_EndpointByIdGet_Response_200
object
14 properties
3 required
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsTariffProfile
object
Tariff profile that determines pricing and data limits for this endpoint.
2 properties
1 required
Endpoint_EndpointSmsByEndpointIdAndSmsIdGet_Response_200
object
23 properties
ApiV1EndpointPostResponsesContentApplicationJsonSchemaIpAddressSpace
object
IP address space containing this endpoint's private IP address.
1 property
ApiV1EndpointEndpointIdEventGetResponsesContentApplicationJsonSchemaItemsSim
object
ApiV1EndpointPostRequestBodyContentApplicationJsonSchemaIpAddressSpace
object
IP address space for the endpoint. Required if ipaddress is provided.
1 property
1 required
ApiV1EndpointEndpointIdEventGetResponsesContentApplicationJsonSchemaItemsEventSource
object
ApiV1EndpointEndpointIdStatsDailyGetResponsesContentApplicationJsonSchemaItemsSatGeoData
object
Satellite data usage for this day (if applicable).
4 properties
ApiV1EndpointEndpointIdGetResponsesContentApplicationJsonSchemaIpAddressSpace
object
1 property
ApiV2EndpointMultiPostRequestBodyContentApplicationJsonSchemaIpAddressSpace
object
Required if any endpoint in the endpoints array has an ipaddress.
1 property
1 required
ApiV1EndpointEndpointIdGetResponsesContentApplicationJsonSchemaStatus
object
2 properties
1 required
ApiV1EndpointEndpointIdSmsGetResponsesContentApplicationJsonSchemaItemsEndpoint
object
GetConnectivityInfoByEndpointIdRequestNotFoundError
object
3 properties
ApiV1EndpointEndpointIdSmsSmsIdGetResponsesContentApplicationJsonSchemaSmsType
object
ApiV2EndpointMultiPostRequestBodyContentApplicationJsonSchemaEndpointsItemsSim
object
If provided for any endpoint, it must include a valid id (cannot be empty).
3 properties
1 required
ApiV1EndpointEndpointIdGetResponsesContentApplicationJsonSchemaSim
object
6 properties
1 required
ApiV2EndpointMultiPostResponsesContentApplicationJsonSchemaItemsTariffProfile
object
3 properties
3 required
EndpointGetConnectivityInfoByEndpointIdResponse2001
object
2 properties
ApiV1EndpointEndpointIdQuotaDataGetResponsesContentApplicationJsonSchemaActionOnExhaustion
object
2 properties
1 required
ApiV2EndpointMultiPostRequestBodyContentApplicationJsonSchemaOrganisation
object
If provided, it must include a valid id (cannot be empty).
1 property
1 required
ApiV1EndpointEndpointIdStatsDailyGetResponsesContentApplicationJsonSchemaItemsData
object
Cellular data usage for this day.
6 properties
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsTagAssignmentsItems
object
3 properties
ApiV2EndpointMultiPostRequestBodyContentApplicationJsonSchemaEndpointsItemsSimStatus
object
1 property
1 required
ApiV1EndpointPostResponsesContentApplicationJsonSchemaStatus
object
Endpoint connectivity status.
2 properties
2 required
CreateEndpointRequestUnprocessableEntityError
object
5 properties
4 required
ApiV2EndpointMultiPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
ApiV1EndpointEndpointIdQuotaDataPostRequestBodyContentApplicationJsonSchemaStatusId
string
ApiV1EndpointEndpointIdConnectivityGetResponsesContentApplicationJsonSchemaPdpContext
object
ApiV1EndpointPostRequestBodyContentApplicationJsonSchemaStatus
object
Initial endpoint status.
1 property
1 required
ApiV1EndpointPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
ApiV1EndpointEndpointIdSmsSmsIdGetResponsesContentApplicationJsonSchemaStatus
object
ApiV2EndpointMultiPostResponsesContentApplicationJsonSchemaItemsIpAddressSpace
object
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsRuntimeData
object
Real-time network attachment data. Only present when the endpoint is connected.
3 properties
Endpoint_EndpointSmsByIdPost_Response_201
object
Empty response body
ApiV1EndpointEndpointIdQuotaSmsPostRequestBodyContentApplicationJsonSchemaStatus
object
2 properties
1 required
ApiV1EndpointEndpointIdPatchRequestBodyContentApplicationJsonSchemaTariffProfile
object
1 property
1 required
ApiV1EndpointEndpointIdStatsGetResponsesContentApplicationJsonSchemaCurrentMonth
object
ApiV1EndpointEndpointIdGetResponsesContentApplicationJsonSchemaRuntimeData
object
3 properties
ApiV1EndpointEndpointIdStatsDailyGetResponsesContentApplicationJsonSchemaItemsSmsCurrency
object
Currency used for cost calculations.
3 properties
ApiV1EndpointEndpointIdGetResponsesContentApplicationJsonSchemaServiceProfile
object
2 properties
1 required
ApiV2EndpointMultiPatchRequestBodyContentApplicationJsonSchemaItemsSimStatus
object
SIM status: 1 (Activated) or 5 (Factory Test)
1 property
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsIpAddressSpace
object
IP address space that contains this endpoint's private IP address.
1 property
ApiV1EndpointPostRequestBodyContentApplicationJsonSchemaSimStatus
object
Explicitly set the SIM status, overriding the default activation behavior.
1 property
1 required
ApiV1EndpointEndpointIdConnectivityInfoGetResponsesContentApplicationJsonSchemaOneOf0SubscriberInfo
object
3 properties
ApiV1EndpointEndpointIdOperatorBlacklistGetResponsesContentApplicationJsonSchemaItemsMncItems
object
ApiV1EndpointEndpointIdPatchRequestBodyContentApplicationJsonSchemaSim
object
2 properties
2 required
Endpoint_EndpointStatsByIdGet_Response_200
object
3 properties
ApiV1EndpointEndpointIdOperatorBlacklistGetResponsesContentApplicationJsonSchemaItemsCountry
object
ApiV1EndpointPostRequestBodyContentApplicationJsonSchemaSim
object
SIM card to assign to this endpoint. If omitted, no SIM is assigned.
3 properties
1 required
ApiV1EndpointEndpointIdPatchRequestBodyContentApplicationJsonSchemaIpAddressSpace
object
1 property
1 required
ApiV1EndpointEndpointIdQuotaSmsPostRequestBodyContentApplicationJsonSchemaStatusId
string
EndpointOperatorBlacklistByEpIdAndOperatorIdDeleteRequestNotFoundError
object
3 properties
EndpointOperatorBlacklistByEpIdAndOperatorIdPutRequestConflictError
object
3 properties
ApiV1EndpointEndpointIdEventGetResponsesContentApplicationJsonSchemaItemsEventSeverity
object
ApiV1EndpointEndpointIdQuotaDataGetResponsesContentApplicationJsonSchemaStatus
object
2 properties
1 required
BulkCreateEndpointRequestUnprocessableEntityError
object
4 properties
4 required
ApiV1EndpointEndpointIdConnectivityInfoGetResponsesContentApplicationJsonSchemaOneOf0SubscriberInfoLocation
object
3 properties
Endpoint_EndpointConnectivityByIdGet_Response_200
object
4 properties
ApiV2EndpointMultiPostResponsesContentApplicationJsonSchemaItemsStatus
object
1 property
1 required
ApiV1EndpointEndpointIdSmsSmsIdGetResponsesContentApplicationJsonSchemaSourceAddressType
object
ApiV1EndpointEndpointIdEventGetResponsesContentApplicationJsonSchemaItemsEndpoint
object
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsSimEuiccProfileData
object
eSIM profile data. Present only for eSIM-capable SIMs.
ApiV2EndpointMultiPatchRequestBodyContentApplicationJsonSchemaItems
object
11 properties
1 required
ApiV1EndpointStatusGetResponsesContentApplicationJsonSchemaItems
object
2 properties
1 required
ApiV1EndpointEndpointIdStatsGetResponsesContentApplicationJsonSchemaLastHour
object
ApiV2EndpointMultiPostRequestBodyContentApplicationJsonSchemaTariffProfile
object
Applies to all endpoints.
1 property
1 required
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsSim
object
SIM card assigned to this endpoint. null if no SIM is assigned.
9 properties
1 required
Endpoint_CreateEndpoint_Response_201
object
14 properties
14 required
ApiV1EndpointEndpointIdStatsDailyGetResponsesContentApplicationJsonSchemaItemsSatGeoSms
object
Satellite SMS usage for this day (if applicable).
4 properties
ApiV1EndpointEndpointIdQuotaDataGetResponsesContentApplicationJsonSchemaStatusDescription
string
Endpoint_CreateEndpointTrafficLimitExtension_Response_201
object
6 properties
6 required
ApiV2EndpointMultiPatchResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
ApiV1EndpointEndpointIdQuotaSmsPostRequestBodyContentApplicationJsonSchemaStatusDescription
string
ApiV1EndpointEndpointIdPatchRequestBodyContentApplicationJsonSchemaSimStatus
object
1 property
1 required
ApiV2EndpointMultiDeleteRequestBodyContentApplicationJsonSchemaItems
object
1 property
1 required
ApiV2EndpointMultiPostResponsesContentApplicationJsonSchemaItems
object
14 properties
14 required
Endpoint_EndpointQuotaDataByEndpointIdGet_Response_200
object
9 properties
4 required
ApiV1EndpointEndpointIdPatchRequestBodyContentApplicationJsonSchemaStatus
object
1 property
1 required
ApiV1EndpointEndpointIdStatsDailyGetResponsesContentApplicationJsonSchemaItems
object
5 properties
EndpointGetConnectivityInfoByEndpointIdResponse2000
object
3 properties
ApiV1EndpointEndpointIdPatchResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
ApiV1EndpointEndpointIdTrafficLimitExtensionGetResponsesContentApplicationJsonSchemaItems
object
6 properties
6 required
ApiV1EndpointPostResponsesContentApplicationJsonSchemaTariffProfile
object
Tariff profile assigned to this endpoint.
3 properties
3 required
ApiV1EndpointEndpointIdConnectivityInfoGetResponsesContentApplicationJsonSchemaOneOf2SubscriberInfo
object
2 properties
ApiV1EndpointEndpointIdStatsGetResponsesContentApplicationJsonSchemaLastMonth
object
ApiV1EndpointGetResponsesContentApplicationJsonSchemaItemsSimStatus
object
SIM activation status.
2 properties
1 required
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_euicc API
emnify subpackage_euiccOperation API
emnify subpackage_events API
emnify subpackage_integrations API
#subpackage_endpoint