{
"opencollection": "1.0.0",
"info": {
"name": "emnify REST API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "subpackage_integrations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve list of API callback URLs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/api_callback",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieve list of API callback URLs"
},
{
"info": {
"name": "Create a callback URL",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/api_callback",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Callback URL"
},
{
"info": {
"name": "Get a callback URL by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/api_callback/:api_callback_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "api_callback_id",
"value": "",
"type": "path",
"description": "A numeric ID of an API Callback URL"
}
]
},
"docs": "Get a callback URL by ID"
},
{
"info": {
"name": "Delete a callback URL",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/api_callback/:api_callback_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "api_callback_id",
"value": "",
"type": "path",
"description": "A numeric ID of an API Callback URL"
}
]
},
"docs": "Delete a callback URL"
},
{
"info": {
"name": "List API callback secrets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/api_secret",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Lists API callback secrets.\n\n\n The `secret` property itself is not returned in this call.\n\n"
},
{
"info": {
"name": "Create a callback secret",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/api_secret",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new secret that may be used by API callbacks.\n\nWhen an `api_secret` is assigned to a Service Profile with an API callback, API requests towards this URL will contain an `Authorization` header with a JSON Web Token.\nThe `api_secret` is used as the **Signing Key** of the JWT.\n"
},
{
"info": {
"name": "Get a callback secret by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/api_secret/:api_secret_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "api_secret_id",
"value": "",
"type": "path",
"description": "A numeric ID of an API secret"
}
]
},
"docs": "Get a callback secret by ID"
},
{
"info": {
"name": "Delete a callback secret",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/api_secret/:api_secret_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "api_secret_id",
"value": "",
"type": "path",
"description": "A numeric ID of an API Secret"
}
]
},
"docs": "Delete a callback secret"
},
{
"info": {
"name": "List data stream configurations of your organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/data_stream",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "List data stream configurations of your organization"
},
{
"info": {
"name": "Create data stream",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/data_stream",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Data Stream to your destination.\nClick on Examples to see available Data Streams and configuration parameters.\n\nCurrently available `connection_types` are\n- `AwsKinesis`\n- `S3`\n- `RestAPI`\n- `KeenIO`\n- `Datadog`\n- `EventHubs`\n- `PubSub`\n"
},
{
"info": {
"name": "Get data stream filter fields",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/data_stream/filter_field_type",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Get data stream filter fields"
},
{
"info": {
"name": "Get data stream statuses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/data_stream/status",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Lists possible data stream statuses.\n\n(`1`) is the normal `Running` state meaning your data stream is active and streams data.\n\n(`2`) indicates a `Paused` data stream. It will not send messages to your destination.\nHowever, messages meant for this data stream are routed and will be stored up to 7 days.\nYou will first receive historic data once you resume a paused streamer after longer pausing.\n\n(`3`) indicates that an `Error` has occurred. This might be problems in the configuration (e.g. missin"
},
{
"info": {
"name": "Get data stream types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/data_stream/type",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "List available Data Stream Types.\n\n(`1`) will only stream `Usage` Data.\n\n(`2`) will only stream `Event` Data.\n"
},
{
"info": {
"name": "Get details on existing data stream",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/data_stream/:data_stream_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "data_stream_id",
"value": "",
"type": "path",
"description": "ID of a data stream."
}
]
},
"docs": "Get data stream configuration and status by ID.\n"
},
{
"info": {
"name": "Modify existing data stream",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v2/data_stream/:data_stream_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "data_stream_id",
"value": "",
"type": "path",
"description": "ID of a data stream."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify existing data stream"
},
{
"info": {
"name": "Delete existing data stream",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v2/data_stream/:data_stream_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "data_stream_id",
"value": "",
"type": "path",
"description": "ID of a data stream."
}
]
},
"docs": "Delete existing data stream"
},
{
"info": {
"name": "Restart existing data stream",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/data_stream/:data_stream_id/restart",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "data_stream_id",
"value": "",
"type": "path",
"description": "ID of a data stream."
}
]
},
"docs": "Restart your Existing Data Stream.\nThis might be necessary when e.g. your Webhook endpoint has been unreachable for an extended period of time.\nWebhook Data Stream will exhaust retries and go into Error State.\nBy using this API call your Data Stream will be restarted and continue trying to send data.\n"
}
]
},
{
"info": {
"name": "subpackage_applicationTokens",
"type": "folder"
},
"items": [
{
"info": {
"name": "List application tokens",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/application_token",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns the list of application tokens for the organisation of the requesting user."
},
{
"info": {
"name": "Create application token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/application_token",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new application token.\nID must not be specified, as it is auto-generated and returned in case of a successful JSON response.\nYou can provide following fields with this request:\n\n* `description` (String, optional)\n* `expiry_date` with optional time + time zone (String, optional)\n* `ip` - IP Address in CIDR notation (String, optional)\n"
},
{
"info": {
"name": "Update application token",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/application_token/:app_token_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "app_token_id",
"value": "",
"type": "path",
"description": "application token ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The `description` of the token may be updated and the\nApplication Token can be revoked by updating the `status`.\nThe possible statuses of tokens are\n\n* `\"id\": 0` - Activated\n* `\"id\": 1` - Revoked\n"
}
]
},
{
"info": {
"name": "subpackage_authentication",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve authentication token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/authenticate",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns a [JSON Web Token (JWT)](/developers/auth/jwts) `auth_token` for authenticating further requests to the API.\n\n\n This API path has a rate limit of 100 requests per IP in a 5-minute window.\n Make sure to store your authentication token to avoid hitting this limit.\n For more information, see [Rate limits](/developers/api-guidelines/rate-limits).\n\n\n### Multi-factor authentication flow\n\nWhen multi-factor authentication (MFA) is enabled for a user account:\n\n1. **Initial login**"
},
{
"info": {
"name": "Create an MFA key",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/user/mfa",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Generate and store a MFA key for the requesting user. After this call, the MFA key has the status `activation pending` and must be activated through a separate call (`/api/v1/user/mfa/{id}`).\n\nYou must provide following fields with this request:\n\n* `type` (Object required)\n - `id` (Number)\n* `password` (String required) - User password\n\nThe **MFA key** object returned by the server contains the following properties:\n\n* `id` (Integer) - The unique ID of this MFA key\n* `status` (Object) ID (Integ"
},
{
"info": {
"name": "List MFA key statuses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/user/mfa/status",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieve a list of possible MFA Key statuses."
},
{
"info": {
"name": "List MFA key types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/user/mfa/type",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieve a list of possible MFA Key types."
},
{
"info": {
"name": "Activate MFA key",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/user/mfa/:key_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "key_id",
"value": "",
"type": "path",
"description": "The unique identifier of the MFA key to activate.\nThis ID is returned when you [create the MFA key](/developers/api/authentication/post-mfa).\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Activates a pending MFA key for the authenticated user.\n\nAfter you [create an MFA key](/developers/api/authentication/post-mfa), the key has status `Activation Pending`.\nTo complete setup, call this endpoint with the MFA key ID and a valid 6-digit time-based one-time password (TOTP) generated from the `secret_key` or `otpauth` URI returned during creation.\n\nOnce activated, the MFA key status changes to `Active`, and MFA is enforced on subsequent logins with [user credentials](/developers/auth/us"
},
{
"info": {
"name": "List trusted devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/user/:user_id/mfa/trusted_device",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "User ID"
}
]
},
"docs": "Returns the list of trusted devices for a given user.\n\nThe list of one's own trusted devices can also be retrieved with a call to either\n`/api/v1/user/my/mfa/trusted_device` or `/api/v1/user/mfa/trusted_device`\n"
},
{
"info": {
"name": "Delete a trusted device",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/user/:user_id/mfa/trusted_device/:device_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "User ID"
},
{
"name": "device_id",
"value": "",
"type": "path",
"description": "Device ID"
}
]
},
"docs": "Deletes a trusted device.\n\nRemoving one's own trusted device can also be performed at either `/api/v1/user/my/mfa/trusted_device/{id}` or `/api/v1/user/mfa/trusted_device/{id}`\n"
},
{
"info": {
"name": "Delete an MFA key",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/user/:user_id/mfa/:key_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "key_id",
"value": "",
"type": "path",
"description": "Key ID"
},
{
"name": "user_id",
"value": "",
"type": "path",
"description": "User ID"
}
]
},
"docs": "Delete an MFA key for a given user.\n\nAn own MFA key can also be deleted with a call to `/api/v1/user/my/mfa/{key_id}`\n"
}
]
},
{
"info": {
"name": "subpackage_workspaces",
"type": "folder"
},
"items": [
{
"info": {
"name": "Switch to an assigned Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/authenticate/workspace",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Switch to an assigned Workspace and receive an authentication token for the target Workspace.\n\n\n This endpoint requires authentication with [user credentials](/developers/auth/user-credentials) (not an application token), as application tokens are scoped to a single Workspace.\n\n The returned `auth_token` is valid for the target Workspace.\n Your original token remains valid for the source Workspace.\n\n"
},
{
"info": {
"name": "Accept user invitation",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/user/activation",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Accepts a user invitation to join a Workspace.\n\nThe following fields may be provided:\n- `activationKey` (String, required) - the JWT token received in the verification email\n- `password` (String) - only mandatory if the user is invited to an organization without single sign-on (SSO) and doesn't have a password yet\n- `name` (String) - name of the user\n"
},
{
"info": {
"name": "Update a user's default Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v2/user/:user_id/default_organisation/:workspace_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
},
{
"name": "workspace_id",
"value": "",
"type": "path"
}
]
},
"docs": "Update a user's default Workspace.\n\n\n You must have **Administrator** access in both the old and new default Workspaces to execute this call.\n\n"
},
{
"info": {
"name": "List assigned Workspaces",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/user/:user_id/workspace",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieve a list of the Workspaces assigned to a user.\n\n\n Only returns Workspaces where you have **Administrator** access.\n\n"
},
{
"info": {
"name": "Update user status in a Workspace",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v2/user/:user_id/workspace/:workspace_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
},
{
"name": "workspace_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a user's status in the requested Workspace.\n\n- Allowed statuses: `ACTIVE` (1) and `SUSPENDED` (2)\n- If the user is suspended in their default Workspace, the next active Workspace is assigned as the default Workspace.\n\n\n You must have **Administrator** access in the requested Workspace to update user statuses.\n\n"
},
{
"info": {
"name": "Unassign a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v2/user/:user_id/workspace/:workspace_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
},
{
"name": "workspace_id",
"value": "",
"type": "path"
}
]
},
"docs": "Unassign a Workspace from a user.\n\n- If the user is deleted from their default Workspace, the next active Workspace is assigned as the default Workspace.\n- **SuperAdmins** can't be removed unless you're logged in to the main organization.\n\n\n You must have **Administrator** access in the requested Workspace to remove users.\n\n"
},
{
"info": {
"name": "Assign a role to a Workspace user",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
},
{
"name": "workspace_id",
"value": "",
"type": "path"
},
{
"name": "role_id",
"value": "",
"type": "path"
}
]
},
"docs": "Assign a role to a user in the requested Workspace.\n\n\n You must have **Administrator** access in the requested Workspace to modify user roles.\n **SuperAdmin** roles also can't be modified unless you're logged in to the main organization.\n\n"
},
{
"info": {
"name": "Remove a role from a Workspace user",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v2/user/:user_id/workspace/:workspace_id/role/:role_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
},
{
"name": "workspace_id",
"value": "",
"type": "path"
},
{
"name": "role_id",
"value": "",
"type": "path"
}
]
},
"docs": "Remove a user's role in the requested Workspace.\n\n\n You must have **Administrator** access in the requested Workspace to modify user roles.\n **SuperAdmin** roles also can't be modified unless you're logged in to the main organization.\n\n"
},
{
"info": {
"name": "Retrieve Workspace daily stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/workspace/stats/daily",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Filters by start date, provided in a `YYYY-MM-DD` format.\n\n\n If you don't define an end date, the response will include 6 months of data, beginning on the current date.\n\n"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Filters by end date, provided in an `YYYY-MM-DD` format.\n\n\n If you don't define a start date, the response will only return data from the month indicated in your end date.\n\n"
},
{
"name": "workspace_ids",
"value": "",
"type": "query",
"description": "Comma separated list of workspace IDs to filter the results for.\nIf not provided, the response will include all Workspaces you have access to.\n"
}
]
},
"docs": "Retrieve the daily stats for your Workspaces.\n"
}
]
},
{
"info": {
"name": "subpackage_automations",
"type": "folder"
},
"items": [
{
"info": {
"name": "List configured automations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/automation",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of all configured automations for the organization.\n"
},
{
"info": {
"name": "Create an automation",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/automation",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates an automation with the configured event and selected actions, respecting the configured targets.\n"
},
{
"info": {
"name": "List available actions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/automation/action",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of all available actions, as well as their possible configuration parameters and required fields.\nAvailability depends on the parent organization.\n"
},
{
"info": {
"name": "Get an action by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/automation/action/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieves a specified available actions, as well as the possible configuration parameters and required fields.\nAvailability depends on the parent organization.\n"
},
{
"info": {
"name": "List action logs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/automation/log",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "automationId",
"value": "",
"type": "query"
},
{
"name": "automationExecutionNumber",
"value": "",
"type": "query"
}
]
},
"docs": "Returns a list of all action logs for this organization.\n"
},
{
"info": {
"name": "Verify an automation recipient's email address",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/automation/recipient/email/verification",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Verifies the email address of an automation recipient using the verification token sent to the recipient via email.\n"
},
{
"info": {
"name": "Get configured automation by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/automation/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieves the specified configured automation.\n"
},
{
"info": {
"name": "Update an automation",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/automation/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an automation with the configured event and selected actions, respecting the configured targets.\n"
},
{
"info": {
"name": "Delete a configured automation",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/automation/:id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Deletes the specified configured automation.\n"
}
]
},
{
"info": {
"name": "subpackage_lookups",
"type": "folder"
},
"items": [
{
"info": {
"name": "List breakout regions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/breakout_region",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Provides the list of available breakout regions."
},
{
"info": {
"name": "List country codes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/country",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "geographic",
"value": "",
"type": "query",
"description": "Filters the country list for geographic countries only.\nThis will exclude duplicate countries with different MCCs, like `India MCC 405` or `United States (311)`.\n"
}
]
},
"docs": "Provides the list of available countries (lookup)."
},
{
"info": {
"name": "List currencies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/currency",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Provides the list of available currencies (lookup)."
},
{
"info": {
"name": "List data blocksizes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/data_blocksize",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Provides the list of available data blocksizes (lookup)."
},
{
"info": {
"name": "List data throttles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/data_throttle",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Provides the list of available data throttles (lookup)."
},
{
"info": {
"name": "List ESME interface types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/esme_interface_type",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Provides the list of available ESME interface types."
},
{
"info": {
"name": "List RAT types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/rat_type",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of supported RAT types.\n"
},
{
"info": {
"name": "Get list of service levels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/service_level",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of service levels that can be configured on a tariff plan level.\nFor non-enterprise organisations, only own service levels will be returned.\nFor enterprise organisations, only the service levels of the parent organisation will be returned.\n"
}
]
},
{
"info": {
"name": "subpackage_cloudConnect",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all Cloud Connect attachments of an organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/cnc/breakout",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "status",
"value": "",
"type": "query",
"description": "Numerical ID of the Cloud Connect attachment status\n\n* `1` - Pending Customer Action\n* `2` - Pending AWS Activation\n* `3` - Pending EGN Activation\n* `4` - Pending CRG Activation\n* `5` - Active\n* `6` - Deactivation Pending\n* `7` - Deactivated\n* `8` - Rolling Back\n"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Numerical ID of the Cloud Connect attachment type\n\n* `1` - Transit Gateway\n* `2` - IPSec VPN\n* `3` - IPSec VPN BGP\n* `4` - IPSec VPN BGP High Availability\n* `5` - Direct Connect\n* `6` - Shared\n* `7` - Transit Gateway (Classic)\n* `8` - IPSec VPN (Classic)\n"
},
{
"name": "organisation",
"value": "",
"type": "query",
"description": "Numerical ID of an Organization"
}
]
},
"docs": "Lists all Cloud Connect attachments of the logged in organisation if it is an Enterprise. For Master organisations\nit lists all attachments of the direct child organisations. Deleted attachments are left out by default.\n\nAdditionally the attachments can be filtered by status and type.\nMaster organisations can also filter by organisation ID of their direct child organisations.\n"
},
{
"info": {
"name": "Create a Cloud Connect attachment via Transit Gateway",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/cnc/breakout/tgw",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a Transit Gateway breakout towards the customer AWS account.\n\nAfter the creation the following steps have to be made from the customer's AWS account:\n\n1. Accept the resource share about the 'CloudConnect' TransitGateway\n2. Create a Transit Gateway Attachment to the own VPC with the services to connect to\n\nMore Information about this can be found on the Cloud Connect Knowledge Base article.\n"
},
{
"info": {
"name": "Create a Cloud Connect attachment via IPSec VPN",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/cnc/breakout/vpn",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a Cloud Connect attachment via a specified VPN server.\nCurrently two attachment types are available:\n\n- **Static VPN** (type `2`): Basic IPSec VPN connection\n- **Dynamic VPN with BGP** (type `3`): IPSec VPN with BGP routing.\n Requires `asn` (Autonomous System Number), otherwise dynamic routing is disabled.\n Optionally accepts `inside_cidr` for BGP tunnel interfaces.\n\nThe `on_prem_cidr` parameter specifies the CIDR ranges of your backend network (up to 3).\nThe `public_ip` is the public "
},
{
"info": {
"name": "View details of a Cloud Connect attachment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/cnc/breakout/:cloudconnect_attachment_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "cloudconnect_attachment_id",
"value": "",
"type": "path"
}
]
},
"docs": "Displays the details including configured CIDR blocks of a Cloud Connect Attachment.\n\nFor active IPSec VPN attachments, the tunnel information (public IP, outisde address, inside CIDR, PSK, ASN)\nincluding metrics over the last hour (tunnel state, bytes in/out) will be displayed as well.\n"
},
{
"info": {
"name": "Retry creation of an expired TGW breakout",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/cnc/breakout/:cloudconnect_attachment_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "cloudconnect_attachment_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retries the creation of a Transit Gateway breakout where the accept attachment state has expired, meaning the\nattachment on the customer's side has not been created in time.\n\nRetry is only allowed if:\n- The breakout is of type `Transit Gateway (type_id: 1)`\n- The breakout is in status `Pending AWS Activation (status_id: 2)`\n- The accept attachment state has expired (7 days after creation)\n"
},
{
"info": {
"name": "Delete a specific Cloud Connect attachment",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/cnc/breakout/:cloudconnect_attachment_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "cloudconnect_attachment_id",
"value": "",
"type": "path"
}
]
},
"docs": "Deletes the specified Cloud Connect attachment.\n\nAttachments cannot be deleted if they are in the state `7 (Deactivated)` or `8 (Rolling Back)` or if they are Classic attachments.\n"
},
{
"info": {
"name": "List Cloud Connect breakout types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/cnc/breakout_type",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Lists all Cloud Connect breakout types.\n"
},
{
"info": {
"name": "Get list of available Cloud Connect regions by breakout type",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/cnc/breakout_type/:breakout_type_id/available_region",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "breakout_type_id",
"value": "",
"type": "path",
"description": "ID of a Cloud Connect breakout type. Possible values can be retrieved with `GET /api/v1/cnc/breakout_type`.\n"
}
]
},
"docs": "Returns a list of regions available for use when creating new Cloud Connect breakouts of the selected breakout type.\n\nIf the attachment region is peered to another one, the device breakout region will also be returned.\n"
},
{
"info": {
"name": "List Cloud Connect prices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/cnc/pricing",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of the configured monthly prices for Cloud Connect breakouts.\n\nMaster organisation, Mobile Network Operators and Resellers will get the list of prices they have configured\nfor their child organisations.\n\nEnterprise organisations will get the list of prices that apply for them.\n"
}
]
},
{
"info": {
"name": "subpackage_serviceLookupsAndConfiguration",
"type": "folder"
},
"items": [
{
"info": {
"name": "List DNS configs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/dns",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieves a list of DNS configurations.\nDNS settings can be applied to a service profile and endpoints which use this service profile will have the associated DNS settings applied.\n"
},
{
"info": {
"name": "Create DNS config",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/dns",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a DNS configuration object. The DNS config can be applied to a service profile and all endpoints which use that service profile will have the associated DNS settings applied.\nDNS changes are instantly applied to any **new PDP context**.\nConnected devices with previously established PDPs will continue to use the previous nameserver config until the next time they reconnect.\n\nPrimary and secondary nameservers and IP version (`4` for IPV4 or `6` for IPV6) must be specified with this request"
},
{
"info": {
"name": "Delete DNS config",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/dns/:dns_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "dns_id",
"value": "",
"type": "path",
"description": "DNS configuration ID"
}
]
},
"docs": "Delete a DNS configuration object by ID.\n\n\n A DNS config object cannot be deleted if it is in use by at least one Service Profile.\n\n"
},
{
"info": {
"name": "List services",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/service",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieves a collection of available services. Services are read only objects.\n\nService objects contain expanded traffic limit nested objects.\n"
},
{
"info": {
"name": "Get service SMS limit",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/service/:service_id/traffic_limit",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "service_id",
"value": "",
"type": "path"
}
]
},
"docs": "SMS limits are system configuration parameters defined for a single service.\nSMS limits do not have direct effect, but have to be explicitly assigned to an endpoint or a service profile.\n"
},
{
"info": {
"name": "List traffic limits",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/traffic_limit",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieves a list of available traffic limits."
}
]
},
{
"info": {
"name": "subpackage_endpoint",
"type": "folder"
},
"items": [
{
"info": {
"name": "List endpoints",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "q",
"value": "",
"type": "query",
"description": "Filters endpoints by field value.\nUse `:` format.\nCombine multiple filters with commas (for example, `status:0,tags:sensor`).\n"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sorts endpoints by field value.\nUse `` format.\nCombine multiple sort fields with commas (for example, `-status,id`).\n\n**Operators:**\n- `-` descending (Z-A for text, highest number first)\n- `+` ascending (A-Z for text, lowest number first)\n\nDefaults to ascending order if no operator is specified.\nDefaults to `id` if no sort field is specified.\nEndpoints with identical values are sorted by ascending `id`.\n"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number to retrieve.\nStarts at 1.\n"
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of endpoints to return per page."
}
]
},
"docs": "Retrieves all endpoints for your organization.\nUse the query parameters to filter, sort, and paginate results.\n"
},
{
"info": {
"name": "Create an endpoint",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/endpoint",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a single endpoint with the specified configuration.\n\n\n For bulk operations, use [`POST /api/v2/endpoint/multi`](/developers/api/endpoint/bulk-create-endpoint) instead (supports up to 2,000 endpoints per request).\n\n\n\n emnify charges for activated SIMs, even if the endpoint status is set to **Disabled**.\n\n"
},
{
"info": {
"name": "List endpoint statuses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/status",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of available [endpoint statuses](/developers/reference/endpoint#endpoint-statuses)."
},
{
"info": {
"name": "Endpoint details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieves endpoint details for a given ID."
},
{
"info": {
"name": "Update an endpoint",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the details of an endpoint.\n\n\n Execute this operation sequentially - wait for each request to complete before starting the next.\n\n For bulk updates, use [`PATCH /api/v2/endpoint/multi`](/developers/api/endpoint/bulk-update-endpoint) instead (supports up to 2,000 endpoints).\n\n\n\n emnify charges for activated SIMs, even if the endpoint `status` is set to **Disabled**.\n To avoid accruing unexpected charges, update the SIM `status` to **Suspended** (`\"id\": 2`).\n\n Execute this operation sequentially - wait for each request to complete before starting the next.\n\n For bulk deletions, use [`DELETE /api/v2/endpoint/multi`](/developers/api/endpoint/bulk-delete-endpoint) instead (supports up to 2,000 endpoints).\n\n\n\n Endpoints with an assigned SIM cannot be deleted (results in a `409` error).\n\n"
},
{
"info": {
"name": "Endpoint connectivity status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/connectivity",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieve details about current connectivity status of endpoint.\nThe following is a list of possible statuses:\n\n* `ATTACHED`:\nThe Endpoint has succesfully attached to the Home Core network in the past.\nThe device will be shown as `ATTACHED` until the visited network has signaled that the device is inactive/offline.\nUsually the visited network informs the Core Network within 1-2 days after a device went offline.\n\n* `ONLINE`:\nThe Endpoint has an active data connection\n\n* `OFFLINE`:\nThe Endpoint has"
},
{
"info": {
"name": "Reset endpoint connectivity",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/connectivity",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Dispatches a message that causes either a `Cancel Location`, `Delete PDP Context`, or both sent to the endpoint.\nThe return of the call doesn't yet mean the event has been sent towards the device.\n\n\n Master organization types can reset any endpoints inside their organization hierarchy.\n Enterprises may only reset connectivity of own endpoints.\n\n"
},
{
"info": {
"name": "Retrieve connectivity information for an endpoint",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/connectivity_info",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Returns device location information based on the cell tower to which the device is connected.\n\n\n emnify validates the data requested, sends the signal request to the network operator, and interprets the response.\n Whether the network returns useful data is outside of emnify's control.\n\n To distinguish these cases, this call returns the HTTP `200 OK` response code whenever the request is successfully executed, even if it includes an error.\n See the response body for details.\n\n"
},
{
"info": {
"name": "List endpoint events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/event",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path",
"description": "Numeric ID of an endpoint"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Current page number"
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Defines the number of items per page"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n"
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid_with_luhn:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n"
}
]
},
"docs": "Returns the list of events, filtered, sorted and paged according to query parameters.\n\n\nA full list of events is found in section \"Retrieve Event Types\" (`/api/v1/event/type`).\n\n\n\n This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (`/api/v1/endpoint/{endpoint_id}`).\n In case the requested `{endpoint_id}` doesn't exist or is not accessible for the user, **HTTP 200** will be returned with empty **[]** as "
},
{
"info": {
"name": "List operator blacklist for endpoint",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/operator_blacklist",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Returns a list of blacklisted Operators for the requested Endpoint"
},
{
"info": {
"name": "Add an operator to the blacklist",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/operator_blacklist/:operator_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
},
{
"name": "operator_id",
"value": "",
"type": "path"
}
]
},
"docs": "Adds an Operator to the Blacklist of an Endpoint."
},
{
"info": {
"name": "Remove an operator from the blacklist",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/operator_blacklist/:operator_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
},
{
"name": "operator_id",
"value": "",
"type": "path"
}
]
},
"docs": "Remove Operator from the Blacklist of an Endpoint."
},
{
"info": {
"name": "Retrieve data quota details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/quota/data",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Returns details about the assigned Data Quota for an endpoint.\n* `status`: this indicates the current status of the quota and may contain the following values:\n - `ACTIVE`: the endpoint can currently connect and has quota left\n - `EXHAUSTED`: the endpoint has exceeded the quota volume, if it still can use data service depends on the action chosen to be performed on exhaustion\n - `EXPIRED`: the quota has expired; the endpoint is denied from using data services (until new quota is added)\n"
},
{
"info": {
"name": "Set data quota",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/quota/data",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set a new data quota.\nYou can set a new data quota for a device at any time.\nAt an initial state, when no data quota is set, the device is denied from using data services.\nTo top-up the data volume, you need to retrieve the remaining volume, increase it by the top-up volume, and set it as the new quota volume.\n\n\n We have deprecated throttling as an action on quota exhaustion and the associated peak throughput parameter.\n These were decommissioned as of December 9, 2024.**\n\n\n"
},
{
"info": {
"name": "Remove data quota",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/quota/data",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Will delete the data quota for the endpoint, if any is set.\n\n\n If `apply_data_quota` is still set in the service profile, the endpoint will get blocked from data service.\n\n"
},
{
"info": {
"name": "Show SMS quota details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/quota/sms",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Returns details about the assigned SMS Quota for an endpoint.\n\nYou can retrieve the current SMS quota status for an endpoint with the following API call. It will return following properties:\n* `status`: this indicates the status of the quota and may contain the following values:\n - `ACTIVE`: the endpoint has quota left and can use SMS services\n - `EXHAUSTED`: the endpoint has exceeded the quota volume; the endpoint is denied from using SMS services (until new quota is added)\n - `EXPIRED`: the"
},
{
"info": {
"name": "Set SMS quota",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/quota/sms",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "At any time, a new SMS quota can be set for an endpoint.\nAt an initial state when no SMS quota is set, the endpoint will be denied from using SMS services.\nTo top-up the SMS volume one need to retrieve the currently left volume, increase it by the top-up volume and set it as the new quota volume.\n\nThe following parameters can be configured:\n* `status` - The status of the quota (mandatory):\n - 1: `ACTIVE`\n - 2: `EXHAUSTED`\n - 3: `EXPIRED`\n* `volume`: The volume left on this quota in MB\n* `expi"
},
{
"info": {
"name": "Remove SMS quota",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/quota/sms",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Will delete the SMS quota for the endpoint, if any is set.\n\n\n If `apply_sms_quota` is still set in the service profile, the endpoint is blocked from sending SMS.\n\n"
},
{
"info": {
"name": "List sent and received SMS",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/sms",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Returns the list of SMS sent and received by this endpoint.\n\nA description of the SMS statuses is as follows:\n\n- `1`: Delivery attempt pending\n- `2`: In progress\n- `3`: Buffered\n- `4`: Delivered\n- `5`: Failed\n- `6`: Expired\n- `7`: Canceled\n"
},
{
"info": {
"name": "Send SMS to an endpoint",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/sms",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Sends a mobile terminating SMS (MT-SMS) to a connected device.\nThe device must have an active SIM with SMS capability enabled in its service profile.\n\n## Use cases\n\n### Standard SMS\n\nSend an SMS with a numeric sender ID.\nSet `source_address` to the sender's phone number (for example, `12345689`) and include your message in `payload`.\n\n### Alphanumeric sender ID\n\nDisplay a custom sender name instead of a phone number.\nSet `source_address` to your brand name (for example, `CompanyName`, up to 11 c"
},
{
"info": {
"name": "SMS details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/sms/:sms_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
},
{
"name": "sms_id",
"value": "",
"type": "path"
}
]
},
"docs": "Returns details about an Endpoint SMS by SMS ID.\n\nA description of the SMS statuses is as follows:\n\n- `1`: Delivery attempt pending\n- `2`: In progress\n- `3`: Buffered\n- `4`: Delivered\n- `5`: Failed\n- `6`: Expired\n- `7`: Canceled\n"
},
{
"info": {
"name": "Cancel SMS",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/sms/:sms_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
},
{
"name": "sms_id",
"value": "",
"type": "path"
}
]
},
"docs": "Cancel SMS that is buffered for endpoint and not yet delivered."
},
{
"info": {
"name": "Endpoint usage and cost statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/stats",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "\n You can only retrieve data traffic costs for organizations without multi-inclusive volumes.\n\n\nRetrieves endpoint usage and cost statistics for a given ID.\nUsage statistics are sorted by `data` and `sms`.\n\nReturns statistics from the following periods:\n\n- `last_month`: Previous billing month, from the first to last day (for example, April 1-30, 2023, when you send the request sometime in May 2023).\n- `current_month`: Current month, with statistics calculated up to and includ"
},
{
"info": {
"name": "Retrieve daily usage statistics for an endpoint",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/stats/daily",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Filters by start date, provided in a `YYYY-MM-DD` format.\n\n\n If you don't define an end date, the response will include 6 months of data, beginning on the current date.\n\n"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Filters by end date, provided in an `YYYY-MM-DD` format.\n\n\n If you don't define a start date, the response will only return data from the month indicated in your end date.\n\n"
}
]
},
"docs": "Returns daily usage statistics for a specific endpoint, including cellular data and SMS volumes.\n\nBy default, returns statistics for the current month.\nUse `start_date` and `end_date` query parameters to specify a custom date range.\n\n\n Data traffic cost statistics (`cost` field in the `data` object) have been deprecated.\n\n"
},
{
"info": {
"name": "List active traffic limit extensions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/traffic_limit_extension",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Returns all active traffic limit extensions for an endpoint, if any exist.\n\nOnly accessible by users with Administrator, User or Observer roles who belong to the endpoint's organization.\n"
},
{
"info": {
"name": "Create traffic limit extension",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/traffic_limit_extension",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a temporary traffic limit extension for an endpoint.\n\nOnly accessible by users with Administrator or User roles who belong to the endpoint's organization.\n\nRequired fields:\n* `volume` - The traffic volume limit\n"
},
{
"info": {
"name": "Delete all traffic limit extensions for an endpoint",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/endpoint/:endpoint_id/traffic_limit_extension",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path"
}
]
},
"docs": "Removes all traffic limit extensions from an endpoint.\n\nOnly accessible by users with Administrator or User roles who belong to the endpoint's organization.\n\nThe endpoint's traffic limits will revert to their original values defined in the service profile.\n"
},
{
"info": {
"name": "Bulk create endpoints",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/endpoint/multi",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create up to 2,000 endpoints in one request.\n\nUnlike [`POST /api/v1/endpoint`](/developers/api/endpoint/create-endpoint), this bulk endpoint handles multiple endpoints safely in a single request without sequential execution constraints between individual endpoints.\n\n\n Execute bulk operations sequentially - wait for each bulk request to complete before starting the next.\n\n\nIf a `sim` object is provided, the specified SIM is assigned to the endpoint.\nThe `activate` property defaults "
},
{
"info": {
"name": "Bulk update endpoints",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v2/endpoint/multi",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates details of a list of endpoints in bulk.\n\nThe request body must be an array of endpoint objects.\nEach object requires an `id` field to identify the endpoint, and you only need to include the fields you want to update.\n\nUnlike [`PATCH /api/v1/endpoint/{endpoint_id}`](/developers/api/endpoint/endpoint-by-id-patch), this bulk endpoint handles multiple endpoints safely in a single request without sequential execution constraints between individual endpoints.\n\n\n Execute bulk operations "
},
{
"info": {
"name": "Bulk delete endpoints",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v2/endpoint/multi",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "delete_sims",
"value": "",
"type": "query",
"description": "If `true`, the SIMs will be deleted along with the endpoints.\nIf `false`, the SIMs will only be suspended.\nDefaults to `false`.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Deletes a list of endpoints in bulk, along with all child entities.\n\nUnlike [`DELETE /api/v1/endpoint/{endpoint_id}`](/developers/api/endpoint/endpoint-by-id-delete), this bulk endpoint handles multiple endpoints safely in a single request without sequential execution constraints between individual endpoints.\n\n\n Execute bulk operations sequentially - wait for each bulk request to complete before starting the next.\n\n\nIf a SIM is assigned to one of the endpoints, it's released and su"
}
]
},
{
"info": {
"name": "subpackage_euicc",
"type": "folder"
},
"items": [
{
"info": {
"name": "List eUICCs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/euicc",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number (1-based)."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Items per page."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `eid`\n- `supported_profile_type`\n- `status`\n- `eim`\n"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `eid`\n- `modified`\n- `supported_profile_type`\n- `status`\n- `eim`\n"
}
]
},
"docs": "List all eUICCs for your organization.\nUse filter parameters to search for specific eUICCs and sort to order the response list.\n"
},
{
"info": {
"name": "List eUICC Profile status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/euicc/profile/status",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "List possible eUICC Profile statuses.\n"
},
{
"info": {
"name": "List eUICC status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/euicc/status",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "List possible eUICC statuses (reserved for future use).\n"
},
{
"info": {
"name": "Unlinked eUICC validation",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/euicc/unlinked_validation",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate whether the specified eUICCs do not have any existing profiles linked.\n"
},
{
"info": {
"name": "Get eUICC",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/euicc/:euicc_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "euicc_id",
"value": "",
"type": "path"
}
]
},
"docs": "List details on one specific eUICC within your organization.\n"
}
]
},
{
"info": {
"name": "subpackage_euiccOperation",
"type": "folder"
},
"items": [
{
"info": {
"name": "List operation action for eUICC",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/euicc/operation/action",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "List possible IoT eUICC action objects used in responses and requests.\n"
},
{
"info": {
"name": "List operation status for eUICC",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/euicc/operation/status",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "List possible IoT eUICC operation status objects used in responses.\n"
},
{
"info": {
"name": "List operation for eUICC",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/euicc/:euicc_id/operation",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "euicc_id",
"value": "",
"type": "path"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number (1-based)."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Items per page."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `iccid_with_luhn`\n- `creation_date`\n- `expiry_date`\n- `finalization_date`\n"
}
]
},
"docs": "List all operations of a specific IoT eUICC.\nThis route returns HTTP 404 error for non-IoT eUICCs.\n"
},
{
"info": {
"name": "Schedule eUICC operations",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/euicc/:euicc_id/operation",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "euicc_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Schedules one or more operations on the specified eUICC.\nEach array element represents a single operation request.\nThis route returns HTTP 404 error for non-IoT eUICCs.\n"
},
{
"info": {
"name": "Get operation details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/euicc/:euicc_id/operation/:operation_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "euicc_id",
"value": "",
"type": "path"
},
{
"name": "operation_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get details of specific operation for a specific IoT eUICC.\nThis route returns HTTP 404 error for non-IoT eUICCs.\n"
},
{
"info": {
"name": "Cancel operation",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/euicc/:euicc_id/operation/:operation_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "euicc_id",
"value": "",
"type": "path"
},
{
"name": "operation_id",
"value": "",
"type": "path"
}
]
},
"docs": "Cancel a specific operation on specific IoT eUICC (reserved for future use).\n"
}
]
},
{
"info": {
"name": "subpackage_events",
"type": "folder"
},
"items": [
{
"info": {
"name": "List events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/event",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Current page number"
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Defines the number of items per page"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n"
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n"
}
]
},
"docs": "Returns the list of events, filtered, sorted and paged according to query parameters."
},
{
"info": {
"name": "List event types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/event/type",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Provides the list of event_types (lookup)."
}
]
},
{
"info": {
"name": "subpackage_customEvents",
"type": "folder"
},
"items": [
{
"info": {
"name": "List custom events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/event/custom/configuration",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of all available custom events and their supported targeting options.\n"
},
{
"info": {
"name": "Deploy custom event",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/event/custom/configuration",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Deploys a custom event with the specified configuration.\n"
},
{
"info": {
"name": "Get a custom event by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/event/custom/configuration/:custom_event_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "custom_event_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieves a specific custom event and its supported targeting options.\n"
},
{
"info": {
"name": "Delete custom event",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/event/custom/configuration/:custom_event_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "custom_event_id",
"value": "",
"type": "path"
}
]
},
"docs": "Deletes a custom event with the specified configuration.\n"
},
{
"info": {
"name": "List custom event templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/event/custom/template",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of all available custom event templates and their possible configuration parameters.\n"
},
{
"info": {
"name": "Get a custom event template by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/event/custom/template/:template_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "template_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieves a specific custom event template and its possible configuration parameters.\n"
}
]
},
{
"info": {
"name": "subpackage_systemEvents",
"type": "folder"
},
"items": [
{
"info": {
"name": "List system events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/event/system/configuration",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of all available system events and their supported targeting options.\n"
},
{
"info": {
"name": "Get a system event by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/event/system/configuration/:system_event_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "system_event_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieves a specific system event and its supported targeting options.\n"
}
]
},
{
"info": {
"name": "subpackage_ipAddressSpaces",
"type": "folder"
},
"items": [
{
"info": {
"name": "List IP address spaces",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/ip_address_space",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of allocated IP address spaces for your organization."
},
{
"info": {
"name": "Create an IP address space",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/ip_address_space",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Checks the requested IP address space for validity and availability, then allocates it to your organization.\n"
},
{
"info": {
"name": "Get random address spaces",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/ip_address_space/available",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "ip_address_version",
"value": "",
"type": "query",
"description": "Filter by IPv4 which is default or by IPv6.\nExample: `ip_address_version=4` or `ip_address_version=6`\n"
}
]
},
"docs": "Provides a list of 10 random available address spaces (unassigned to any organization).\nAs the list is generated for each request, two successive requests will have different results.\n"
},
{
"info": {
"name": "Assign an IP address space to an organization",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v1/ip_address_space/:address_space_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "address_space_id",
"value": "",
"type": "path"
}
]
},
"docs": "\n Use POST API call instead of this deprecated PUT command.\n\n\nThe IP address space is assigned to the user's organization.\n"
},
{
"info": {
"name": "Release an IP address space from an organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/ip_address_space/:address_space_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "address_space_id",
"value": "",
"type": "path"
}
]
},
"docs": "Release the IP address space from association with the user's organisation.\n\n\n IP address spaces can only be removed, if the IP address space isn't used on any of the organisations endpoints.\n\n"
}
]
},
{
"info": {
"name": "subpackage_operator",
"type": "folder"
},
"items": [
{
"info": {
"name": "List operators",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/operator",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a collection of existing operators.\n\nIt will return an array of items with following properties:\n\n* `id`: identifier of this operator\n* `name`: the official name of the operator\n* `name_and_country`: Name / Country (for easy access in the UI)\n* `country`: country object with the nested country `id`\n* `mnc`: Array of Mobile Network Codes (MNCs)\n* `tapcode`: Array of TAP Codes\n"
}
]
},
{
"info": {
"name": "subpackage_organization",
"type": "folder"
},
"items": [
{
"info": {
"name": "My organization details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/organisation/my",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "You can retrieve details about your own organisation"
},
{
"info": {
"name": "List organization statuses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/organisation/status",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Provides a list of available organisation status (lookup)."
},
{
"info": {
"name": "Get list of active organization inclusive volumes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/organisation/:org_id_or_my/inclusive_volume/active",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "org_id_or_my",
"value": "",
"type": "path",
"description": "Numerical ID of an Organization or the string `my` to use the currently authorized organisation"
}
]
},
"docs": "Returns of a list of inclusive volumes that are currently active in the current billing period for the selected organisation.\nThis will not inclusive volumes that are already expired or have the start date set for a future billing period.\n\nOnly inclusive volumes for the own organisation or direct child organisations are accessible.\n"
},
{
"info": {
"name": "Assign a ratezone inclusive volume to an organization",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v1/organisation/:org_id_or_my/inclusive_volume/:inclusive_volume_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "org_id_or_my",
"value": "",
"type": "path",
"description": "Numerical ID of an Organization or the string `my` to use the currently authorized organisation"
},
{
"name": "inclusive_volume_id",
"value": "",
"type": "path",
"description": "Numerical ID of a ratezone inclusive volume.\nCan be retrieved using `GET /api/v1/tariff/{tariff_id}/ratezone/{ratezone_id}/inclusive_volume`.\n"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assigns a pre-configured ratezone inclusive volume to the specified organization.\n\nThis can be done in self-service as well as for direct child organizations.\nOnly postpaid customers can assign\ninclusive volumes in self-service, while parent organizations can assign inclusive volumes for both postpaid and prepaid child organizations.\nThe inclusive volume is charged and calculated against traffic charges accordingly in every bill\nthat is refreshed from that point on.\nInclusive volume is counted p"
},
{
"info": {
"name": "Monthly organization traffic and cost statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/organisation/:org_id_or_my/stats",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "org_id_or_my",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieves traffic and cost statistics for the selected organization.\n\nTraffic statistics accumulate for the `current_month` and `last_month` of the selected organization and all child organizations.\nAll other returned values (SIM statistics, user counts, etc.) are only for the selected organization.\n"
},
{
"info": {
"name": "Daily organization traffic and cost statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/organisation/:org_id_or_my/stats/daily",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "org_id_or_my",
"value": "",
"type": "path",
"description": "Numerical ID of an organization or the string `my` to use the currently authorized organization.\n"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Filters results to data collected on or after this date.\nIf `end_date` isn't specified, the response includes data through the end of the selected month.\n"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Filters results to data collected before this date.\nMust be used with `start_date`.\n"
}
]
},
"docs": "Retrieves traffic and cost statistics for the selected organization and all child organizations, accumulated per day.\n\n\n By default, this call returns statistics for the current month.\n\n"
},
{
"info": {
"name": "Hourly organization traffic statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/organisation/:org_id_or_my/stats/hourly",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "org_id_or_my",
"value": "",
"type": "path",
"description": "Numerical ID of an organization or the string `my` to use the currently authorized organization.\n"
},
{
"name": "start_date",
"value": "",
"type": "query",
"description": "Filters results to data collected on or after this timestamp.\nIf not specified, the response includes data from the past three hours up to the current time.\n"
},
{
"name": "end_date",
"value": "",
"type": "query",
"description": "Filters results to data collected before this timestamp.\nMust be used with `start_date`.\nIf not specified, defaults to one hour after the current time.\n"
}
]
},
"docs": "Retrieves traffic statistics for the selected organization and all child organizations, accumulated per hour.\n\n\n By default, this call returns statistics for the last three hours.\n\n"
},
{
"info": {
"name": "Update assigned tariff",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/organisation/:org_id/tariff",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "Numerical ID of an organization"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Allows an organisation to change their assigned tariff.\n\nThe following restrictions apply:\n* The organisation must not have more than one tariff assigned.\n* The tariff can be changed only for the own organisation and direct child organisations. The organisation status must be \"ACTIVE\".\n* If performing the change in self-service, the organisation needs to be in evaluation. Parent organisations are allowed to change the tariffs of production organisations.\n* The selected tariff must be active, vis"
},
{
"info": {
"name": "Organization usage and costs statistics per day for the current month",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/stats/daily",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieve usage and costs statistics for the currently logged in organization and all child organizations, accumulated per days from beginning of the month until today.\n\n\n Data traffic costs aren't returned for enterprise organizations with inclusive volume.\n\n"
}
]
},
{
"info": {
"name": "subpackage_tariffPlans",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get the active tariff plan for the given organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/organisation/:org_id_or_my/tariff_plan/active",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "org_id_or_my",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieve detailed information about the currently assigned `tariff_plan` of the given organisation.\nIt can either be accessed for the own organisation or a direct child organisation.\nThe `applied_price` field is calculated using the currently active SIM cards for the month.\n"
},
{
"info": {
"name": "List organization tariff plans",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/organisation/:org_id/tariff_plan",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "Numerical ID of an organization"
}
]
},
"docs": "Retrieve a list of all Tariff Plans that are available for the given organisation.\nThe available tariff plans for one's own organisation can also be retrieved with a call to\n`/api/v1/organisation/my/tariff_plan`\n"
},
{
"info": {
"name": "Retrieve your organization's active tariff plan",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/tariff_plan/active",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieve detailed information about your organization's assigned `tariff_plan`.\n\n\n The `applied_price` field is calculated based on the active SIM cards for the current month.\n\n"
}
]
},
{
"info": {
"name": "subpackage_serviceProfiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "List service profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/service_profile",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieves a collection of all service profiles for your organization.\n\nReturned service profiles contain just the total count of associated services, so this is the short view.\n"
},
{
"info": {
"name": "Create service profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/service_profile",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new Service Profile. A `name` must be specified for the Service Profile and all other fields are optional.\n\nEditable fields:\n* `name` (String required)\n* `description` (String optional)\n* `allowed_3g` (boolean optional, defaults to true)\n* `allowed_4g` (boolean optional, defaults to true). Allows or restricts connectivity for 4G/LTE and LTE-M networks.\n* `allowed_nb_iot` (boolean optional, defaults to true)\n* `allowed_nb_iot_geo` (boolean optional, defaults to false). Allows or restric"
},
{
"info": {
"name": "Retrieve a service profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieve a service profile with a given id."
},
{
"info": {
"name": "Update service profile",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a service profile with a given id.\n\nEditable fields:\n* `name` (String optional)\n* `description` (String optional)\n* `allowed_3g` (boolean optional)\n* `allowed_4g` (boolean optional). Allows or restricts connectivity for 4G/LTE and LTE-M networks.\n* `allowed_nb_iot` (boolean optional)\n* `allowed_nb_iot_geo` (boolean optional). Allows or restricts NB-IoT connectivity over satellite networks.\n* **DEPRECATED** `apply_quota` (boolean optional, defaults to false). Use `apply_data_quota` instead"
},
{
"info": {
"name": "Delete a service profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
}
]
},
"docs": "Deletes a service profile and all its associations with services and traffic limits.\nA service profile can only be deleted if it is **not** selected on an endpoint.\nIf it is not selected on an endpoint, the used_count is 0.\n"
},
{
"info": {
"name": "Remove all quotas of assigned endpoints",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id/quota/:quota_type",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
},
{
"name": "quota_type",
"value": "",
"type": "path"
}
]
},
"docs": "Remove all quotas of endpoints which are assigned to this profile. Notice that `apply_data_quota` and/or\n`apply_sms_quota` have to be patched to false before, otherwise the endpoints will get blocked\nfor having no quota left.\nThis call will also return successfully if no endpoint is assigned or no quotas are set.\n"
},
{
"info": {
"name": "Add a service to a service profile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id/service/:service_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
},
{
"name": "service_id",
"value": "",
"type": "path"
}
]
},
"docs": "Add service to the collection of services associated to a profile.\nMultiple services can be assigned, but each only once.\n\n\n Adding the voice service with an id of `3` to a service profile will be successful, but this feature **isn't enabled** by the platform.\n\n"
},
{
"info": {
"name": "Remove a service from a service profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id/service/:service_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
},
{
"name": "service_id",
"value": "",
"type": "path"
}
]
},
"docs": "Remove service from the collection of services associated to a profile. A service can only be removed if it has no assigned traffic limits."
},
{
"info": {
"name": "Add SMS limit to service profile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id/service/:service_id/traffic_limit/:limit_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
},
{
"name": "service_id",
"value": "",
"type": "path"
},
{
"name": "limit_id",
"value": "",
"type": "path"
}
]
},
"docs": "Add SMS limit to a service policy."
},
{
"info": {
"name": "Remove SMS limit from a service profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id/service/:service_id/traffic_limit/:limit_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
},
{
"name": "service_id",
"value": "",
"type": "path"
},
{
"name": "limit_id",
"value": "",
"type": "path"
}
]
},
"docs": "Removes the SMS Limit (if any) from a given service profile."
},
{
"info": {
"name": "List data limits of service profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id/traffic_limit",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
}
]
},
"docs": "List data limits of the service profile. These have the possibility to add\ncustom `volume` values per data limit, as well if they apply only to data traffic over\nsatellite rat type, which incurs higher cost, or to cellular.\n\nThese data limits will not disable any other traffic limits, but can be used to achieve the\nsame outcome.\n"
},
{
"info": {
"name": "Add data limit to service profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id/traffic_limit",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API endpoint allows you to add a data limit to a service profile.\nA data limit is a rule that defines how much data a service can consume within a certain period.\nThis is useful for managing your data usage and avoiding overage charges.\n\nYou can use this API to customize the data limit for your service profile by specifying the service type, time period, volume threshold, and warning percentage.\nYou can also choose to apply the data limit only to satellite radio access technology (RAT) type"
},
{
"info": {
"name": "Delete all data limits of a service profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id/traffic_limit",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete all data limits. This will not influence the assignment style limits.\n"
},
{
"info": {
"name": "Remove data limit from a service profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/service_profile/:profile_id/traffic_limit/:limit_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "profile_id",
"value": "",
"type": "path"
},
{
"name": "limit_id",
"value": "",
"type": "path"
}
]
},
"docs": "Remove data limit from a service profile"
}
]
},
{
"info": {
"name": "subpackage_sim",
"type": "folder"
},
"items": [
{
"info": {
"name": "List SIMs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "q",
"value": "",
"type": "query",
"description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n* `id`\n* `issuer_org`\n* `reseller_org`\n* `customer_org`\n* `iccid`\n* `iccid_with_luhn`\n* `status`\n* `production_date`\n* `imsi`\n* `msisdn`\n* `endpoint`\n* `model`\n* `eid`\n* `satellite_capable`\n"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort parameter in `` format.\nSort properties according to a comma-separated list from the allowed fields:\n\n* `id`\n* `issuer_org`\n* `reseller_org`\n* `customer_org`\n* `iccid`\n* `eid`\n* `status`\n* `production_date`\n* `endpoint`\n* `model`\n\nIf no sorting options are specified, the response will be sorted by `id`.\n\nSupported operators:\n* `-`: Descending order\n* `+`: Ascending order\n\nThe response will be shown in ascending order if no operator is specified.\n"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Current page number"
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Defines the number of items per page (max. 2500)"
}
]
},
"docs": "Returns a list of SIMs filtered, sorted, and paged according to query parameters."
},
{
"info": {
"name": "Migrate SIMs between Workspaces",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/sim/migration/workspace",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Migrate SIMs from one Workspace to another.\n\n## Requirements\n\n- The calling user must have **Administrator** permissions on both the target and source Workspaces\n- The target Workspace must be an enterprise Workspace\n- Only 500 SIMs can be migrated per request\n- You must provide exactly one of: `sims`, `iccids`, or `iccid_range`\n\n\n This endpoint requires authentication with [user credentials](/developers/auth/user-credentials), as application tokens are scoped to a single Workspace.\n\n Deleted SIMs cannot be recovered.\n\n"
},
{
"info": {
"name": "List SIM statuses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim/status",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns a list of available [SIM statuses](/developers/reference/sim#sim-statuses).\n"
},
{
"info": {
"name": "SIM details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim/:sim_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "sim_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieves SIM details for a given ID."
},
{
"info": {
"name": "Update a SIM",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/sim/:sim_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "sim_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a SIM resource.\n\nYou can provide the following fields with this request:\n* `issuer_org` (Object optional) - change to a direct child organization of the appropriate type\n* `reseller_org` (Object optional) - change to a direct child organization of the appropriate type or empty (`\"reseller_org\": { \"id\": null }` or `\"reseller_org\": {}`)\n* `customer_org` (Object optional) - change to own organization or a direct child organization of type \"Enterprise\" or empty (`\"customer_org\": { \"id\": null"
},
{
"info": {
"name": "Delete a SIM",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/sim/:sim_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "sim_id",
"value": "",
"type": "path"
}
]
},
"docs": "\n Deleted SIMs cannot be recovered.\n\n\nDeletes a SIM.\n\nThe following restrictions apply when deleting SIMs:\n* SIMs with an assigned endpoint cannot be deleted.\n* Resellers cannot delete SIMs they have sold.\n"
},
{
"info": {
"name": "List SIM events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim/:sim_id/event",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "sim_id",
"value": "",
"type": "path",
"description": "Numeric ID of a SIM"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Current page number"
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Defines the number of items per page"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n"
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n"
}
]
},
"docs": "Returns the list of events, filtered, sorted and paged according to query parameters.\n\n\n This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (`/api/v1/sim/{sim_id}`).\n\n In case the requested `{sim_id}` doesn't exist or is not accessible for the user, **HTTP 200** will be returned with empty **[]** as long as the provided `{sim_id}` is a number and all parameters are valid.\n\n Please take that into consideration when b"
},
{
"info": {
"name": "SIM usage and cost statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim/:sim_id/stats",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "sim_id",
"value": "",
"type": "path"
}
]
},
"docs": "\n You can only retrieve data traffic costs for organizations without multi-inclusive volumes.\n\n\nRetrieves SIM usage and cost statistics for a given ID.\nUsage statistics are sorted by `data` and `sms`.\n\nReturns statistics from the following periods:\n* `last_month`: Previous billing month, from the first to last day (for example, February 1-29, 2024, when you send the request in March 2024).\n* `current_month`: Current month, with statistics calculated up to and including the da"
},
{
"info": {
"name": "Daily SIM usage statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim/:sim_id/stats/daily",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "sim_id",
"value": "",
"type": "path"
}
]
},
"docs": "\n Data traffic cost statistics (`cost` field in the `data` object) have been deprecated.\n\n\nRetrieves SIM usage statistics accumulated per day.\nBy default, the response includes statistics for the current month.\n\n`start_date` and an `end_date` can be provided as query parameters to retrieve statistics for a specific time frame.\n\nExample request: `/api/v1/sim/123/stats/daily?end_date=2019-03-21&start_date=2019-03-01`\n"
},
{
"info": {
"name": "Validate SIM batch by BIC",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim_batch/bic/:bic",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "bic",
"value": "",
"type": "path"
}
]
},
"docs": "Checks the given BIC code and the contained SIMs if they can be registered.\n"
},
{
"info": {
"name": "Register a given batch by BIC",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/sim_batch/bic/:bic",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "bic",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Registers the given SIM batch, assigns all SIMs to the organisation,\nand sets the status of all contained SIMs to the given value.\n\nIf the `factory_test_mode_allowed` flag is set to true on the tariff plan assignment\nor it is enabled in the tariff plan, the SIM batch can be also registered with an initial\nstatus of `4 = Factory Test`, thus setting all of the contained SIMs to factory test\nstatus. In turn, the `activation_date` of these SIMs will not be set yet, but when the factory\ntest volume i"
}
]
},
{
"info": {
"name": "subpackage_simOperation",
"type": "folder"
},
"items": [
{
"info": {
"name": "List SIM operations for organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim/operation",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page number (1-based)."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Items per page."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Filter parameter in `:` format.\nExpects a comma-separated list from the allowed fields:\n\n- `id`\n- `action`\n- `status`\n"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):\n\n- `id`\n- `action`\n- `status`\n- `creation_date`\n- `finalization_date`\n"
}
]
},
"docs": "List all SIM operations for your organization.\n"
},
{
"info": {
"name": "Trigger SIM operation",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/sim/operation",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Trigger a SIM operation.\n"
},
{
"info": {
"name": "List SIM operation actions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim/operation/action",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "List possible SIM operation action objects used in responses and requests.\n"
},
{
"info": {
"name": "List SIM operation status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim/operation/status",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "List possible SIM operation status objects used in responses.\n"
},
{
"info": {
"name": "Get SIM operation details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim/operation/:operation_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "operation_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get details of a specific SIM operation.\n"
}
]
},
{
"info": {
"name": "subpackage_simUnlinkedProductStatistics",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get product statistics on unlinked eSIMs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/sim/unlinked_product_stats",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Receive statistics on how many eSIMs are unlinked (available profile status), grouped by products.\n"
}
]
},
{
"info": {
"name": "subpackage_tariffProfiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "List tariff profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/tariff_profile",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns the list of tariff profiles of the user's own organisation."
},
{
"info": {
"name": "Create tariff profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/tariff_profile",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create the specified tariff profile\nID must not be specified, neither in query String, nor in JSON payload.\nYou can provide following fields with this request:\n\n* `name` (String required)\n* `description` (String optional)\n* `tariff` (Object required)\n"
},
{
"info": {
"name": "Tariff profile details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/tariff_profile/:tariff_profile_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
}
]
},
"docs": "Returns tariff profile specified by id. This tariff profile also contains information about the currently valid ratezones of the tariff in the tariff profile and if the ratezone is selected in the tariff profile.\nIt also contains applied custom rates for the included tariffs.\n"
},
{
"info": {
"name": "Update tariff profile",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/tariff_profile/:tariff_profile_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Patch the specified tariff profile.\n\n\n The API doesn't provide feedback if you assign an incompatible tariff profile to a SIM.\n See [Tariff profile](/developers/reference/tariff-profile) for more information.\n\n\nYou can provide following fields with this request:\n\n* `name` (String optional)\n* `description` (String optional)\n* `tariff` (Object optional) If the tariff is changed, all selections of ratezones are removed.\n"
},
{
"info": {
"name": "Delete tariff profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/tariff_profile/:tariff_profile_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
}
]
},
"docs": "Deletes tariff profile. Tariff profiles used by an endpoint (`used_count` > 0) cannot be deleted."
},
{
"info": {
"name": "List tariff profile coverage",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/tariff_profile/:tariff_profile_id/coverage",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path",
"description": "tariff profile ID"
}
]
},
"docs": "Provides the list of countries where that tariff profile can be used."
},
{
"info": {
"name": "Assign inclusive volume to tarriff profile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
},
{
"name": "inclusive_volume_id",
"value": "",
"type": "path"
}
]
},
"docs": "Assignes an inclusive volume to the selected tariff profile.\nIf no inclusive volume is assigned and the customer has multiple active inclusive volumes, the traffic for this tariff profile will be rated as \"Pay As You Go\".\n\nThe selected inclusive volume must not be expired and the tariff profile should not have an inclusive volume assigned yet.\nThe tariff of the tariff profile and the inclusive volume ratezone have to match.\n"
},
{
"info": {
"name": "Unassign inclusive volume from tariff profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/tariff_profile/:tariff_profile_id/inclusive_volume/:inclusive_volume_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
},
{
"name": "inclusive_volume_id",
"value": "",
"type": "path"
}
]
},
"docs": "Unassign the inclusive volume from the selected tariff profile. If the customer has multiple active inclusive volume, the traffic within that tariff profile\nwill be rated as \"Pay As You Go\" afterwards.\n"
},
{
"info": {
"name": "Assign ratezone to tarriff profile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v1/tariff_profile/:tariff_profile_id/ratezone_selection/:ratezone_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
},
{
"name": "ratezone_id",
"value": "",
"type": "path"
}
]
},
"docs": "Only currently valid and active ratezones can be selected for a tariff profile"
},
{
"info": {
"name": "Delete ratezone from tariff profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/tariff_profile/:tariff_profile_id/ratezone_selection/:ratezone_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
},
{
"name": "ratezone_id",
"value": "",
"type": "path"
}
]
},
"docs": "Remove previously selected ratezones from a tariff profile"
},
{
"info": {
"name": "Get the operator blocklist for a specific tariff profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieve blocklist details for operators within a specific tariff profile"
},
{
"info": {
"name": "Get operator blocklist for a specific tariff profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
},
{
"name": "operator_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieve blocklist details for an operator within a specific tariff profile"
},
{
"info": {
"name": "Block the operator completely for a given tariff profile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
},
{
"name": "operator_id",
"value": "",
"type": "path"
}
]
},
"docs": "Block the operator completely.\nIf there are already specific RAT types blocklisted, those entries **aren't** overridden.\n\n\n You don't need a request body for this operation.\n\n"
},
{
"info": {
"name": "Remove an operator from the blocklist",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
},
{
"name": "operator_id",
"value": "",
"type": "path"
}
]
},
"docs": "Removes a specific operator from the blocklist of a given tariff profile.\nIf there are already specific RAT types blocklisted, the entries will NOT be overridden.\n"
},
{
"info": {
"name": "Block specific RAT types",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id/rat_type",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
},
{
"name": "operator_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add a specific operator to the blocklist of a given tariff profile.\nIf the operator is already blocked completely, it is still possible to block specific RAT types.\n"
},
{
"info": {
"name": "Unblock a specific RAT type",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v2/tariff_profile/:tariff_profile_id/operator_blocklist/operator/:operator_id/rat_type/:rate_type_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tariff_profile_id",
"value": "",
"type": "path"
},
{
"name": "operator_id",
"value": "",
"type": "path"
},
{
"name": "rate_type_id",
"value": "",
"type": "path"
}
]
},
"docs": "Unblock a specific RAT type for an operator within a tariff profile."
}
]
},
{
"info": {
"name": "subpackage_userManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "List user accounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/user",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Current page number"
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Filter parameter in `:` format. Multiple filters must be in the format of a comma separated list of the following fields:\n\n* `id`\n* `status`\n* `name`\n* `username`\n* `organisation`\n"
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Defines the number of items per page"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort parameter in `` format.\nExpects a comma-separated list from the allowed fields:\n\n* `id`\n* `status`\n* `name`\n* `username`\n* `organisation`\n* `created`\n"
}
]
},
"docs": "Retrieves the collection of user accounts, filtered, sorted and paged accourding to query parameters.\n"
},
{
"info": {
"name": "Create user",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/user",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a user which is *not active and has no password assigned*.\nThe URL to get the user details is provided as Location Header in the response.\n\n#### ACTIVATION\n\nUpon creation, the user account undergoes an activation process (see services below ) in which she receives an email with activation link.\nFollowing this link the user is asked to set the password and upon successful completion of this process, the account becomes active and operational.\n\nProvided fields:\n\n* `username` (String requir"
},
{
"info": {
"name": "List user roles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/user/role",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Retrieves the collection of available user roles"
},
{
"info": {
"name": "List user statuses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/user/status",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Provides the list of available user status (lookup)."
},
{
"info": {
"name": "Get user by ID or username",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/user/:user_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "User ID"
}
]
},
"docs": "Get a specific user by ID provided the user is within this requesting user's organisation or the organisation's immediate child organisations.\n\n`id` may be one of:\n\n* The numeric ID of the user, e.g. \"123\". This is the top-level `id` object returned by each item in `GET /api/v1/user`\n* Username (email), e.g. \"exampleuser@org.de\". This is the top-level `username` object returned by each item in `GET /api/v1/user`\n"
},
{
"info": {
"name": "Update user by ID",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/user/:user_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Provided fields\n* `username` (String optional) - has to be user's email\n* `name` (String optional)\n* `status` (Object optional)\n* `organisation` (Object optional) - must be the current organisation or not to be provided\n\n#### Notes\n\n* Password is not provided. Separate calls provide password management.\n* The organisation is not modifiable. A user can be updated, if belonging to the same organisation as the requesting user,\nor to an organisation which is a direct child of the requesting user's o"
},
{
"info": {
"name": "Delete user by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/user/:user_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
}
]
},
"docs": "\n **This call is deprecated.**\n Please use DELETE `/api/v2/user/:id` instead.\n\n\n\n A user can be deleted, if belonging to the same organization as the requesting user, or to an organization which is a direct child of the requesting user's organization.\n\n"
},
{
"info": {
"name": "List user events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/user/:user_id/event",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "User ID"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Current page number"
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Defines the number of items per page"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort properties according to a comma separated list of accepted fields. Valid fields are:\n\n* `id` - (**event id**)\n* `timestamp` - (**event timestamp**)\n* `source` - (**event source**)\n* `severity` - (**event severity**)\n* `alert` - (**alert status**)\n* `organisation` - (**organisation name**)\n* `user` - (**user id**)\n* `endpoint` - (**endpoint name**)\n* `tags` - (**endpoint tags**)\n* `ip_address` - (**endpoint ip_address**)\n* `iccid` - (**sim iccid**)\n* `imsi` - (**sim imsi**)\n* `type` - (**event type**)\n"
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Filter parameter in `:` format.\nMultiple filters must be a comma-separated list of the following fields:\n\n* `from` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with until**)\n* `until` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, **only valid with from**)\n* `type` (**event_type**, numerical)\n* `source` (**event_type**, numerical, e.g. 0 = Network), 1 = Policy Control, 2 = API)\n* `severity` (**event_severity**, numerical, e.g. 0 = Info, 1 = Warn), 2 = Critical)\n* `alert` (boolean, e.g. true, false)\n* `description` (**event description**, string)\n* `organisation` (**organisation name**, string)\n* `user` (**user name**, string)\n* `endpoint` (**endpoint name**, string)\n* `tags` (**endpoint tags**, string)\n* `ip_address` (**endpoint IP address**, valid IPv4/IPv6 address)\n* `imei` (**endpoint imei**, numerical string)\n* `iccid` (**sim iccid**, numerical string)\n* `imsi` (**sim imsi**, numerical string)\n* `timestamp` (**date**, format `YYYY-MM-DDTHH:mm:ssZ`, for querying events of 1 day, deprecated in future)\n* `iccid_with_luhn` (**sim iccid with Luhn**, numerical string)\n* `network` (**endpoint network**, string, e.g. Telekom)\n* `rat` (**event pdp context rat type**, numerical string, e.g. 6)\n* `country` (**endpoint country**, string, e.g. Germany)\n\nSome filters can accept up to 6 values which must be separated by the pipe symbol (`|`) or url-encoded as (`%7C`):\n\n* `iccid` (q: iccid:1234567890123456789|8988303000123456789)\n* `iccid_with_luhn` (q: iccid:12345678901234567891|89883030001234567891)\n* `endpoint` (q: endpoint:example_endpoint_name|another_endpoint_name)\n* `type` (q: type:example_event_type|another_event_type)\n* `network` (q: network:example_network|another_network)\n* `rat` (q: rat:example_rat|another_rat)\n* `country` (q: country:example_country|another_country)\n"
}
]
},
"docs": "Returns the list of events, filtered, sorted and paged according to query parameters.\n\nOnly an administrator or observer may be allowed to see events of other users, provided they belong to an organisation he/she has access to.\n\nAny user can retrieve their own events at `/api/v1/user/my/event`.\n\n\n This API endpoint deviates from the specified conventions and may not return the same HTTP Codes as the higher layer call (`/api/v1/user/{user_id|my}`).\n\n In case the requested `{user_id}` doe"
},
{
"info": {
"name": "List user role permissions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v1/user/:user_id/role/permission",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "User ID"
}
]
},
"docs": "Role permissions available to this user.\n\nOnly an administrator or observer is allowed to see the role permissions of other users, provided they belong to an organisation he/she has access to.
\n\nAny user can also retrieve one's own role permissions at:\n`/api/v1/user/my/role/permission`.\n"
},
{
"info": {
"name": "Assign role to user",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://cdn.emnify.net/api/v1/user/:user_id/role/:role_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
},
{
"name": "role_id",
"value": "",
"type": "path"
}
]
},
"docs": "Role is assigned to this user."
},
{
"info": {
"name": "Delete user role",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v1/user/:user_id/role/:role_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
},
{
"name": "role_id",
"value": "",
"type": "path"
}
]
},
"docs": "Release a Role from association with this user.\n\n\n A role can only be removed if it's not the last role of this user.\n\n"
},
{
"info": {
"name": "Create support access token for given user",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/user/:user_id/support_token",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "user_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a bearer token that can be used to acces the portal as the target user. Additionally\nadmin or observer role can be selected. The role will not be applied to the user, only to the token.\n\nThe access can be made through cannel-partner hierarchies as well.\nAn event will be generated on the accessed organisation.\n"
}
]
},
{
"info": {
"name": "subpackage_passwordManagementAndActivation",
"type": "folder"
},
"items": [
{
"info": {
"name": "Activate user",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/user/activation",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Activates the user account and sets a password.\nThe activation key is sent via email.\n\n\n This is a public (unauthenticated) service which ignores auth tokens.\n\n"
},
{
"info": {
"name": "Resend user activation email",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v1/user/activation_resend",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Re-sends activation mail to the user.\n\nAs this endpoint is open to the public (no authentication token necessary), it requires instead the google reCAPTCHA token to ensure that no robot is performing the request.\nMoreover, there's a time limit on how often a given user may be issued with a new activation mail.\n\n\n According to the [reCAPTCHA documentation](https://developers.google.com/recaptcha/docs/display) a \"Site Key\" is necessary.\n If you want to implement this feature in your client"
},
{
"info": {
"name": "Change password",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v1/user/password",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Changes the password for the currently authenticated user.\n\n\n The client application should invalidate the authentication token.\n\n"
},
{
"info": {
"name": "Invite a user",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/user/invitation",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Invite a user to a Workspace by specifying username and the roles that the user will have in the organization.\nThis user is created and a `User invited` event is sent.\nThere is no additional action such as an email sent.\n\nThe following fields may be provided:\n- `username` (String) - Email of the invited user\n- `name` (String) - Name of the invited user\n- `organisation` (Object) - Defaults to the default Workspace of the requesting user\n- `roles` (Array) - Assigns the **Administrator** role by de"
}
]
},
{
"info": {
"name": "subpackage_tagManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Bulk assign tags",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/bulk-operations/endpoint/add-tags",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assigns tags in bulk to multiple endpoints.\n"
},
{
"info": {
"name": "Bulk unassign tags",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/bulk-operations/endpoint/remove-tags",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Unassign tags from multiple endpoints in bulk.\n"
},
{
"info": {
"name": "Bulk delete tags",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/bulk-operations/tag/delete-tags",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Deletes tags in bulk.\n"
},
{
"info": {
"name": "List endpoint tags",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/endpoint/:endpoint_id/tags",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path",
"description": "Numeric ID of an endpoint"
}
]
},
"docs": "Returns a list of tags assigned to the provided endpoint.\n"
},
{
"info": {
"name": "Assign a tag to an endpoint",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/endpoint/:endpoint_id/tags",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path",
"description": "Numeric ID of an endpoint"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assigns a tag to the provided endpoint.\nTo successfully assign a tag, you must include the tag's ID in the request body.\n"
},
{
"info": {
"name": "Unassign a tag from an endpoint",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v2/endpoint/:endpoint_id/tags/:tag_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "endpoint_id",
"value": "",
"type": "path",
"description": "Numeric ID of an endpoint"
},
{
"name": "tag_id",
"value": "",
"type": "path",
"description": "The tag ID"
}
]
},
"docs": "Unassigns a tag from the provided endpoint.\nTo successfully unassign a tag, you must include the tag's ID in the request body.\n"
},
{
"info": {
"name": "Returns the list of available tag colors",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/tag-colors",
"headers": [
{
"name": "Authorization",
"value": ""
}
]
},
"docs": "Returns the list of available tag colors"
},
{
"info": {
"name": "List tags",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://cdn.emnify.net/api/v2/tags",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "name",
"value": "",
"type": "query",
"description": "The tag name"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Current page number"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Defines the number of items per page"
}
]
},
"docs": "Returns a list of all registered tags within the organization.\n"
},
{
"info": {
"name": "Create a tag",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cdn.emnify.net/api/v2/tags",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a tag with the given name and color ID.\n\nIf no color ID is provided, a random color is assigned to the tag.\n"
},
{
"info": {
"name": "Update a tag",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://cdn.emnify.net/api/v2/tags/:tag_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tag_id",
"value": "",
"type": "path",
"description": "The tag ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a tag with the provided name and color ID.\n"
},
{
"info": {
"name": "Delete a tag",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cdn.emnify.net/api/v2/tags/:tag_id",
"headers": [
{
"name": "Authorization",
"value": ""
}
],
"params": [
{
"name": "tag_id",
"value": "",
"type": "path",
"description": "The tag ID"
}
]
},
"docs": "Deletes a tag and it removes all associations with resources (for example, devices or automations).\n"
}
]
}
],
"bundled": true
}