{ "opencollection": "1.0.0", "info": { "name": "Soracom API", "version": "20250903-043502" }, "items": [ { "info": { "name": "Analysis", "type": "folder" }, "items": [ { "info": { "name": "Execute a new SQL query asynchronously", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/analysis/queries", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Executes a SQL query asynchronously. You can check the status of a SQL query execution with the [Analysis:getAnalysisQueries API](#/Analysis/getAnalysisQueries)." }, { "info": { "name": "Retrieve the execution status of a SQL query", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/analysis/queries/:query_id", "params": [ { "name": "query_id", "value": "", "type": "path", "description": "SQL query ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the execution status of a SQL query." }, { "info": { "name": "Retrieve available database schemas", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/analysis/schemas", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the available schemas and their column information within the database. You can use this information as a reference when converting data types of data retrieved with the [Analysis:startAnalysisQueries API](#/Analysis/startAnalysisQueries).\nExample: If the column `type` is `string` as shown below, it can be treated as a string.\n```json\n{\n \"name\": \"SIM_SESSION_EVENTS\",\n \"columnInfo\": [\n {\n \"name\": \"APN\",\n \"type\": \"string\",\n \"databaseType\": \"TEXT\",\n " } ] }, { "info": { "name": "AuditLog", "type": "folder" }, "items": [ { "info": { "name": "Retrieve audit logs for Soracom API calls", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/audit_logs/api", "params": [ { "name": "api_kind", "value": "", "type": "query", "description": "Filter item for audit log retrieval by API kind (e.g. `/v1/auth`)." }, { "name": "from_epoch_ms", "value": "", "type": "query", "description": "Start time for the log search range (unixtime milliseconds)." }, { "name": "to_epoch_ms", "value": "", "type": "query", "description": "End time for the log search range (unixtime milliseconds)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to retrieve (value range is 1 to 1000)." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of `requestedTimeEpochMs` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list from the next page onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve audit logs for Soracom API calls." }, { "info": { "name": "Retrieve audit logs for Soracom Napter", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/audit_logs/napter", "params": [ { "name": "resource_type", "value": "", "type": "query", "description": "Type of the target resource to query log entries." }, { "name": "resource_id", "value": "", "type": "query", "description": "Identity of the target resource to query log entries." }, { "name": "from", "value": "", "type": "query", "description": "Start time for the log search range (unixtime milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "End time for the log search range (unixtime milliseconds)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to retrieve (value range is 1 to 1000)." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of `time` in the last log entry retrieved in the previous page. By specifying this parameter, you can continue to retrieve the list from the next page onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve audit logs for Soracom Napter." } ] }, { "info": { "name": "Auth", "type": "folder" }, "items": [ { "info": { "name": "Performs authentication to access to the Soracom API.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/auth", "body": { "type": "json", "data": "{}" } }, "docs": "Performs authentication to access to the Soracom API. Please include the following information in your request.\n\n- To perform authentication by a root account, specify `email` and `password`.\n- To perform authentication by an AuthKey, specify `authKeyId` and `authKey`.\n- To perform authentication by a SAM user, specify `operatorId`, `userName` and `password`.\n\nAn API key and API token will be included in the response if successful. Use the API key and API token to perform subsequent requests.\n" }, { "info": { "name": "Revokes an API key and API token in order to remove access to the Soracom API.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/auth/logout", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Revokes the API key and API token that was used to call this API. Once revoked, the API key and API token cannot be used to make further requests to the API, regardless of the key and token's original expiration time. This API can be called regardless of any permission settings." }, { "info": { "name": "Issues a password reset token for the operator.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/auth/password_reset_token/issue", "body": { "type": "json", "data": "{}" } }, "docs": "Generates a password reset token and sends it to the operator's primary email address. After receiving the password reset token, call /v1/auth/password_reset_token/verify API with the token to update the operator's password." }, { "info": { "name": "Verifies the password reset token and updates password.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/auth/password_reset_token/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the operator's password if the password reset token is verified." }, { "info": { "name": "Generates an API key and an API token to call APIs as a different user.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/auth/switch_user", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Using the API key and API token of the original user, call this API to issue an API key and API token of the target user that you are switching to. The original user should already be registered in the target user's trust policy. See [User:updateUserTrustPolicy](#!/User/updateUserTrustPolicy) for information on updating the trust policy." } ] }, { "info": { "name": "Batch", "type": "folder" }, "items": [ { "info": { "name": "List batch groups.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/batch_groups", "params": [ { "name": "limit", "value": "10", "type": "query", "description": "Maximum number of batch groups to retrieve. The number of batch groups returned may be less than the specified value." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of batch groups." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of batch groups." }, { "info": { "name": "Create batch group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/batch_groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Create a new batch group for organizing and managing batch jobs. To create a batch job, use the [Batch:createBatchJob](#/Batch/createBatchJob) instead.\n" }, { "info": { "name": "Get batch group.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/batch_groups/:batch_group_id", "params": [ { "name": "batch_group_id", "value": "", "type": "path", "description": "Batch group ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns details of the specified batch group.\n" }, { "info": { "name": "Update batch group.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/batch_groups/:batch_group_id", "params": [ { "name": "batch_group_id", "value": "", "type": "path", "description": "Batch group ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the name or description of the specified batch group.\n" }, { "info": { "name": "Delete batch group.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/batch_groups/:batch_group_id", "params": [ { "name": "batch_group_id", "value": "", "type": "path", "description": "Batch group ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete the specified batch group. Batch groups can only be deleted if there are no running batch jobs in the group.\n" }, { "info": { "name": "List batch jobs.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/batch_groups/:batch_group_id/jobs", "params": [ { "name": "batch_group_id", "value": "", "type": "path", "description": "Batch group ID." }, { "name": "limit", "value": "10", "type": "query", "description": "Maximum number of batch jobs to retrieve. The number of batch jobs returned may be less than the specified value." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of batch jobs." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of batch jobs in the specified batch group." }, { "info": { "name": "Create and run batch job.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/batch_groups/:batch_group_id/jobs", "params": [ { "name": "batch_group_id", "value": "", "type": "path", "description": "Batch group ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Create a new batch job and run it. A batch job consists of multiple tasks, each representing an API operation to be performed. Tasks are executed using the permissions of the user that created the batch job API. Batch job information is retained for 32 days.\n\n**System Limits:**\n\n- Each batch job is limited to a single API action. Mixing different APIs in the same job is not supported.\n- Each batch job is limited to a maximum of 10,000 tasks.\n- Only one batch job per API action can be created and" }, { "info": { "name": "Get batch job.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/batch_groups/:batch_group_id/jobs/:job_id", "params": [ { "name": "batch_group_id", "value": "", "type": "path", "description": "Batch group ID." }, { "name": "job_id", "value": "", "type": "path", "description": "Batch job ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns information about the specified batch job.\n" }, { "info": { "name": "List tasks.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/batch_groups/:batch_group_id/jobs/:job_id/tasks", "params": [ { "name": "batch_group_id", "value": "", "type": "path", "description": "Batch group ID." }, { "name": "job_id", "value": "", "type": "path", "description": "Batch job ID." }, { "name": "limit", "value": "10", "type": "query", "description": "Maximum number of tasks to retrieve. The number of tasks returned may be less than the specified value." }, { "name": "status", "value": "", "type": "query", "description": "Filter by task status." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header returned in the response to the last request. Specify this to retrieve the next page of tasks." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of tasks in the specified batch job. Each task represents an individual API operation executed as part of the batch job.\n" } ] }, { "info": { "name": "Billing", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of finalized past billing history", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/bills", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets a list of finalized past billing history.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Gets a finalized past billing history for the specified month", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/bills/:yyyyMM", "params": [ { "name": "yyyyMM", "value": "", "type": "path", "description": "Target year and month" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets a finalized past billing history for the specified month. If you specify current month (the month in which the usage fee has not yet been finalized), you will get the preliminary value.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Get a daily bill", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/bills/:yyyyMM/daily", "params": [ { "name": "yyyyMM", "value": "", "type": "path", "description": "Target year and month" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets a daily bill for the specified month. Fees charged on a monthly basis cannot be retrieved. If you specify current month (a month for which the fee has not yet been finalized), a preliminary value will be returned.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Export historical Detailed billing CSV to dedicated storage", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/bills/:yyyyMM/export", "params": [ { "name": "yyyyMM", "value": "", "type": "path", "description": "Target year and month" }, { "name": "export_mode", "value": "", "type": "query", "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Export historical [Detailed billing CSV](/en/docs/account/billing/#detailed-billing-csv) to dedicated storage and issue URL to download.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Get latest bill", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/bills/latest", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the preliminary usage fee for the current month (the month in which the usage fee has not yet been finalized)." }, { "info": { "name": "Export latest billing CSV file to S3", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/bills/latest/export", "params": [ { "name": "export_mode", "value": "", "type": "query", "description": "Specify how to get the URL to download the billing details CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the billing details CSV is huge, use `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the billing details CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Export [Detailed Billing CSV](/en/docs/account/billing/#detailed-billing-csv) for current month (the month in which the usage fee has not yet been finalized) to dedicated storage and issue a URL to download it. The fees will be finalized by the second business day of the following month. The Detailed billing CSV exported using this API will output preliminary values." }, { "info": { "name": "Gets a billing summary of bill items.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/bills/summaries/bill_items", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get a billing summary of bill items for the last 4 months (this month to 3 months ago). Sorted by date from newest to oldest.\n\nThe summary you can get from this API is equivalent to the usage fees displayed in the [COSTS BY SERVICE] panel of the Billing Dashboard. For more information, please refer to [Billing Information](/en/docs/account/billing/).\n" }, { "info": { "name": "Gets a billing summary of SIMs", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/bills/summaries/sims", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get a billing summary of SIMs for the last 4 months (current month to 3 months ago). Sorted by date from newest to oldest.\n\nThe summary you get from this API is equivalent to the rates displayed in the [COSTS PER SIM (TOP 100)] panel of the Rates Dashboard. For more information, please refer to [Billing Information](/en/docs/account/billing/).\n" } ] }, { "info": { "name": "CellLocation", "type": "folder" }, "items": [ { "info": { "name": "Get location information for a cell tower", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/cell_locations", "params": [ { "name": "mcc", "value": "440", "type": "query", "description": "MCC - Mobile Country Code." }, { "name": "mnc", "value": "10", "type": "query", "description": "MNC - Mobile Network Code." }, { "name": "lac", "value": "", "type": "query", "description": "LAC - Location Area Code (for 3G)." }, { "name": "cid", "value": "", "type": "query", "description": "CID - Cell ID (for 3G)." }, { "name": "tac", "value": "5680", "type": "query", "description": "TAC - Tracking Area Code (for 4G)." }, { "name": "ecid", "value": "48872466", "type": "query", "description": "ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. The result is the same regardless of which value is specified." }, { "name": "eci", "value": "", "type": "query", "description": "ECID - Enhanced Cell ID (for 4G) - specify either `ecid` or `eci`. The result is the same regardless of which value is specified." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves location information (latitude/longitude) for a cell tower based on cell information such as Cell ID.\n\n- For 3G, please specify MCC, MNC, LAC, and CID. It is possible to retrieve approximate location information without CID, but the accuracy will be low.\n\n 3G example\n ```\n $ curl -X GET \"https://api.soracom.io/v1/cell_locations?mcc=440&mnc=10&lac=196\" \\\n -H \"X-Soracom-API-Key: $X_SORACOM_API_KEY\" \\\n -H \"X-Soracom-Token: $X_SORACOM_TOKEN\"\n ```\n\n- For LTE (4G), please s" }, { "info": { "name": "List location information for multiple cell towers.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/cell_locations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a list of location information (latitude/longitude) for multiple cell towers based on cell information such as Cell ID. For 3G, please specify MCC, MNC, LAC, and CID. It is possible to retrieve approximate location information without CID, but the accuracy will be low. For LTE (4G), please specify MCC, MNC, TAC, and ECID. The conversion of cell tower information to location information uses the OpenCelliD Project database, so it is possible that the information may not exist or may be " } ] }, { "info": { "name": "Payment", "type": "folder" }, "items": [ { "info": { "name": "List coupons.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/coupons", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of currently registered coupons." }, { "info": { "name": "Register Coupon", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/coupons/:coupon_code/register", "params": [ { "name": "coupon_code", "value": "", "type": "path", "description": "Coupon code." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Registers a coupon." }, { "info": { "name": "Get payment transaction result.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/payment_history/transactions/:payment_transaction_id", "params": [ { "name": "payment_transaction_id", "value": "", "type": "path", "description": "Payment transaction ID. It can be obtained via [Billing:getBillingHistory API](#!/Billing/getBillingHistory) or [Billing:getBilling API](#!/Billing/getBilling)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns result of a payment transaction.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Get current payment method information.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/payment_methods/current", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns current payment methods. Detailed information is included in the properties." }, { "info": { "name": "Activate current payment method", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/payment_methods/current/activate", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Activates a current payment method that has an error." }, { "info": { "name": "List payment statements", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/payment_statements", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "List payment statements.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Export payment statement", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/payment_statements/:payment_statement_id/export", "params": [ { "name": "payment_statement_id", "value": "", "type": "path", "description": "Payment statement ID" }, { "name": "export_mode", "value": "", "type": "query", "description": "Export mode (async, sync)" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Export payment statement.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Export payer information", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/payment_statements/payer_information", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Export payer information." }, { "info": { "name": "Register payer information", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/payment_statements/payer_information", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Register payer information." }, { "info": { "name": "List long term discounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/volume_discounts", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of contracted long term discounts.\n\n**Warning**: Information can be obtained up to 18 months in the past or 6 months after the contract ends. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Get long term discount", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/volume_discounts/:contract_id", "params": [ { "name": "contract_id", "value": "", "type": "path", "description": "Contract ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns contracted long term discount.\n\n**Warning**: Information can be obtained up to 18 months in the past or 6 months after the contract ends. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" } ] }, { "info": { "name": "Order", "type": "folder" }, "items": [ { "info": { "name": "Create coupon quotation", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/coupons", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a new coupon quotation. If the orderId is put in /coupons/{order_id}/confirm, the order is complete." }, { "info": { "name": "Confirm coupon order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/coupons/:order_id/confirm", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "Order ID. You can get it by calling [Order:createCouponQuotation API](#/Order/createCouponQuotation)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Performs a credit limit and confirms the order if no problems are encountered." }, { "info": { "name": "Get a list of confirmed order history", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/orders", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get a list of confirmed order history.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Create Quotation", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/orders", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a new order quotation. If the orderId is put in /orders/{order_id}/confirm, the order is complete." }, { "info": { "name": "Get a confirmed order", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/orders/:order_id", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a confirmed order.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Cancel order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/orders/:order_id/cancel", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Cancels an order. If the order has already been dispatched, an error is returned." }, { "info": { "name": "Confirm order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/orders/:order_id/confirm", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Performs a credit limit and confirms the order if no problems are encountered.\n\n**Warning**: Only orders completed within the past month can be confirmed. If one month has elapsed, please redo the order placement operation.\n" }, { "info": { "name": "Update resource initial setting for an order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/orders/:order_id/resource_initial_setting", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Update resource initial setting for an order.\n\n**Warning**: Initial settings of IoT SIM cannot be specified after confirmation of receipt.\n" }, { "info": { "name": "List ordered subscribers", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/orders/:order_id/subscribers", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header returned when the previous page was retrieved. Specify if the next page is to be retrieved. For details, see [Handling Pagination](/en/docs/tools/api-reference/#handling-pagination)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of subscribers in a response." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "List ordered subscribers.\n\n**Warning**: The maximum information you can get is for the last 18 months. If you need the information before that time, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "Register subscribers for operator", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/orders/:order_id/subscribers/register", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "Order ID. You can get it by calling [Order:listOrders API](#/Order/listOrders)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Registers the ordered SIM with the operator.\n\n**Warning**: IoT SIMs can only be registered for the past 18 months. If you need to register an IoT SIM that was ordered before the time period, please contact [Soracom Support](https://support.soracom.io).\n" }, { "info": { "name": "List products", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/products", "params": [ { "name": "campaign_code", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of products." }, { "info": { "name": "Create long term discount quotation", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/volume_discounts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a new long term discount quotation. If the orderId is put in /volume_discounts/{order_id}/confirm, the order is complete (Currently, long term discount is only applied to plan-D (without bundle), plan-K)." }, { "info": { "name": "Confirm long-term discount order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/volume_discounts/:order_id/confirm", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "Order ID. The order ID can be obtained from the [Order:createVolumeDiscountQuotation API](#/Order/createVolumeDiscountQuotation)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Performs a credit check and confirms the order if there are no issues." }, { "info": { "name": "List available long term discounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/volume_discounts/available_discounts", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of available long term discounts." } ] }, { "info": { "name": "Credential", "type": "folder" }, "items": [ { "info": { "name": "List credential sets", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/credentials", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of credential sets." }, { "info": { "name": "Create a credential set", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/credentials/:credentials_id", "params": [ { "name": "credentials_id", "value": "", "type": "path", "description": "Credential set ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a new credential set." }, { "info": { "name": "Update a credential set", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/credentials/:credentials_id", "params": [ { "name": "credentials_id", "value": "", "type": "path", "description": "Credential set ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates a credential set." }, { "info": { "name": "Delete a credential set", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/credentials/:credentials_id", "params": [ { "name": "credentials_id", "value": "", "type": "path", "description": "Credential set ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a credential set." } ] }, { "info": { "name": "DataEntry", "type": "folder" }, "items": [ { "info": { "name": "Get data sent to Harvest Data from a resource.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/data/:resource_type/:resource_id", "params": [ { "name": "resource_type", "value": "", "type": "path", "description": "Type of data source resource." }, { "name": "resource_id", "value": "", "type": "path", "description": "ID of data source resource. The ID to be specified depends on the value of `resource_type`.\n\n| `resource_type` | The ID you specify |\n|-|-|\n| `Subscriber` | IMSI of the IoT SIM |\n| `LoraDevice` | ID of the LoRaWAN device |\n| `Sim` | SIM ID of the IoT SIM |\n| `SigfoxDevice` | ID of the Sigfox device |\n| `Device` | ID of the Inventory device |\n| `SoraCam` | Device ID of the compatible camera device |\n" }, { "name": "from", "value": "", "type": "query", "description": "Start time for the data entries search range (UNIX time in milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "End time for the data entries search range (UNIX time in milliseconds)." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of data entries sent to Harvest Data from a device that match certain criteria. If the total number of entries does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Gets a data entry", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/data/:resource_type/:resource_id/:time", "params": [ { "name": "resource_type", "value": "", "type": "path", "description": "Type of data source resource." }, { "name": "resource_id", "value": "", "type": "path", "description": "ID of data source resource. The ID to be specified depends on the value of `resource_type`.\n\n| `resource_type` | The ID you specify |\n|-|-|\n| `Subscriber` | IMSI of the IoT SIM |\n| `LoraDevice` | ID of the LoRaWAN device |\n| `Sim` | SIM ID of the IoT SIM |\n| `SigfoxDevice` | ID of the Sigfox device |\n| `Device` | ID of the Inventory device |\n| `SoraCam` | Device ID of the compatible camera device |\n" }, { "name": "time", "value": "", "type": "path", "description": "Timestamp of the target data entry to get (UNIX time in milliseconds)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets a data entry identified with resource ID and timestamp" }, { "info": { "name": "Deletes a data entry", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/data/:resource_type/:resource_id/:time", "params": [ { "name": "resource_type", "value": "", "type": "path", "description": "Type of data source resource." }, { "name": "resource_id", "value": "", "type": "path", "description": "ID of data source resource. The ID to be specified depends on the value of `resource_type`.\n\n| `resource_type` | The ID you specify |\n|-|-|\n| `Subscriber` | IMSI of the IoT SIM |\n| `LoraDevice` | ID of the LoRaWAN device |\n| `Sim` | SIM ID of the IoT SIM |\n| `SigfoxDevice` | ID of the Sigfox device |\n| `Device` | ID of the Inventory device |\n| `SoraCam` | Device ID of the compatible camera device |\n" }, { "name": "time", "value": "", "type": "path", "description": "Timestamp of the target data entry to delete (UNIX time in milliseconds)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a data entry identified with resource ID and timestamp" }, { "info": { "name": "Get data entries for a specific category", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/data/categories/:category", "params": [ { "name": "category", "value": "", "type": "path", "description": "Name of the category to filter data entries." }, { "name": "from", "value": "", "type": "query", "description": "Start time for the data entries search range (UNIX time in milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "End time for the data entries search range (UNIX time in milliseconds)." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of data entries that belong to a specific category. If the total number of entries does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Get the list of data source resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/data/metadata/resources", "params": [ { "name": "resource_type", "value": "", "type": "query", "description": "Type of data source resource.\n\n- `Subscriber`: IoT SIM.\n- `LoraDevice`: LoRaWAN device.\n- `Sim`: IoT SIM.\n- `SigfoxDevice`: Sigfox device.\n- `Device`: Inventory device.\n- `SoraCam`: Compatible camera device.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of data entries to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of data source resources that have sent data. If the total number of data source resources does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Get the list of data source resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/data/resources", "params": [ { "name": "resource_type", "value": "", "type": "query", "description": "Type of data source resource.\n\n- `Subscriber`: IoT SIM.\n- `LoraDevice`: LoRaWAN device.\n- `Sim`: IoT SIM.\n- `SigfoxDevice`: Sigfox device.\n- `Device`: Inventory device.\n- `SoraCam`: Compatible camera device.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of data entries to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of data source resources that have sent data. If the total number of data source resources does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" } ] }, { "info": { "name": "DeviceObjectModel", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of device object models", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/device_object_models", "params": [ { "name": "last_evaluated_key", "value": "", "type": "query", "description": "ID of the last device object model in the previous page. By specifying this parameter, you can continue to retrieve the list from the next device object models onward." }, { "name": "limit", "value": "", "type": "query", "description": "Max number of device object models in a response" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of device object models" }, { "info": { "name": "Creates a new device object model", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/device_object_models", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a new device object model" }, { "info": { "name": "Gets a device object model", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/device_object_models/:model_id", "params": [ { "name": "model_id", "value": "", "type": "path", "description": "Target device object model ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets a device object model" }, { "info": { "name": "Updates a device object model", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/device_object_models/:model_id", "params": [ { "name": "model_id", "value": "", "type": "path", "description": "Target device object model ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates a device object model" }, { "info": { "name": "Deletes a device object model", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/device_object_models/:model_id", "params": [ { "name": "model_id", "value": "", "type": "path", "description": "Target device object model ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a device object model" }, { "info": { "name": "Sets scope for a device object model", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/device_object_models/:model_id/set_scope", "params": [ { "name": "model_id", "value": "", "type": "path", "description": "Target device object model ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sets scope for a device object model" } ] }, { "info": { "name": "Device", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Devices", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/devices", "params": [ { "name": "tag_name", "value": "", "type": "query", "description": "Tag name" }, { "name": "tag_value", "value": "", "type": "query", "description": "Tag value" }, { "name": "tag_value_match_mode", "value": "", "type": "query", "description": "Tag value match mode (exact | prefix)" }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "ID of the last Device in the previous page. By specifying this parameter, you can continue to retrieve the list from the next device onward." }, { "name": "limit", "value": "", "type": "query", "description": "Max number of Devices in a response" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of Devices" }, { "info": { "name": "Creates a new Device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/devices", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a new Device" }, { "info": { "name": "Returns a Device identified by device ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/devices/:device_id", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID" }, { "name": "model", "value": "", "type": "query", "description": "Whether or not to add model information" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a Device identified by device ID" }, { "info": { "name": "Delete Device", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/devices/:device_id", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device to delete" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete Device" }, { "info": { "name": "Get resources under an object instance of a device", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/devices/:device_id/:object/:instance", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Target device" }, { "name": "object", "value": "", "type": "path", "description": "Object ID" }, { "name": "instance", "value": "", "type": "path", "description": "Instance ID" }, { "name": "model", "value": "", "type": "query", "description": "Whether or not to add model information" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get resources under an object instance of a device" }, { "info": { "name": "Get the specified resource of a device", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/devices/:device_id/:object/:instance/:resource", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Target device" }, { "name": "object", "value": "", "type": "path", "description": "Object ID" }, { "name": "instance", "value": "", "type": "path", "description": "Instance ID" }, { "name": "resource", "value": "", "type": "path", "description": "Resource ID" }, { "name": "model", "value": "", "type": "query", "description": "Whether or not to add model information" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get the specified resource of a device" }, { "info": { "name": "Write value to a resource of a device", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/devices/:device_id/:object/:instance/:resource", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Target device" }, { "name": "object", "value": "", "type": "path", "description": "Object ID" }, { "name": "instance", "value": "", "type": "path", "description": "Instance ID" }, { "name": "resource", "value": "", "type": "path", "description": "Resource ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Write value to a resource of a device" }, { "info": { "name": "Executes a resource of a device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/devices/:device_id/:object/:instance/:resource/execute", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Target device" }, { "name": "object", "value": "", "type": "path", "description": "Object ID" }, { "name": "instance", "value": "", "type": "path", "description": "Instance ID" }, { "name": "resource", "value": "", "type": "path", "description": "Resource ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Executes a resource of a device" }, { "info": { "name": "Triggers observation of the specified resource of a device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/devices/:device_id/:object/:instance/:resource/observe", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Target device" }, { "name": "object", "value": "", "type": "path", "description": "Object ID" }, { "name": "instance", "value": "", "type": "path", "description": "Instance ID" }, { "name": "resource", "value": "", "type": "path", "description": "Resource ID" }, { "name": "model", "value": "", "type": "query", "description": "Whether or not to add model information" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Triggers observation of the specified resource of a device. Once observation is started, the server will be notified when there is a change in value on the device side." }, { "info": { "name": "Stops observation of a resource of a device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/devices/:device_id/:object/:instance/:resource/unobserve", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Target device" }, { "name": "object", "value": "", "type": "path", "description": "Object ID" }, { "name": "instance", "value": "", "type": "path", "description": "Instance ID" }, { "name": "resource", "value": "", "type": "path", "description": "Resource ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Stops observation of a resource of a device" }, { "info": { "name": "Triggers observation of resources under an object instance of a device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/devices/:device_id/:object/:instance/observe", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Target device" }, { "name": "object", "value": "", "type": "path", "description": "Object ID" }, { "name": "instance", "value": "", "type": "path", "description": "Instance ID" }, { "name": "model", "value": "", "type": "query", "description": "Whether or not to add model information" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Triggers observation of resources under an object instance of a device" }, { "info": { "name": "Stops observation of resources under an object instance of a device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/devices/:device_id/:object/:instance/unobserve", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Target device" }, { "name": "object", "value": "", "type": "path", "description": "Object ID" }, { "name": "instance", "value": "", "type": "path", "description": "Instance ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Stops observation of resources under an object instance of a device" }, { "info": { "name": "Retrieves data sent from an Inventory device to Harvest Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/devices/:device_id/data", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "ID of the Inventory device from which to retrieve data. The ID of an Inventory device can be obtained using the [Device:listDevices API](#!/Device/listDevices)." }, { "name": "from", "value": "", "type": "query", "description": "Start time of the target period (UNIX time in milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "End time of the target period (UNIX time in milliseconds)." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order of data entries. Either descending order (latest data entry first) or ascending order (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of data entries to retrieve (1 to 1000). The default is `10`." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Timestamp of the last data entry retrieved on the previous page. By specifying this parameter, the list starting from the next data entry can be obtained." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves data that matches the specified conditions from the data sent by the specified Inventory device to Harvest Data. If the data entries do not fit in one page, a URL to retrieve the next page with the same conditions will be included in the `link` header of the response.\n" }, { "info": { "name": "Adds an Inventory device to an Inventory group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/devices/:device_id/set_group", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target Inventory device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds an Inventory device to an Inventory group." }, { "info": { "name": "Updates device tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/devices/:device_id/tags", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device to update" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates device tags" }, { "info": { "name": "Delete device tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/devices/:device_id/tags/:tag_name", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device to update" }, { "name": "tag_name", "value": "", "type": "path", "description": "Name of tag to delete" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete device tag" }, { "info": { "name": "Removes an Inventory device from an Inventory group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/devices/:device_id/unset_group", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target Inventory device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Removes an Inventory device from an Inventory group." } ] }, { "info": { "name": "Diagnostic", "type": "folder" }, "items": [ { "info": { "name": "Send diagnostic request", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/diagnostics", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Send a diagnostic request." }, { "info": { "name": "Get diagnostic", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/diagnostics/:diagnostic_id", "params": [ { "name": "diagnostic_id", "value": "", "type": "path", "description": "The identifier of diagnostic request." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a diagnostic." } ] }, { "info": { "name": "EventHandler", "type": "folder" }, "items": [ { "info": { "name": "List Event Handlers", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/event_handlers", "params": [ { "name": "target", "value": "", "type": "query", "description": "The event handler target (the target for executing events)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of event handlers." }, { "info": { "name": "Create Event Handler", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/event_handlers", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a new event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/." }, { "info": { "name": "Get Event Handler", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/event_handlers/:handler_id", "params": [ { "name": "handler_id", "value": "", "type": "path", "description": "Event handler ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns information about the specified event handler." }, { "info": { "name": "Update Event Handler", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/event_handlers/:handler_id", "params": [ { "name": "handler_id", "value": "", "type": "path", "description": "Event handler ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the specified event handler. Please see also https://developers.soracom.io/en/docs/air/event-handler/." }, { "info": { "name": "Delete Event Handler", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/event_handlers/:handler_id", "params": [ { "name": "handler_id", "value": "", "type": "path", "description": "Event handler ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the specified event handler." }, { "info": { "name": "Ignore Event Handler", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/event_handlers/:handler_id/subscribers/:imsi/ignore", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI." }, { "name": "handler_id", "value": "", "type": "path", "description": "Event handler ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds a setting for ignoring the specified event handler of the specified IMSI." }, { "info": { "name": "Delete Ignore Event Handler", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/event_handlers/:handler_id/subscribers/:imsi/ignore", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI." }, { "name": "handler_id", "value": "", "type": "path", "description": "Event handler ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the setting for ignoring the specified event handler of the specified IMSI." }, { "info": { "name": "List Event Handlers related to Subscriber", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/event_handlers/subscribers/:imsi", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of event handlers related to the specified IMSI." } ] }, { "info": { "name": "FileEntry", "type": "folder" }, "items": [ { "info": { "name": "Find files with prefix query parameter in the scope", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/files", "params": [ { "name": "scope", "value": "", "type": "query", "description": "Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "name": "prefix", "value": "", "type": "query", "description": "Prefix to match with file path." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of file entries to be returned." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The filePath of the last file entry retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next file entry onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of file entries which beginnings of their file paths are matched with the `prefix` query string in the ascending sorted UTF-8 bytes order of their file paths. An empty list is returned if the prefix does not match with any paths of file entries." }, { "info": { "name": "Download file specified by the path and the scope", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/files/:scope/:path", "params": [ { "name": "scope", "value": "", "type": "path", "description": "Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "name": "path", "value": "", "type": "path", "description": "Target path." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Download file specified by the path and the scope. Note that [FileEntry:listFiles API](#!/FileEntry/listFiles) will be called if the path ends with `/`." }, { "info": { "name": "Uploads the file to the specified path in the scope.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/files/:scope/:path", "headers": [ { "name": "content-type", "value": "" } ], "params": [ { "name": "scope", "value": "", "type": "path", "description": "Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "name": "path", "value": "", "type": "path", "description": "Target path." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Uploads the file to the specified path in the scope. Only `private` scope is allowed for the operation." }, { "info": { "name": "Deletes the file specified by scope and path.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/files/:scope/:path", "params": [ { "name": "scope", "value": "", "type": "path", "description": "Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "name": "path", "value": "", "type": "path", "description": "Target path." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the file specified by scope and path. Only `private` scope is allowed for the operation." }, { "info": { "name": "Gets the metadata of the file specified by the path and the scope", "type": "http" }, "http": { "method": "HEAD", "url": "https://api.soracom.io/v1/files/:scope/:path", "params": [ { "name": "scope", "value": "", "type": "path", "description": "Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "name": "path", "value": "", "type": "path", "description": "Target path." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets the metadata of the file specified by the path and the scope." }, { "info": { "name": "Returns files and directories from the directory specified by the scope and path.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/files/:scope/:path/", "params": [ { "name": "scope", "value": "", "type": "path", "description": "Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "name": "path", "value": "", "type": "path", "description": "Target path." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of file entries to be returned." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The filename of the last file entry retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next file entry onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns files and directories from the directory specified by the scope and path. Note that [FileEntry:getFile API](#!/FileEntry/getFile) will be called if the path does not end in `/`. If the total number of entries does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Deletes the directory specified by scope and path", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/files/:scope/:path/", "params": [ { "name": "scope", "value": "", "type": "path", "description": "Scope of the request. Specify `private` to handle files uploaded to Harvest Files." }, { "name": "path", "value": "", "type": "path", "description": "Target path." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the directory specified by scope and path. Only `private` scope is allowed for the operation." } ] }, { "info": { "name": "Files", "type": "folder" }, "items": [ { "info": { "name": "Get the progress of the process when the file is exported asynchronously.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/files/exported/:exported_file_id", "params": [ { "name": "exported_file_id", "value": "", "type": "path", "description": "File export ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get the progress of the process when the file is exported asynchronously. If the export is complete, you will get the URL to download the file. You can download the file from the URL.\n\nThe following APIs are available to export files asynchronously. The `exported_file_id` is the file output ID (the value of `exportedFileId`) obtained from the following API.\n\n- [Billing:exportBilling API](#!/Billing/exportBilling)\n- [Billing:exportLatestBilling API](#!/Billing/exportLatestBilling)\n- [Payment:expo" } ] }, { "info": { "name": "Gadget", "type": "folder" }, "items": [ { "info": { "name": "List gadgets", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/gadgets", "params": [ { "name": "product_id", "value": "", "type": "query", "description": "Product ID of the target Gadget API compatible device for filtering the search.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "name": "tag_name", "value": "", "type": "query", "description": "Tag name for filtering the search. The search is always an exact match, regardless of the setting of `tag_value_match_mode`." }, { "name": "tag_value", "value": "", "type": "query", "description": "Specifies a tag value to search for in a URL-encoded (percent-encoded) string. Required when `tag_name` has been specified." }, { "name": "tag_value_match_mode", "value": "", "type": "query", "description": "Tag match mode.\n\n- `exact`: exact match.\n- `prefix`: prefix match.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of Gadget API compatible devices data to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The ID (`{product_id}/{serial_number}`) of the last gadget retrieved on the previous page in URL encoding (percent encoding).\n\nBy specifying this parameter, you can continue to retrieve the list from the next Gadget API compatible device onward.\n\nThe value of the `last_evaluated_key` of `rel=next` returned in the `link` header when the API is called is expected to be specified in the next call, but any ID (`{productId}/{serialNumber}`) can be specified.\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of gadgets that match certain criteria. If the total number of gadgets does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Get Gadget API compatible device", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/gadgets/:product_id/:serial_number", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "name": "serial_number", "value": "", "type": "path", "description": "Serial Number of the target Gadget API compatible device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns information about the specified Gadget API compatible device." }, { "info": { "name": "Disables Termination of Gadget API compatible device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/gadgets/:product_id/:serial_number/disable_termination", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "name": "serial_number", "value": "", "type": "path", "description": "Serial Number of the target Gadget API compatible device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Disables termination of specified Gadget API compatible device." }, { "info": { "name": "Enables Termination of Gadget API compatible device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/gadgets/:product_id/:serial_number/enable_termination", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "name": "serial_number", "value": "", "type": "path", "description": "Serial Number of the target Gadget API compatible device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables termination of specified Gadget API compatible device." }, { "info": { "name": "Registers a Gadget API compatible device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/gadgets/:product_id/:serial_number/register", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "name": "serial_number", "value": "", "type": "path", "description": "Serial Number of the target Gadget API compatible device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Registers a Gadget API compatible device." }, { "info": { "name": "Bulk Insert or Update Gadget API compatible device tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/gadgets/:product_id/:serial_number/tags", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "name": "serial_number", "value": "", "type": "path", "description": "Serial Number of the target Gadget API compatible device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Inserts/updates tags for the specified Gadget API compatible device." }, { "info": { "name": "Deletes tags from Gadget API compatible device", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/gadgets/:product_id/:serial_number/tags/:tag_name", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "name": "serial_number", "value": "", "type": "path", "description": "Serial Number of the target Gadget API compatible device." }, { "name": "tag_name", "value": "", "type": "path", "description": "Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a tag from the specified Gadget API compatible device." }, { "info": { "name": "Terminates the specified Gadget API compatible device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/gadgets/:product_id/:serial_number/terminate", "params": [ { "name": "product_id", "value": "", "type": "path", "description": "Product ID of the target Gadget API compatible device.\n\n- `wimax`: Soracom Cloud Camera Services Cellular Pack.\n" }, { "name": "serial_number", "value": "", "type": "path", "description": "Serial Number of the target Gadget API compatible device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Terminates the specified Gadget API compatible device." } ] }, { "info": { "name": "Group", "type": "folder" }, "items": [ { "info": { "name": "List Groups.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/groups", "params": [ { "name": "tag_name", "value": "", "type": "query", "description": "Tag name of the group. Filters through all groups that exactly match the tag name. When tag_name is specified, tag_value is required." }, { "name": "tag_value", "value": "", "type": "query", "description": "Tag value of the groups." }, { "name": "tag_value_match_mode", "value": "", "type": "query", "description": "Search criteria for tag strings (`tag_value`)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results per response page." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The last Group ID retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next group onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of Groups." }, { "info": { "name": "Create Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Create a new group." }, { "info": { "name": "Get Group", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the target Group." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns the group specified by the group ID." }, { "info": { "name": "Delete Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the target Group." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the group specified by Group ID." }, { "info": { "name": "Update group configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/groups/:group_id/configuration/:namespace", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the target group. The group ID can be obtained via the [Group:listGroups API](#!/Group/listGroups)." }, { "name": "namespace", "value": "", "type": "path", "description": "A string indicating the configuration target. It varies depending on the configuration content.\n\n- `SoracomAir`: Custom DNS, Metadata service, VPG (Virtual Private Gateway), CHAP authentication, Simple Location function, Binary Parser.\n- `SoracomBeam`: SORACOM Beam.\n- `SoracomEndorse`: SORACOM Endorse.\n- `SoracomFunk`: SORACOM Funk.\n- `SoracomFunnel`: SORACOM Funnel.\n- `SoracomHarvest`: SORACOM Harvest Data.\n- `SoracomHarvestFiles`: SORACOM Harvest Files.\n- `SoracomKrypton`: SORACOM Krypton.\n- `SoracomOrbit`: SORACOM Orbit.\n- `UnifiedEndpoint`: Unified Endpoint.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the configuration of the specified group." }, { "info": { "name": "Delete Group Configuration Namespace", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/groups/:group_id/configuration/:namespace", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the target Group." }, { "name": "namespace", "value": "", "type": "path", "description": "Namespace to be deleted." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete a namespace for the specified group." }, { "info": { "name": "Delete Group Configuration Parameters", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/groups/:group_id/configuration/:namespace/:name", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the target Group." }, { "name": "namespace", "value": "", "type": "path", "description": "Namespace of target parameters." }, { "name": "name", "value": "", "type": "path", "description": "Parameter name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete parameters for the specified group." }, { "info": { "name": "List Subscribers in a group", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/groups/:group_id/subscribers", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the target Group." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results per response page." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of subscribers that belong to the specified group by group ID." }, { "info": { "name": "Update Group Tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/groups/:group_id/tags", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the target Group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds/updates tags of specified configuration group." }, { "info": { "name": "Delete Group Tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/groups/:group_id/tags/:tag_name", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "ID of the target Group." }, { "name": "tag_name", "value": "", "type": "path", "description": "Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes tag from the specified group." } ] }, { "info": { "name": "Lagoon", "type": "folder" }, "items": [ { "info": { "name": "Get a custom icon image link of Soracom Lagoon Console", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lagoon/image/link", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get a custom icon image link of Soracom Lagoon Console." }, { "info": { "name": "Get the status of active Soracom Lagoon license packs", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lagoon/license_packs", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get the status of active Soracom Lagoon license packs." }, { "info": { "name": "Update the quantities for license packs of Soracom Lagoon", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/lagoon/license_packs", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Update the quantities for license packs of Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. The quantities for license packs of Soracom Lagoon cannot be updated with SAM user credentials.\n" }, { "info": { "name": "Update the plan of Soracom Lagoon", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/lagoon/plan", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Update the plan of Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. The plan of Lagoon cannot be updated with SAM user credentials.\n" }, { "info": { "name": "Register (activate) Soracom Lagoon", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lagoon/register", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Register (activate) Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. Lagoon cannot be registered with SAM user credentials.\n" }, { "info": { "name": "Terminate (deactivate) Soracom Lagoon", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lagoon/terminate", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Terminate (deactivate) Soracom Lagoon.\n\n**Warning**: This API must be called with the root user credentials. Lagoon cannot be terminated with SAM user credentials.\n" }, { "info": { "name": "List Soracom Lagoon users that belong to operator", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lagoon/users", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "List Soracom Lagoon users that belong to operator." }, { "info": { "name": "Create a Soracom Lagoon user", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lagoon/users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Create a Soracom Lagoon user." }, { "info": { "name": "Delete a Soracom Lagoon user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/lagoon/users/:lagoon_user_id", "params": [ { "name": "lagoon_user_id", "value": "", "type": "path", "description": "Target ID of the lagoon user." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete a Soracom Lagoon user." }, { "info": { "name": "Update email address of a Soracom Lagoon user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/lagoon/users/:lagoon_user_id/email", "params": [ { "name": "lagoon_user_id", "value": "", "type": "path", "description": "Target ID of the lagoon user." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Update email address of a Soracom Lagoon user." }, { "info": { "name": "Update password of a Soracom Lagoon user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/lagoon/users/:lagoon_user_id/password", "params": [ { "name": "lagoon_user_id", "value": "", "type": "path", "description": "Target ID of the lagoon user." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Update password of a Soracom Lagoon user." }, { "info": { "name": "Update permission of a Soracom Lagoon user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/lagoon/users/:lagoon_user_id/permission", "params": [ { "name": "lagoon_user_id", "value": "", "type": "path", "description": "Target ID of the lagoon user." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Update permission of a Soracom Lagoon user." } ] }, { "info": { "name": "Log", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Error Logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/logs", "params": [ { "name": "resource_type", "value": "", "type": "query", "description": "The type of resource for which to retrieve error logs.\n\n- `Subscriber`: IoT SIM.\n- `Device`: Inventory device.\n- `LoraDevice`: LoRaWAN device.\n- `SigfoxDevice`: Sigfox device.\n" }, { "name": "resource_id", "value": "", "type": "query", "description": "The ID of the resource for which to retrieve error logs. The ID to specify varies depending on the value of `resource_type`.\n\n| `resource_type` | ID to specify |\n|-|-|\n| `Subscriber` | The IMSI of the IoT SIM. The IMSI can be obtained from the [Sim:listSims API](#!/Sim/listSims). |\n| `Device` | The ID of the Inventory device. The ID can be obtained from the [Device:listDevices API](#!/Device/listDevices). |\n| `LoraDevice` | The ID of the LoRaWAN device. The ID can be obtained from the [LoraDevice:listLoraDevices API](#!/LoraDevice/listLoraDevices). |\n| `SigfoxDevice` | The ID of the Sigfox device. The ID can be obtained from the [SigfoxDevice:listSigfoxDevices API](#!/SigfoxDevice/listSigfoxDevices). |\n" }, { "name": "service", "value": "", "type": "query", "description": "The service name to filter error logs.\n\n- `Air`: SORACOM Air\n- `Beam`: SORACOM Beam\n- `Funk`: SORACOM Funk\n- `Funnel`: SORACOM Funnel\n- `Harvest`: SORACOM Harvest Data/Files\n- `Napter`: SORACOM Napter\n- `Orbit`: SORACOM Orbit\n- `Unified`: Unified Endpoint\n" }, { "name": "from", "value": "", "type": "query", "description": "Start time of the period for which to retrieve error logs (UNIX time in milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "End time of the period for which to retrieve error logs (UNIX time in milliseconds)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of error logs to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value contained in the `x-soracom-next-key` header returned when fetching the previous page. Specify this to retrieve the next page. For more information, see [Retrieving Large Amounts of Data (Paging)](/en/docs/tools/api/paging/)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Fetches error logs that meet specified criteria. If the error logs exceed one page, a URL to retrieve the next page under the same conditions is included in the `link` header of the response.\n" } ] }, { "info": { "name": "LoraDevice", "type": "folder" }, "items": [ { "info": { "name": "List LoRaWAN devices.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lora_devices", "params": [ { "name": "tag_name", "value": "", "type": "query", "description": "Tag name for filtering the search (exact match)." }, { "name": "tag_value", "value": "", "type": "query", "description": "Tag search string for filtering the search. Required when `tag_name` has been specified." }, { "name": "tag_value_match_mode", "value": "", "type": "query", "description": "Tag match mode." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of LoRaWAN devices to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The device ID of the last LoRaWAN device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN device onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of LoRaWAN devices that match certain criteria. If the total number of LoRaWAN devices does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Get LoRaWAN device.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lora_devices/:device_id", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target LoRaWAN device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns information about the specified LoRaWAN device." }, { "info": { "name": "Retrieves data sent from a LoRaWAN device to Harvest Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lora_devices/:device_id/data", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "ID of the LoRaWAN device from which to retrieve data. The ID of a LoRaWAN device can be obtained using the [LoraDevice:listLoraDevices API](#!/LoraDevice/listLoraDevices)." }, { "name": "from", "value": "", "type": "query", "description": "Start time of the target period (UNIX time in milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "End time of the target period (UNIX time in milliseconds)." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order of data entries. Either descending order (latest data entry first) or ascending order (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of data entries to retrieve (1 to 1000). The default is `10`." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Timestamp of the last data entry retrieved on the previous page. By specifying this parameter, the list starting from the next data entry can be obtained." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves data that matches the specified conditions from the data sent by the specified LoRaWAN device to Harvest Data. If the data entries do not fit in one page, a URL to retrieve the next page with the same conditions will be included in the `link` header of the response.\n" }, { "info": { "name": "Send data to a LoRaWAN device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_devices/:device_id/data", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "ID of the recipient device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sends data to the specified LoRaWAN device. The data is sent to the LoRa network server, to be sent out to the device using the next available slot. If another message destined for the same LoRaWAN device ID is already waiting to be sent on the LoRa Network Server, the existing message will be discarded, and the new message will be sent instead. Data is discarded if it is not received by the device for a certain period of time (2 hours)." }, { "info": { "name": "Disable Termination of LoRaWAN device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_devices/:device_id/disable_termination", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target LoRaWAN device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Disables termination of specified LoRaWAN device." }, { "info": { "name": "Enable Termination of LoRaWAN device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_devices/:device_id/enable_termination", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target LoRaWAN device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables termination of specified LoRaWAN device." }, { "info": { "name": "Register LoRaWAN device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_devices/:device_id/register", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target LoRaWAN device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Register a LoRaWAN device." }, { "info": { "name": "Adds a LoRaWAN device to a LoRaWAN group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_devices/:device_id/set_group", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN device. The ID of a LoRaWAN device can be obtained using the [LoraDevice:listLoraDevices API](#!/LoraDevice/listLoraDevices)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds a LoRaWAN device to a LoRaWAN group." }, { "info": { "name": "Bulk Insert or Update LoRaWAN device Tags.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/lora_devices/:device_id/tags", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target LoRaWAN device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Inserts/updates tags for the specified LoRaWAN device." }, { "info": { "name": "Delete LoRaWAN device Tag.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/lora_devices/:device_id/tags/:tag_name", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target LoRaWAN device." }, { "name": "tag_name", "value": "", "type": "path", "description": "Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a tag from the specified LoRaWAN device." }, { "info": { "name": "Terminate LoRaWAN device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_devices/:device_id/terminate", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target LoRaWAN device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Terminates the specified LoRaWAN device." }, { "info": { "name": "Removes a LoRaWAN device from a LoRaWAN group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_devices/:device_id/unset_group", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN device. The ID of a LoRaWAN device can be obtained using the [LoraDevice:listLoraDevices API](#!/LoraDevice/listLoraDevices)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Removes a LoRaWAN device from a LoRaWAN group." } ] }, { "info": { "name": "LoraGateway", "type": "folder" }, "items": [ { "info": { "name": "List LoRaWAN Gateways", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lora_gateways", "params": [ { "name": "tag_name", "value": "", "type": "query", "description": "Tag name for filtering the search (exact match)." }, { "name": "tag_value", "value": "", "type": "query", "description": "Tag search string for filtering the search. Required when `tag_name` has been specified." }, { "name": "tag_value_match_mode", "value": "", "type": "query", "description": "Tag match mode." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of LoRaWAN gateways to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The Gateway ID of the last LoRaWAN gateway retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN gateway onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of LoRaWAN gateways that match certain criteria. If the total number of LoRaWAN gateways does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Get LoRaWAN gateway", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lora_gateways/:gateway_id", "params": [ { "name": "gateway_id", "value": "", "type": "path", "description": "Gateway ID of the target LoRaWAN gateway." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns information about the specified LoRaWAN gateway." }, { "info": { "name": "Disable Termination of LoRaWAN gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_gateways/:gateway_id/disable_termination", "params": [ { "name": "gateway_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN gateway." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Disables termination of specified LoRaWAN gateway." }, { "info": { "name": "Enable Termination of LoRaWAN gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_gateways/:gateway_id/enable_termination", "params": [ { "name": "gateway_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN gateway." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables termination of specified LoRaWAN gateway." }, { "info": { "name": "Set Network Set ID of LoRaWAN gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_gateways/:gateway_id/set_network_set", "params": [ { "name": "gateway_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN gateway." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sets or overwrites network set ID for the specified LoRaWAN gateway." }, { "info": { "name": "Bulk Insert or Update LoRaWAN gateway Tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/lora_gateways/:gateway_id/tags", "params": [ { "name": "gateway_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN gateway." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Inserts/updates tags for the specified LoRaWAN gateway." }, { "info": { "name": "Delete LoRaWAN gateway tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/lora_gateways/:gateway_id/tags/:tag_name", "params": [ { "name": "gateway_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN gateway." }, { "name": "tag_name", "value": "", "type": "path", "description": "Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a tag from the specified LoRaWAN gateway." }, { "info": { "name": "Terminate LoRaWAN gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_gateways/:gateway_id/terminate", "params": [ { "name": "gateway_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN gateway." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Terminates the specified LoRaWAN gateway." }, { "info": { "name": "Unset Network Set ID of LoRaWAN gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_gateways/:gateway_id/unset_network_set", "params": [ { "name": "gateway_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN gateway." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Unset network set ID of the specified LoRaWAN gateway." } ] }, { "info": { "name": "LoraNetworkSet", "type": "folder" }, "items": [ { "info": { "name": "List LoRaWAN Network Sets", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lora_network_sets", "params": [ { "name": "tag_name", "value": "", "type": "query", "description": "Tag name for filtering the search (exact match)." }, { "name": "tag_value", "value": "", "type": "query", "description": "Tag search string for filtering the search. Required when `tag_name` has been specified." }, { "name": "tag_value_match_mode", "value": "", "type": "query", "description": "Tag match mode." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of LoRaWAN network set to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The ID of the last network set retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next device onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of LoRaWAN network sets that match certain criteria. If the total number of LoRaWAN network sets does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Create a LoRaWAN network set", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_network_sets", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a specified LoRaWAN network set." }, { "info": { "name": "Get LoRaWAN network set", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lora_network_sets/:ns_id", "params": [ { "name": "ns_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN network set." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns information about the specified LoRaWAN network set." }, { "info": { "name": "Delete LoRaWAN network set", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/lora_network_sets/:ns_id", "params": [ { "name": "ns_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN network set." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the specified LoRaWAN network set." }, { "info": { "name": "Adds permission to a LoRaWAN network set", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_network_sets/:ns_id/add_permission", "params": [ { "name": "ns_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN network set." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds permission to allow another operator to use the network set." }, { "info": { "name": "List LoRaWAN Gateways in a Network Set", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/lora_network_sets/:ns_id/gateways", "params": [ { "name": "ns_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN network set." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of LoRaWAN gateways to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The Gateway ID of the last LoRaWAN gateway retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next LoRaWAN gateway onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of LoRaWAN gateways that belong to the specified network set. If the total number of LoRaWAN gateways does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Revokes a permission from a LoRaWAN network set", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/lora_network_sets/:ns_id/revoke_permission", "params": [ { "name": "ns_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN network set." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Revokes a permission and removes an operator from the list of allowed operators in the network set." }, { "info": { "name": "Bulk Insert or Update LoRaWAN network set tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/lora_network_sets/:ns_id/tags", "params": [ { "name": "ns_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN network set." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Inserts/updates tags for the specified LoRaWAN network set." }, { "info": { "name": "Delete LoRaWAN network set tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/lora_network_sets/:ns_id/tags/:tag_name", "params": [ { "name": "ns_id", "value": "", "type": "path", "description": "ID of the target LoRaWAN network set." }, { "name": "tag_name", "value": "", "type": "path", "description": "Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a tag from the specified LoRaWAN network set." } ] }, { "info": { "name": "Operator", "type": "folder" }, "items": [ { "info": { "name": "Get Operator", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns information about the operator." }, { "info": { "name": "List Operator AuthKeys", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/auth_keys", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns the operator's AuthKey list." }, { "info": { "name": "Generate Operator AuthKey", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/auth_keys", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Generates an AuthKey for the operator." }, { "info": { "name": "Delete Operator AuthKey", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/auth_keys/:auth_key_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "auth_key_id", "value": "", "type": "path", "description": "AuthKey ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes an AuthKey from the operator." }, { "info": { "name": "Get company information", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/company_information", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets the operator's company information." }, { "info": { "name": "Create company information", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/company_information", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates the operator's company information." }, { "info": { "name": "Update company information", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/company_information", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the operator's company information." }, { "info": { "name": "Get operator configuration of the namespace", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/configuration/:namespace", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "namespace", "value": "", "type": "path", "description": "Namespace of operator configuration." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets operator configuration of the namespace." }, { "info": { "name": "Set operator configuration of the namespace", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/configuration/:namespace", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "namespace", "value": "", "type": "path", "description": "Namespace of operator configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sets operator configuration of the namespace." }, { "info": { "name": "Delete operator configuration of the namespace", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/configuration/:namespace", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "namespace", "value": "", "type": "path", "description": "Namespace of operator configuration." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes operator configuration of the namespace." }, { "info": { "name": "Add Operator Contract", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/contracts", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds the operator's contract." }, { "info": { "name": "Delete Operator Contract", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/contracts/:contract_name", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "contract_name", "value": "", "type": "path", "description": "Contract name." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the operator's contract." }, { "info": { "name": "Add coverage type", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/coverage_type/:coverage_type", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "coverage_type", "value": "", "type": "path", "description": "Coverage type." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds the operator's coverage type." }, { "info": { "name": "Get individual information", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/individual_information", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets the operator's individual information." }, { "info": { "name": "Create individual information", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/individual_information", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates the operator's individual information." }, { "info": { "name": "Update individual information", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/individual_information", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the operator's individual information." }, { "info": { "name": "Get Operator's MFA Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/mfa", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets operator's MFA status. The MFA status is one of `ACTIVE`, `INACTIVE` or `UNCONFIRMED`." }, { "info": { "name": "Enable Operator's MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/mfa", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables operator's MFA. After calling this API, it should be verified by calling `Operator:verifyMFA` API." }, { "info": { "name": "Revoke Operator's MFA", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/mfa", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Revokes operator's MFA without backup codes." }, { "info": { "name": "Verify Operator's MFA OTP Code", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/mfa/verify", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Verifies operator's MFA with OTP code. This API must be called after calling `Operator:enableMFA`. MFA will not be activated unless the MFA OTP is verified with this API. Be sure to securely store the backup code returned in the response to this API." }, { "info": { "name": "Update Operator Password", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/password", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the operator's password." }, { "info": { "name": "Generate Token for Support Console", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/support/token", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a token for accessing the support console." }, { "info": { "name": "Generate API Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/token", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Generates a new API token. If you insert the current API token into the header and make a request, a response is returned containing the new API token. You can then use the new API token in future requests." }, { "info": { "name": "Revoke all API keys and API tokens that were generated by the root user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/tokens", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Revoke all API keys and API tokens that were generated by the root user. Once revoked, the API key and API token cannot be used to call the Soracom API, regardless of their expiration time." }, { "info": { "name": "Issue Operator's MFA Revoke Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/mfa_revoke_token/issue", "body": { "type": "json", "data": "{}" } }, "docs": "Issues a token to revoke operator's MFA. The issued token will be sent to the operator via email." }, { "info": { "name": "Verify Operator's MFA revoke token", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/mfa_revoke_token/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Verifies the one-time token which is previously issued by calling `/operators/mfa_revoke_token/issue` API, operator's email address, password, and one of the backup codes. If verified, operator's MFA is going to be revoked." } ] }, { "info": { "name": "Email", "type": "folder" }, "items": [ { "info": { "name": "List email addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/emails", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a list of email addresses registered to the operator.\n" }, { "info": { "name": "Get email address", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/emails/:email_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "email_id", "value": "", "type": "path", "description": "Email address ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves information for the email address corresponding to the specified email address ID.\n" }, { "info": { "name": "Delete email address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/emails/:email_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "email_id", "value": "", "type": "path", "description": "Email address ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the email address corresponding to the specified email address ID from the operator.\n" }, { "info": { "name": "Issue an authentication token to add an email address", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/add_email_token/issue", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Generates an authentication token for adding a new email address and sends it to the specified email address. This authentication token is used with [Email:verifyAddEmailToken API](#/Email/verifyAddEmailToken) to complete email address verification and addition.\n\n**Warning**: This API can only be executed with root user credentials.\n" }, { "info": { "name": "Verify an authentication token to add an email address", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/add_email_token/verify", "body": { "type": "json", "data": "{}" } }, "docs": "Verifies the authentication token issued by [Email:issueAddEmailToken API](#/Email/issueAddEmailToken) and adds the email address to the operator.\n\n**Warning**: Authentication tokens have an expiration time. Expired authentication tokens cannot be used.\n" } ] }, { "info": { "name": "Role", "type": "folder" }, "items": [ { "info": { "name": "List Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/roles", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "owner", "value": "", "type": "query", "description": "Filters by the type of the role. Specify one of the following:\n- `operator`: Operator managed role (default)\n- `soracom`: Soracom managed role\n- `all`: All roles\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of roles." }, { "info": { "name": "Get Role", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/roles/:role_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "role_id", "value": "", "type": "path", "description": "Role ID. For operator managed roles, specify the role ID provided during role creation. For Soracom managed roles, specify in SRN (Soracom Resource Name) format.\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a role." }, { "info": { "name": "Create Operator Managed Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/roles/:role_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "role_id", "value": "", "type": "path", "description": "Role ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds a new operator managed role." }, { "info": { "name": "Update Operator Managed Role", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/roles/:role_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "role_id", "value": "", "type": "path", "description": "Role ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Edits an operator managed role." }, { "info": { "name": "Delete Operator Managed Role", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/roles/:role_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "role_id", "value": "", "type": "path", "description": "Role ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes an operator managed role." }, { "info": { "name": "List Role Attached Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/roles/:role_id/users", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "role_id", "value": "", "type": "path", "description": "Role ID. For operator managed roles, specify the role ID provided during role creation. For Soracom managed roles, specify in SRN (Soracom Resource Name) format.\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a list of users attached to a role." }, { "info": { "name": "Get Soracom Managed Role Versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/roles/:role_id/versions", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "role_id", "value": "", "type": "path", "description": "SRN (Soracom Resource Name) of the Soracom managed role. The format is `srn:soracom:::Role:[roleName]`." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a list of versions for a Soracom managed role." }, { "info": { "name": "List User Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/roles", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a list of the user's roles." }, { "info": { "name": "Attach Role to User", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/roles", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Attaches a role to a user." }, { "info": { "name": "Detach Role from User", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/roles/:role_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name." }, { "name": "role_id", "value": "", "type": "path", "description": "Role ID. For operator managed roles, specify the role ID provided during role creation. For Soracom managed roles, specify in SRN (Soracom Resource Name) format.\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Detaches a role from a user." } ] }, { "info": { "name": "ShippingAddress", "type": "folder" }, "items": [ { "info": { "name": "List shipping addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/shipping_addresses", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of shipping addresses." }, { "info": { "name": "Create shipping address", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/shipping_addresses", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a new shipping address." }, { "info": { "name": "Get shipping address", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/shipping_addresses/:shipping_address_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "shipping_address_id", "value": "", "type": "path", "description": "Shipping address ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a shipping address." }, { "info": { "name": "Update shipping address", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/shipping_addresses/:shipping_address_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "shipping_address_id", "value": "", "type": "path", "description": "Shipping address ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates a shipping address." }, { "info": { "name": "Delete shipping address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/shipping_addresses/:shipping_address_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "shipping_address_id", "value": "", "type": "path", "description": "Shipping address ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a shipping address." } ] }, { "info": { "name": "SystemNotification", "type": "folder" }, "items": [ { "info": { "name": "List email settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/system_notifications", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of email settings." }, { "info": { "name": "Get information on email settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/system_notifications/:type", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "type", "value": "", "type": "path", "description": "Email address type." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Return information on email settings." }, { "info": { "name": "Set an email address in the email settings", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/system_notifications/:type", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "type", "value": "", "type": "path", "description": "Email address type." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Set an email address in the email settings." }, { "info": { "name": "Delete an email address from the email settings", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/system_notifications/:type", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "type", "value": "", "type": "path", "description": "Email address type." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete an email address from the email settings." } ] }, { "info": { "name": "User", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of SAM users", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "The operator ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a list of SAM users." }, { "info": { "name": "Get User.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a SAM user." }, { "info": { "name": "Create User.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds a new SAM user." }, { "info": { "name": "Update User.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the SAM user." }, { "info": { "name": "Delete User.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the SAM user." }, { "info": { "name": "List User AuthKeys.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/auth_keys", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns the SAM user's AuthKey list." }, { "info": { "name": "Generate AuthKey.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/auth_keys", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Generates an AuthKey for the SAM user." }, { "info": { "name": "Get AuthKey.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" }, { "name": "auth_key_id", "value": "", "type": "path", "description": "auth_key_id" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns the SAM user's AuthKey." }, { "info": { "name": "Delete User AuthKey.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/auth_keys/:auth_key_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" }, { "name": "auth_key_id", "value": "", "type": "path", "description": "auth_key_id" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes an AuthKey from the SAM user." }, { "info": { "name": "Get SAM user's MFA status", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/mfa", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get SAM user's MFA status" }, { "info": { "name": "Enable SAM user's MFA", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/mfa", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enable SAM user's MFA" }, { "info": { "name": "Revoke SAM user's MFA", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/mfa", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Revoke SAM user's MFA" }, { "info": { "name": "Verify SAM user's MFA OTP code when MFA activation phase", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/mfa/verify", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Verify SAM user's MFA OTP code when MFA activation phase" }, { "info": { "name": "Has User Password.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/password", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves whether the SAM user has a password or not." }, { "info": { "name": "Create Password.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/password", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a password for the SAM user." }, { "info": { "name": "Update Password.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/password", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the password of the SAM user." }, { "info": { "name": "Delete Password.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/password", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "user_name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the user's password." }, { "info": { "name": "Get User Permission.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/permission", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the SAM user's permissions." }, { "info": { "name": "Update user permission.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/permission", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the SAM user's permissions." }, { "info": { "name": "Delete user permission.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/permission", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the SAM user's permission." }, { "info": { "name": "Revoke all API keys and API tokens that were generated by the specified SAM user.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/tokens", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Revoke all API keys and API tokens that were generated by the specified SAM user. Once revoked, the API key and API token cannot be used to call the SORACOM API, regardless of their expiration time." }, { "info": { "name": "Gets user trust policy.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/trust_policy", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets user trust policy for switching user." }, { "info": { "name": "Updates user trust policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/trust_policy", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the trust policy of the user specified by `operator_id` and `user_name` parameters.\n\n**Warning**: Setting a trust policy will allow the operator(s) or user(s) specified in the request body to switch to this SAM user. When switching, the trusted operator(s) or user(s) will be granted the same permissions as this SAM user, and may be able to see session history, traffic history, and other account information.\n" }, { "info": { "name": "Deletes user trust policy.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/:user_name/trust_policy", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "user_name", "value": "", "type": "path", "description": "SAM user name." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes user trust policy for switching user." }, { "info": { "name": "Get the default permissions", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/operators/:operator_id/users/default_permissions", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get the default permissions rule that is applied to all of the SAM users" }, { "info": { "name": "Update the default permissions", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/operators/:operator_id/users/default_permissions", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Update the default permissions rule that is applied to all of the SAM" }, { "info": { "name": "Delete the default permissions", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/operators/:operator_id/users/default_permissions", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete the default permissions rule that is applied to all of the SAM" } ] }, { "info": { "name": "PortMapping", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of Napter On-Demand Remote Access entries", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/port_mappings", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results per response page." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The last On-Demand Remote Access ID retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next entry onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of Napter On-Demand Remote Access entries." }, { "info": { "name": "Create Napter On-Demand Remote Access entry", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/port_mappings", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Create a new Napter On-Demand Remote Access entry." }, { "info": { "name": "Delete Napter On-Demand Remote Access entry", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/port_mappings/:ip_address/:port", "params": [ { "name": "ip_address", "value": "", "type": "path", "description": "IP address of the On-Demand Remote Access entry to be deleted." }, { "name": "port", "value": "", "type": "path", "description": "Port number of the On-Demand Remote Access entry to be deleted." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the specified Napter On-Demand Remote Access entry." }, { "info": { "name": "Retrieve a list of Napter On-Demand Remote Access entries created with specified SIM ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/port_mappings/sims/:sim_id", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target IoT SIM." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a list of Napter On-Demand Remote Access entries created with the specified SIM ID." }, { "info": { "name": "Create Napter On-Demand Remote Access entry with specified SIM ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/port_mappings/sims/:sim_id", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target IoT SIM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Create a new Napter On-Demand Remote Access entry with the specified SIM ID." }, { "info": { "name": "Retrieve a list of Napter On-Demand Remote Access entries created with specified IMSI", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/port_mappings/subscribers/:imsi", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a list of Napter On-Demand Remote Access entries where `destinationChoosingStrategy` is `IMSI_PRIORITIZED` (entries created with specified IMSI).\n" } ] }, { "info": { "name": "Query", "type": "folder" }, "items": [ { "info": { "name": "Search Soracom Inventory devices by query", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/query/devices", "params": [ { "name": "name", "value": "", "type": "query", "description": "Name to search." }, { "name": "group", "value": "", "type": "query", "description": "Group name to search." }, { "name": "group_id", "value": "", "type": "query", "description": "Group ID to search." }, { "name": "deviceId", "value": "", "type": "query", "description": "Soracom Inventory device ID to search." }, { "name": "tag", "value": "", "type": "query", "description": "String of tag values to search." }, { "name": "imsi", "value": "", "type": "query", "description": "IMSI of the device that was used on bootstrapping." }, { "name": "imei", "value": "", "type": "query", "description": "IMEI of the device that was used on bootstrapping." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The Soracom Inventory device ID of the last Inventory device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Inventory device onward." }, { "name": "search_type", "value": "", "type": "query", "description": "Type of the search ('AND searching' or 'OR searching')." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Search Soracom Inventory devices by query terms. It returns partial match results. When this API permission is allowed, it grants the authority to search and retrieve all Soracom Inventory devices that include their group information.\n\n**Warning**: Use this API when the device ID of the target Inventory device is unknown, or when you want to retrieve a list of Inventory devices that match conditions. If you know the device ID, use the [Device:getDevice API](#/Device/getDevice).\n" }, { "info": { "name": "Search Sigfox devices by query", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/query/sigfox_devices", "params": [ { "name": "name", "value": "", "type": "query", "description": "Name to search." }, { "name": "group", "value": "", "type": "query", "description": "Group name to search." }, { "name": "group_id", "value": "", "type": "query", "description": "Group ID to search." }, { "name": "deviceId", "value": "", "type": "query", "description": "Sigfox device ID to search." }, { "name": "tag", "value": "", "type": "query", "description": "String of tag values to search." }, { "name": "status", "value": "", "type": "query", "description": "Status of Sigfox devices." }, { "name": "registration", "value": "", "type": "query", "description": "Registration status of Sigfox devices." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The Sigfox device ID of the last Sigfox device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device onward." }, { "name": "search_type", "value": "", "type": "query", "description": "Type of the search ('AND searching' or 'OR searching')." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Search Sigfox devices by query terms. It returns partial match results. When this API permission is allowed, it grants the authority to search and retrieve all Sigfox devices that includes their group information.\n\n**Warning**: Use this API when the device ID of the target Sigfox device is unknown, or when you want to retrieve a list of Sigfox devices that match conditions. If you know the device ID, use the [SigfoxDevice:getSigfoxDevice API](#/SigfoxDevice/getSigfoxDevice).\n" }, { "info": { "name": "Search SIMs by query terms", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/query/sims", "params": [ { "name": "name", "value": "", "type": "query", "description": "Name to search." }, { "name": "group", "value": "", "type": "query", "description": "Name of the [group](/en/docs/groups/) to which the IoT SIM belongs." }, { "name": "group_id", "value": "", "type": "query", "description": "Search for IoT SIMs whose group ID matches the specified value." }, { "name": "sim_id", "value": "", "type": "query", "description": "Identifier of the SIM to search." }, { "name": "imsi", "value": "", "type": "query", "description": "IMSI to search." }, { "name": "msisdn", "value": "", "type": "query", "description": "MSISDN to search." }, { "name": "iccid", "value": "", "type": "query", "description": "ICCID to search. An identifier used to identify a SIM card or virtual IoT SIM (Virtual SIM/Subscriber)." }, { "name": "serial_number", "value": "", "type": "query", "description": "Serial number to search. This is set only for IoT SIMs for specific regions." }, { "name": "tag", "value": "", "type": "query", "description": "String of tag values to search. For more information, please refer to [Using Tags with Soracom Air](/docs/air/tags)." }, { "name": "bundles", "value": "", "type": "query", "description": "Bundles type to search." }, { "name": "status", "value": "", "type": "query", "description": "Status of the IoT SIM to search.\n\n- `ready`\n- `active`\n- `inactive`\n- `standby`\n- `suspended`\n- `terminated`\n- `shipped`\n" }, { "name": "session_status", "value": "", "type": "query", "description": "Status of the session to search. Specify one of the following:\n\n- `NA`: Any.\n- `ONLINE`: Online.\n- `OFFLINE`: Offline.\n" }, { "name": "subscription", "value": "", "type": "query", "description": "Subscription to search. Use exact match for the search. If specifying multiple subscriptions, please set `search_type` to `OR`.\n\n- For Japan coverage, specify one of the following:\n - `plan-D`: plan-D (without bundle), plan-D (D-300MB).\n - `plan-K2`: plan-K2 (K2-300MB).\n - `plan-DU`\n - `plan-KM1`\n - `plan-K`\n - `planArc01`: Virtual SIM/Subscriber.\n- For global coverage, specify one of the following:\n - `plan01s`\n - `plan01s-low_data_volume`: plan01s - Low Data Volume.\n - `planX3`: planX3 (X3-5MB), planX3.\n - `planP1`\n - `plan-US`\n - `plan-US-max`\n - `planX1`\n - `planX2`\n - `planX3-EU`\n - `plan-US-NA`\n - `planArc01`: Virtual SIM/Subscriber.\n" }, { "name": "module_type", "value": "", "type": "query", "description": "The form factor of the physical SIM to search.\n\n- `mini`: standard (2FF) size.\n- `micro`: micro (3FF) size.\n- `nano`: nano (4FF) size.\n- `trio`: 3 in 1 (can be cut into 2FF/3FF/4FF depending on how you cut it).\n- `embedded`: Embedded (MFF2).\n- `virtual`: Virtual SIM/Subscriber.\n- `integrated`: Embedded (iSIM).\n- `profilePackage`: Profile Package (eSIM profile).\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The SIM ID of the last SIM retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next SIM onward." }, { "name": "search_type", "value": "", "type": "query", "description": "The type of search condition.\n\n- AND: SIMs which match all of the search parameters will be returned (default).\n- OR: SIMs which match any of the search parameters will be returned.\n\nIf the value of a search parameter contains a comma `,` (or `%2C` when URL-encoded), the value will be split at each comma and treated as multiple search values, each of which will be evaluated based on the specified AND or OR condition.\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Searches for SIMs using specified query parameters.\n\n- Supports partial matching.\n- Case-insensitive.\n- Multiple search values can be specified for the following parameters by separating each value with a comma `,` (or `%2C` when URL-encoded). Note that the literal character `,` itself cannot be used as part of a search value.\n - `name`\n - `group`\n - `sim_id`\n - `imsi`\n - `msisdn`\n - `iccid`\n - `serial_number`\n - `tag`\n - `status`\n - `subscription`\n - `module_typ" }, { "info": { "name": "(DEPRECATED) Search subscribers by query terms", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/query/subscribers", "params": [ { "name": "name", "value": "", "type": "query", "description": "Name to search." }, { "name": "group", "value": "", "type": "query", "description": "Group name to search." }, { "name": "imsi", "value": "", "type": "query", "description": "IMSI to search." }, { "name": "msisdn", "value": "", "type": "query", "description": "MSISDN to search." }, { "name": "iccid", "value": "", "type": "query", "description": "ICCID to search." }, { "name": "serial_number", "value": "", "type": "query", "description": "Serial number to search." }, { "name": "tag", "value": "", "type": "query", "description": "String of tag values to search." }, { "name": "subscription", "value": "", "type": "query", "description": "Subscription to search. Use exact match for the search. If specifying multiple subscriptions, please set `search_type` to `OR`.\n\n- For Japan coverage, specify one of the following:\n - `plan-D`: plan-D (without bundle), plan-D (D-300MB).\n - `plan-K2`: plan-K2 (K2-300MB).\n - `plan-DU`\n - `plan-KM1`\n - `plan-K`\n - `planArc01`: Virtual SIM/Subscriber.\n- For global coverage, specify one of the following:\n - `plan01s`\n - `plan01s-low_data_volume`: plan01s - Low Data Volume.\n - `planX3`: planX3 (X3-5MB), planX3.\n - `planP1`\n - `plan-US`\n - `plan-US-max`\n - `planX1`\n - `planX2`\n - `planX3-EU`\n - `plan-US-NA`\n - `planArc01`: Virtual SIM/Subscriber.\n" }, { "name": "module_type", "value": "", "type": "query", "description": "Module type (e.g. `mini`, `virtual`) to search." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of item to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward." }, { "name": "search_type", "value": "", "type": "query", "description": "Type of the search ('AND searching' or 'OR searching')." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "(DEPRECATED: please consider to use `/query/sims` API instead ) Search subscribers by query terms. It returns partial match results. When this API permission is allowed, it grants the authority to search and retrieve all SIMs that includes their group information." }, { "info": { "name": "Search traffic volume ranking of subscribers", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/query/subscribers/traffic_volume/ranking", "params": [ { "name": "from", "value": "", "type": "query", "description": "The beginning point of searching range (UNIX time in milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "The end point of searching range (UNIX time in milliseconds)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of item to retrieve." }, { "name": "order", "value": "", "type": "query", "description": "The order of ranking." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Search traffic volume ranking of subscribers." } ] }, { "info": { "name": "ResourceSummary", "type": "folder" }, "items": [ { "info": { "name": "Get the resource summary identified by resource_summary_type", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/resource_summaries/:resource_summary_type", "params": [ { "name": "resource_summary_type", "value": "", "type": "path", "description": "The type of the resource summary.\n\n- `simsPerStatus`: The number of IoT SIMs per status.\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Obtain a resource summary information identified by resource_summary_type." } ] }, { "info": { "name": "SigfoxDevice", "type": "folder" }, "items": [ { "info": { "name": "List Sigfox devices.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sigfox_devices", "params": [ { "name": "tag_name", "value": "", "type": "query", "description": "Tag name for filtering the search (exact match)." }, { "name": "tag_value", "value": "", "type": "query", "description": "Tag search string for filtering the search. Required when `tag_name` has been specified." }, { "name": "tag_value_match_mode", "value": "", "type": "query", "description": "Tag match mode." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of Sigfox devices to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The device ID of the last Sigfox device retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next Sigfox device onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of Sigfox devices that match certain criteria. If the total number of Sigfox devices does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Get Sigfox device.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target Sigfox device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns information about the specified Sigfox device." }, { "info": { "name": "Retrieves data sent from a Sigfox device to Harvest Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id/data", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "ID of the Sigfox device from which to retrieve data. The ID of a Sigfox device can be obtained using the [SigfoxDevice:listSigfoxDevices API](#!/SigfoxDevice/listSigfoxDevices)." }, { "name": "from", "value": "", "type": "query", "description": "Start time of the target period (UNIX time in milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "End time of the target period (UNIX time in milliseconds)." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order of data entries. Either descending order (latest data entry first) or ascending order (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of data entries to retrieve (1 to 1000). The default is `10`." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Timestamp of the last data entry retrieved on the previous page. By specifying this parameter, the list starting from the next data entry can be obtained." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves data that matches the specified conditions from the data sent by the specified Sigfox device to Harvest Data. If the data entries do not fit in one page, a URL to retrieve the next page with the same conditions will be included in the `link` header of the response.\n" }, { "info": { "name": "Send data to a Sigfox device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id/data", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "ID of the recipient device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sends data to the specified Sigfox device. The data will be stored until the device sends a next uplink message. If another message destined for the same Sigfox device ID is already waiting to be sent, the existing message will be discarded, and the new message will be sent instead." }, { "info": { "name": "Disable Termination of Sigfox device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id/disable_termination", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target Sigfox device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Disables termination of specified Sigfox device." }, { "info": { "name": "Enable Termination of Sigfox device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id/enable_termination", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target Sigfox device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables termination of specified Sigfox device." }, { "info": { "name": "Registers a Sigfox device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id/register", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target Sigfox device to register." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Registers a Sigfox device." }, { "info": { "name": "Adds a Sigfox device to a Sigfox group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id/set_group", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "ID of the target Sigfox device. The ID of a Sigfox device can be obtained using the [SigfoxDevice:listSigfoxDevices API](#!/SigfoxDevice/listSigfoxDevices)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds a Sigfox device to a Sigfox group." }, { "info": { "name": "Bulk Insert or Update Sigfox device Tags.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id/tags", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target Sigfox device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Inserts/updates tags for the specified Sigfox device." }, { "info": { "name": "Delete Sigfox device Tag.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id/tags/:tag_name", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target Sigfox device." }, { "name": "tag_name", "value": "", "type": "path", "description": "Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a tag from the specified Sigfox device." }, { "info": { "name": "Terminate Sigfox device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id/terminate", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target Sigfox device." }, { "name": "delete_immediately", "value": "", "type": "query", "description": "If the Sigfox device is deleted immediately." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Terminates the specified Sigfox device." }, { "info": { "name": "Removes a Sigfox device from a Sigfox group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sigfox_devices/:device_id/unset_group", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "ID of the target Sigfox device. The ID of a Sigfox device can be obtained using the [SigfoxDevice:listSigfoxDevices API](#!/SigfoxDevice/listSigfoxDevices)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Removes a Sigfox device from a Sigfox group." } ] }, { "info": { "name": "SimProfileOrder", "type": "folder" }, "items": [ { "info": { "name": "List eSIM profile orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sim_profile_orders", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of eSIM profile orders to retrieve. However, the number of eSIM profile orders returned may be less than the specified value." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The ID of the last eSIM profile order retrieved on the previous page. By repeating the API call while specifying this parameter, the next page of eSIM profile orders will be returned." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of eSIM profile orders. If the total number of orders does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Create a new eSIM profile order", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sim_profile_orders", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a new eSIM profile order without confirming it. An unconfirmed order is valid for 1 day, after which it is automatically canceled.\nUse the [SimProfileOrder:confirmProfileOrder API](#/SimProfileOrder/confirmProfileOrder) to confirm the order.\n" }, { "info": { "name": "Get an eSIM profile order", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sim_profile_orders/:profile_order_id", "params": [ { "name": "profile_order_id", "value": "", "type": "path", "description": "The ID of the eSIM profile order." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get an eSIM profile order.\n" }, { "info": { "name": "Cancel an eSIM profile order", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/sim_profile_orders/:profile_order_id", "params": [ { "name": "profile_order_id", "value": "", "type": "path", "description": "The ID of the eSIM profile order." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Cancels an unconfirmed eSIM profile order.\n" }, { "info": { "name": "Confirm an eSIM profile order", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sim_profile_orders/:profile_order_id/confirm", "params": [ { "name": "profile_order_id", "value": "", "type": "path", "description": "The ID of the eSIM profile order." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Confirms an unconfirmed eSIM profile order and completes the order.\nOnce confirmed, an eSIM profile order cannot be canceled.\n" }, { "info": { "name": "List eSIM profiles created by the eSIM profile order", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sim_profile_orders/:profile_order_id/profiles", "params": [ { "name": "profile_order_id", "value": "", "type": "path", "description": "The ID of the eSIM profile order." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of eSIM profiles created by the specified eSIM profile order.\n" } ] }, { "info": { "name": "Sim", "type": "folder" }, "items": [ { "info": { "name": "List SIMs", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sims", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of SIMs to retrieve. However, the number of SIMs returned may be less than the specified value." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of SIMs. If the total number of SIMs does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Creates a new virtual SIM/Subscriber", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a new Soracom Arc virtual SIM/Subscriber. For details, please refer to [Creating Virtual SIMs](/en/docs/arc/configuration/)." }, { "info": { "name": "Gets information about the IoT SIM", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sims/:sim_id", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets information about the IoT SIM." }, { "info": { "name": "Activate SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/activate", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Changes status of specified SIM to \"active\"." }, { "info": { "name": "(DEPRECATED) Attaches the credentials for Arc to a SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/credentials/arc", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "(DEPRECATED) Attaches the credentials (public key) for Soracom Arc to the SIM.\n\n**Warning**: Please use the `renewArcSimCredentials` API instead.\n" }, { "info": { "name": "Renew the credentials for Arc to a SIM", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/sims/:sim_id/credentials/arc", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Attaches Arc credential to a SIM and re-initialize a session at once." }, { "info": { "name": "(DEPRECATED) Removes the credentials for Arc from a SIM", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/sims/:sim_id/credentials/arc", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "(DEPRECATED) Removes the credentials (public key) for Soracom Arc from the SIM.\n\n**Warning**: Do not use this API.\n" }, { "info": { "name": "Get data sent from a SIM to Harvest Data.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sims/:sim_id/data", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." }, { "name": "from", "value": "", "type": "query", "description": "Start time for the data entries search range (UNIX time in milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "End time for the data entries search range (UNIX time in milliseconds)." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of data entries sent to Harvest Data from a SIM that match certain criteria. If the total number of data entries does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Deactivate SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/deactivate", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Changes status of specified SIM to \"inactive\"." }, { "info": { "name": "Delete and reconnect the Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/delete_session", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes and then reconnects the session for the specified SIM.\n\n**Warning**: If you attempt to delete the session for an offline IoT SIM, the following error message will be returned:\n\n```\nError: {\"code\":\"SEM0016\",\"message\":\"The specified subscriber is offline\"}\n```\n" }, { "info": { "name": "Disables termination of the SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/disable_termination", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables termination protection for the specified IoT SIM (disables termination)." }, { "info": { "name": "Send an HTTP request to a device using an IoT SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/downlink/http", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target IoT SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sends an HTTP request to a device using an IoT SIM and returns the HTTP response from the device in the API response body.\n" }, { "info": { "name": "Sends ping requests to a SIM.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/downlink/ping", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sends ICMP ping requests to a SIM." }, { "info": { "name": "Send a command to a RTSP stream to a device using an IoT SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/downlink/rtsp", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target IoT SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sends a command to a device using an IoT SIM and returns a response based on specified command and options in request.\n\n- An error occurs if the command does not complete within 10 seconds.\n" }, { "info": { "name": "Connect to a device using an IoT SIM via SSH and execute a specified command", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/downlink/ssh", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target IoT SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims).\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Connects to a device using an IoT SIM via SSH, executes a specified command, and returns the standard output and standard error output in the API response body.\n" }, { "info": { "name": "Connect to a device using an IoT SIM via TCP and send/receive data", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/downlink/tcp", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target IoT SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims).\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Connects to a device using an IoT SIM via TCP, sends specified data, and returns data received from the device.\n\n- The maximum size of sent and received data is 5 MiB each.\n- If sending and receiving data is not completed within the time specified by `timeout`, an error will occur.\n" }, { "info": { "name": "Send data using IoT SIM via UDP", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/downlink/udp", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target IoT SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims).\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sends specified data to a device using an IoT SIM via UDP.\n\n**Warning**: Unlike TCP, UDP communication lacks retransmission and sequencing mechanisms, which may lead to packet loss or out-of-order arrival.\n" }, { "info": { "name": "Enables termination of the SIM.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/enable_termination", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Disables termination protection for the specified IoT SIM (enables termination)." }, { "info": { "name": "Retrieves session event history (session history)", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sims/:sim_id/events/sessions", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." }, { "name": "from", "value": "", "type": "query", "description": "Start time (UNIX time in milliseconds) of the period to retrieve the session event history." }, { "name": "to", "value": "", "type": "query", "description": "End time (UNIX time in milliseconds) of the period to retrieve the session event history." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of event histories to retrieve. However, the number of event histories returned may be less than the specified value." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves event history of session creation/modification/disconnection for the past 32 days for the specified SIM. If the total number of events does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n\nCheck the current session using the [Sim:getSim API](#!/Sim/getSim). To check the current session with this API, check the value of `event` in the latest session history. Refer to [Subscriber Status](/en/docs/air/subscriber-status/) for the mea" }, { "info": { "name": "Lists packet capture sessions associated with the SIM", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sims/:sim_id/packet_capture_sessions", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page." }, { "name": "limit", "value": "", "type": "query", "description": "Max number of results in a response." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Lists packet capture sessions associated with the SIM." }, { "info": { "name": "Creates a packet capture session associated with the SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/packet_capture_sessions", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a packet capture session associated with the SIM." }, { "info": { "name": "Gets a packet capture session associated with the SIM", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sims/:sim_id/packet_capture_sessions/:session_id", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." }, { "name": "session_id", "value": "", "type": "path", "description": "Packet capture session ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets a packet capture session associated with the SIM." }, { "info": { "name": "Deletes a packet capture session associated with the SIM", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/sims/:sim_id/packet_capture_sessions/:session_id", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." }, { "name": "session_id", "value": "", "type": "path", "description": "Packet capture session ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a packet capture session associated with the SIM." }, { "info": { "name": "Stops a packet capture session associated with the SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/packet_capture_sessions/:session_id/stop", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." }, { "name": "session_id", "value": "", "type": "path", "description": "Packet capture session ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Stops a packet capture session associated with the SIM." }, { "info": { "name": "Adds a new secondary subscription to an IoT SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/profiles/:iccid/add_subscription", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." }, { "name": "iccid", "value": "", "type": "path", "description": "ICCID of the target IoT SIM. For IoT SIMs that do not support eUICC, the ICCID and SIM ID are the same." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Add a new secondary subscription ([additional subscription](/en/docs/air/subscription-containers/#adding-a-subscription) or [virtual SIM/Subscriber](/en/docs/arc/configuration/#adding-a-virtual-sim-to-an-air-sim)) to the IoT SIM." }, { "info": { "name": "Cancel the OTA to the subscription container for an additional subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/profiles/:iccid/subscribers/:imsi/cancel_download", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "The SIM ID of the target SIM." }, { "name": "iccid", "value": "", "type": "path", "description": "The ICCID of the target subscription container." }, { "name": "imsi", "value": "", "type": "path", "description": "The IMSI of the target additional subscription." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Cancel the OTA of the additional subscription before the OTA starts. Note that once the IoT SIM goes online and the OTA begins, it cannot be canceled." }, { "info": { "name": "Terminates subscription container", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/profiles/:iccid/subscribers/:imsi/terminate", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target subscription container." }, { "name": "iccid", "value": "", "type": "path", "description": "ICCID of the target subscription container." }, { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscription container." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Terminates subscription container. Currently this API supports only for virtual SIM/Subscribers for Soracom Arc." }, { "info": { "name": "Registers an IoT SIM to an operator", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/register", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Registers an IoT SIM to an operator." }, { "info": { "name": "Gets SIM local information report", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/report_local_info", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets SIM local information report.\n\n**Alert**: One SMS will be sent to the IoT device per request for SIM local information report. Sending SMS to IoT devices is charged. For more information on fees, refer to the following page\n- [Pricing & Fee Schedule](/en/docs/reference/fees/)\n" }, { "info": { "name": "Send an SMS to an IoT SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/send_sms", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM to which the SMS will be sent. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sends an SMS to the specified IoT SIM." }, { "info": { "name": "Creates a Soracom Arc session", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/sessions/arc", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a Soracom Arc session. If the session already exists, re-create it." }, { "info": { "name": "Sets expiry time of IoT SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/set_expiry_time", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sets the expiration date and action for the specified IoT SIM." }, { "info": { "name": "Adds a SIM to a SIM group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/set_group", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "ID of the target SIM. The SIM ID can be obtained using the [Sim:listSims API](#/Sim/listSims)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds a SIM to a SIM group." }, { "info": { "name": "Sets IMEI lock configuration for the SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/set_imei_lock", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sets IMEI that the SIM should be locked to." }, { "info": { "name": "Set SIM to standby mode.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/set_to_standby", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Changes status of specified SIM to \"standby\"." }, { "info": { "name": "List IoT SIM status operation history", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sims/:sim_id/statuses/history", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." }, { "name": "from", "value": "", "type": "query", "description": "Start time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, `from` is set to the oldest status operation history entry time of the target IoT SIM." }, { "name": "to", "value": "", "type": "query", "description": "End time of the status operation history entry to be searched (UNIX time in milliseconds). If not specified, `to` is set to the current time." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The value of the `x-soracom-next-key` header from the previous response. Specify this to retrieve the next page." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order of status operation history entry. Either descending (latest data entry first) or ascending (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to retrieve in one request. The response may contain fewer items than the specified limit." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "List IoT SIM status operation history. Status operation history entry records what status operations were performed for which IMSI and which subscriptions, along with the operation time. It includes speed class, group ID, IoT SIM status, etc. If the total number of status operation history entry does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response." }, { "info": { "name": "Suspend SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/suspend", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Changes status of specified SIM to \"suspended\"." }, { "info": { "name": "Bulk Add or Update tags for an IoT SIM", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/sims/:sim_id/tags", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds or updates tags for the specified IoT SIM.\n\nThe name of the IoT SIM is registered as a tag with the key `name`.\n" }, { "info": { "name": "Deletes a tag from the specified SIM", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/sims/:sim_id/tags/:tag_name", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." }, { "name": "tag_name", "value": "", "type": "path", "description": "Tag name to be deleted. This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().\n\n**Warning**: If you are using Soracom CLI, do not use URL encoding (percent-encoding).\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a tag from the specified IoT SIM." }, { "info": { "name": "Terminate an IoT SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/terminate", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Terminates the specified IoT SIM. Please use the [Sim:enableSimTermination API](#!/Sim/enableSimTermination) in advance to enable termination (remove termination protection).\n" }, { "info": { "name": "Get usage of IoT SIM in testing status", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sims/:sim_id/testing/usage", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target IoT SIM." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the usage information of \"testing\" status of the IoT SIM. Data can only be retrieved while the IoT SIM is in \"testing\" status." }, { "info": { "name": "Deletes expiry time of the SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/unset_expiry_time", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes expiry time of specified SIM and changes it to indefinite." }, { "info": { "name": "Removes a SIM from a SIM group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/unset_group", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "ID of the target SIM. The SIM ID can be obtained using the [Sim:listSims API](#/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Removes a SIM from a SIM group." }, { "info": { "name": "Unsets IMEI lock of SIM", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/unset_imei_lock", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Unsets the IMEI lock of the specified SIM." }, { "info": { "name": "Updates the IoT SIM speed class", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sims/:sim_id/update_speed_class", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the IoT SIM speed class." } ] }, { "info": { "name": "SoraCam", "type": "folder" }, "items": [ { "info": { "name": "List SoraCam compatible camera devices.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Obtains a list of cameras that are compatible with the Soracom Cloud Camera Services.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, { "info": { "name": "Get the SoraCam compatible camera device information identified by device_id.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Obtain a SoraCam compatible camera device record for the device identified by device_id.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, { "info": { "name": "Delete the SoraCam compatible camera device identified by device_id.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete a SoraCam compatible camera device from the operator identified by device_id.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, { "info": { "name": "Retrieve firmware update information for a SoraCam compatible camera device", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/firmware/update", "params": [ { "name": "device_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns available firmware update information for a SoraCam compatible camera device.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, { "info": { "name": "Update a firmware for a SoraCam compatible camera device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/firmware/update", "params": [ { "name": "device_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Update a firmware for a SoraCam compatible camera device if it is available. The SoraCam compatible camera device will be offline while updating.\n\n**Warning**: Please do not turn off the power while updating.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/" }, { "info": { "name": "Update the assigned license for a SoraCam compatible camera device", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/license", "params": [ { "name": "device_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the license for a specified SoraCam compatible camera device.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, { "info": { "name": "Unassign the license from a SoraCam compatible camera device", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/license", "params": [ { "name": "device_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Unassigns the license from a specified SoraCam compatible camera device.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Warning**: Devices will not undergo cloud recording by Soracom Cloud Camera Services unless" }, { "info": { "name": "Get a live image from a SoraCam compatible camera device", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/live_image", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets a live image from a SoraCam compatible camera device. Images are captured at the time the API is called and a download URL is returned.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must enable rea" }, { "info": { "name": "Retrieve enabled options for a SoraCam-compatible camera", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/options", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "The device ID of the SoraCam-compatible camera." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets a list of whether the following options are enabled for a SoraCam-compatible camera.\n\n- [Real-time access](https://users.soracom.io/ja-jp/docs/soracom-cloud-camera-services/real-time-access/) (Japanese)\n" }, { "info": { "name": "Enable or disable real-time access for a SoraCam-compatible camera", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/options/real_time_access", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "The device ID of the SoraCam-compatible camera." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables or disables the real-time access feature for a SoraCam-compatible camera.\nWhen enabled, the camera can be accessed directly via P2P communication for retrieving camera feed and performing operations in real time.\n\n**Warning:** Real-time access is a paid feature. For more details, see the [documentation](https://users.soracom.io/ja-jp/docs/soracom-cloud-camera-services/real-time-access/) (Japanese).\n" }, { "info": { "name": "Retrieve the camera's various settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the camera's various settings.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, { "info": { "name": "Retrieve the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/logo", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target S" }, { "info": { "name": "Change the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/logo", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Change the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Sor" }, { "info": { "name": "Retrieve the settings for motion detection", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/motion", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the settings for motion detection. If motion detection is enabled, recording will start when the SoraCam compatible camera device detects moving objects.\n\n**Warning**: Even if a Cloud Motion Detection \"Unlimited\" Recording License is assigned to the SoraCam compatible camera device, no recording will occur if motion detection is disabled, as it will not detect any moving objects.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have pe" }, { "info": { "name": "Change the settings for motion", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/motion", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Change the settings for motion detection. If motion detection is enabled, recording will start when the SoraCam compatible camera device detects moving objects.\n\n**Warning**: Even if a Cloud Motion Detection \"Unlimited\" Recording License is assigned to the SoraCam compatible camera device, no recording will occur if motion detection is disabled, as it will not detect any moving objects.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have perm" }, { "info": { "name": "Retrieve the settings for motion sensitivity", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/motion_sensitivity", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the settings for motion sensitivity.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, { "info": { "name": "Change the settings for motion sensitivity", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/motion_sensitivity", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Change the settings for motion sensitivity.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, { "info": { "name": "Retrieve the display settings for motion tagging", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/motion_tagging", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the display settings for motion tagging. Motion tagging is a green frame that is displayed when motion is detected.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud lice" }, { "info": { "name": "Change the display settings for motion tagging", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/motion_tagging", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Change the display settings for motion tagging. Motion tagging is a green frame that is displayed when motion is detected.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud licens" }, { "info": { "name": "Retrieve the settings for night vision mode", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/night_vision", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the settings for night vision mode.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, { "info": { "name": "Change the settings for night vision mode", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/night_vision", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Change the settings for night vision mode.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, { "info": { "name": "Retrieve the quality settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/quality", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the quality settings.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, { "info": { "name": "Change the quality settings", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/quality", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Changes the quality settings. The quality settings will be applied to all videos and still images captured by the specified SoraCam compatible camera device. Note that if the Wi-Fi bandwidth is insufficient, the quality settings may automatically be adjusted.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions," }, { "info": { "name": "Retrieve the settings for rotating the image by 180 degrees", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/rotation", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the settings for rotating the image by 180 degrees.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time " }, { "info": { "name": "Change the settings for rotating the image by 180 degrees", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/rotation", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Change the settings for rotating the image by 180 degrees.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time ac" }, { "info": { "name": "Retrieve the settings for sound detection", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/sound", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the settings for sound detection. If sound detection is enabled, recording will start when the SoraCam compatible camera device detects sound.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Warning**: Video recorded via sou" }, { "info": { "name": "Change the settings for sound detection", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/sound", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Change the settings for sound detection. If sound detection is enabled, recording will start when the SoraCam compatible camera device detects sound.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Warning**: Video recorded via sound" }, { "info": { "name": "Retrieve the settings for sound sensitivity", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/sound_sensitivity", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the settings for sound sensitivity.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, { "info": { "name": "Change the settings for sound sensitivity", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/sound_sensitivity", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Change the settings for sound sensitivity.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-compatible camera or enable real-time access.\n" }, { "info": { "name": "Retrieve the settings for the status light (indicator light that shows the status of the camera)", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/status_light", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the settings for the status light (indicator light that shows the status of the camera).\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-c" }, { "info": { "name": "Change the settings for the status light (indicator light that shows the status of the camera)", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/status_light", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Change the settings for the status light (indicator light that shows the status of the camera).\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-com" }, { "info": { "name": "Retrieve the display settings for the timestamp shown on the bottom right of the captured image", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/timestamp", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieve the display settings for the timestamp shown on the bottom right of the captured image.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-co" }, { "info": { "name": "Change the display settings for the timestamp shown on the bottom right of the captured image", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/atom_cam/settings/timestamp", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Change the display settings for the timestamp shown on the bottom right of the captured image.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n\n**Info**: To use this API, you must either assign a cloud license to the target Soracom-comp" }, { "info": { "name": "Save arbitrary data to Harvest Data linked to a SoraCam compatible camera device", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/data", "headers": [ { "name": "content-type", "value": "" } ], "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Saves arbitrary data to Harvest Data that will be associated to a SoraCam compatible camera device specified by its device ID (`device_id`).\n\nFor example, to save JSON data, set `Content-Type: application/json` in the header and specify `{ \"person_count\": 5 }` in the request body.\n\n**Warning**: When using a SAM user's API key and API token to execute this API, you must grant the SAM user the `OAuth2:authorize` permission in addition to the permissions required to call this API (e.g., `SoraCam:*`" }, { "info": { "name": "Save arbitrary data to Harvest Data linked to a SoraCam compatible camera device and timestamp", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/data/:time", "headers": [ { "name": "content-type", "value": "" } ], "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." }, { "name": "time", "value": "", "type": "path", "description": "The timestamp of the target data entry (UNIX time in milliseconds)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Saves arbitrary data to Harvest Data with a particular timestamp that will be associated to a SoraCam compatible camera device specified by its device ID (`device_id`).\n\n- If no data exists for the specified timestamp, a new data entry will be created.\n- If data already exists for the specified timestamp, it will be overwritten according to the specifications of Harvest Data.\n\nFor example, to save JSON data, set `Content-Type: application/json` in the header and specify `{ \"person_count\": 5 }` i" }, { "info": { "name": "List SoraCam events for the specified device.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/events", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of events to retrieve in one request (value range is 1 to 1000). Note that the response may contain fewer events than the specified limit." }, { "name": "from", "value": "", "type": "query", "description": "Start time of the events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest event time." }, { "name": "to", "value": "", "type": "query", "description": "End time of the events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time." }, { "name": "sort", "value": "", "type": "query", "description": "Event list sort order.\n\n- `desc`: Descending order (newest events detected by target SoraCam compatible camera device first).\n- `asc`: Ascending order (oldest events detected by target SoraCam compatible camera device first).\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns list of SoraCam events for the specified device.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, { "info": { "name": "Get the remaining number of still images that can be exported and the remaining exportable time of recorded video.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/exports/usage", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get the remaining number of still images that can be exported and the remaining exportable time of recorded video.\n\n**Warning**: Exporting either still images or recorded video will consume the available video viewing time (72 hours per month by default).\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see" }, { "info": { "name": "Set the monthly limit on the recorded video time available for export for SoraCam compatible camera device.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/exports/usage/limit_override", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Set the monthly limit on the recorded video time available for export. By default, the limit is set to 72 hours per month. A maximum of 1,500 hours can be set.\n\n**Warning**: Additional costs will be incurred for recorded video exported beyond 72 hours. Simply changing the monthly limit does not result in any charges.. However, exceeding 72 hours of export time consumption will incur charges regardless of the set export time limit. For more information about fees, see Soracom Cloud Camera Service" }, { "info": { "name": "Reset the monthly limit on the recorded video time available for export for SoraCam compatible camera device to the default value.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/exports/usage/limit_override", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Reset the monthly limit on the recorded video time available for export to the default value. By default, the limit is set to 72 hours per month.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, { "info": { "name": "Get a list of the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/images/exports", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit." }, { "name": "sort", "value": "", "type": "query", "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets the list of the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedImage API](#!/SoraCam/exportSoraCamDeviceRecordedImage). This API limits the target to one SoraCam compatible camera device.\n\nIf the target is not limited to one SoraCam compatible camera device, but all SoraCam compatible camera devices owned by the operator, use [SoraCam:listSoraCamDeviceImageExports API](#!" }, { "info": { "name": "Start the process of exporting still images from recorded video saved on the cloud", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/images/exports", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Starts the process of extracting and exporting still images from recorded video saved on the cloud. The export process is processed asynchronously. The progress of the export process and the URL of the exported file can be obtained with the [SoraCam:listSoraCamDeviceImageExports API](#!/SoraCam/listSoraCamDeviceImageExports). The URL has an expiration time.\n\n- At the time of obtaining the URL, the available video viewing time (72 hours per month by default) will be consumed regardless of whether" }, { "info": { "name": "Get the current status of the process of exporting still images from recorded video taken with a SoraCam compatible camera device", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/images/exports/:export_id", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." }, { "name": "export_id", "value": "", "type": "path", "description": "Export ID of the target export operation." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedImage API](#!/SoraCam/exportSoraCamDeviceRecordedImage). This API limits the target to one export process.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information" }, { "info": { "name": "Get the current name of the SoraCam compatible camera device.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/name", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get the current name of the SoraCam compatible camera device." }, { "info": { "name": "Changes the name of the SoraCam compatible camera device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/name", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Changes the name of the SoraCam compatible camera device." }, { "info": { "name": "Get the current power state of the SoraCam compatible camera device.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/power_state", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get the current power state of the SoraCam compatible camera device." }, { "info": { "name": "Changes the power state of the SoraCam compatible camera device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/power_state", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Changes the power state of the SoraCam compatible camera device." }, { "info": { "name": "Reboot the SoraCam compatible camera device.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/reboot", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Reboot the SoraCam compatible camera device." }, { "info": { "name": "Retrieve a list of recording periods and events for a SoraCam compatible camera device", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/recordings_and_events", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination." }, { "name": "from", "value": "", "type": "query", "description": "Start time of the recordings and events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest time within the retention period of the license that is assigned to the SoraCam compatible camera device." }, { "name": "to", "value": "", "type": "query", "description": "End time of the recordings and events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time." }, { "name": "sort", "value": "", "type": "query", "description": "Recordings and events list sort order.\n\n- `desc`: Descending order (newest data first).\n- `asc`: Ascending order (oldest data first).\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of recordings and events for a SoraCam compatible camera device.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, { "info": { "name": "Get information for streaming recorded video from the cloud.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/stream", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." }, { "name": "from", "value": "", "type": "query", "description": "Start time of recorded video (UNIX time in milliseconds).\n\n- Omit both `from` and `to` to get information for streaming the latest video.\n" }, { "name": "to", "value": "", "type": "query", "description": "End time of recorded video (UNIX time in milliseconds).\n\n- Omit both `from` and `to` to get information for streaming the latest video.\n- The maximum duration that can be viewed in a single API call is 900 seconds (15 minutes). Make sure the difference between `from` and `to` does not exceed 900 seconds.\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get information for streaming recorded video from the cloud. Specifically, you can get an array of URLs that support a streaming method called MPEG-DASH (Dynamic Adaptive Streaming over HTTP). The URL has an expiration time.\n\n- To stream the latest video, omit both `from` and `to`. Please be aware of the following points in that case:\n - You can get a URL to stream the latest 300 seconds (5 minutes) of video based on the time of the API called. To continue watching, call the API again to get th" }, { "info": { "name": "Get a list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/videos/exports", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit." }, { "name": "sort", "value": "", "type": "query", "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets the list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedVideo API](#!/SoraCam/exportSoraCamDeviceRecordedVideo). This API limits the target to one SoraCam compatible camera device.\n\nIf the target is not limited to one SoraCam compatible camera device, but all SoraCam compatible camera devices owned by the operator, use [SoraCam:listSoraCamDeviceVideoExports API](#!/SoraCam/listSora" }, { "info": { "name": "Start the process of exporting recorded video saved on the cloud", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/videos/exports", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Starts the process of exporting recorded video saved on the cloud in a format that can be downloaded (zipped mp4 files). The export process is processed asynchronously. The progress of the export process and the URL of the exported file can be obtained with the [SoraCam:listSoraCamDeviceVideoExports API](#!/SoraCam/listSoraCamDeviceVideoExports). The URL has an expiration time.\n\n- The maximum export time for a single URL is 900 seconds (15 minutes).\n- At the time of obtaining the URL, the availa" }, { "info": { "name": "Get the current status of the process of exporting recorded video taken with a SoraCam compatible camera device", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/:device_id/videos/exports/:export_id", "params": [ { "name": "device_id", "value": "", "type": "path", "description": "Device ID of the target SoraCam compatible camera device." }, { "name": "export_id", "value": "", "type": "path", "description": "Export ID of the target export operation." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets the current status of the process of exporting recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedVideo API](#!/SoraCam/exportSoraCamDeviceRecordedVideo). This API limits the target to one export process.\n\n**Warning**: When calling this API using a SAM User's API key and API token, the SAM User must also have permission to call the `OAuth2:authorize` API in addition to permission to call this API. For more information on setting permi" }, { "info": { "name": "Retrieve a list of SoraCam compatible camera devices that can update the firmware", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/atom_cam/firmware/updates", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of SoraCam compatible camera devices that can update the firmware.\n\n**Warning**: If you will run this API with a SAM user's API key and API token, please add the `OAuth2:authorize` permission to the SAM user in addition to the permission required to call this API (e.g. `SoraCam:*`). For more information on setting permissions, see [Access Levels](/en/docs/security/users-and-roles/#access-levels).\n" }, { "info": { "name": "List SoraCam events.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/events", "params": [ { "name": "device_id", "value": "", "type": "query", "description": "Device ID of the target SoraCam compatible camera device. If not specified, retrieves event history for all SoraCam compatible camera devices owned by the operator." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of events to retrieve in one request (value range is 1 to 1000). Note that the response may contain fewer events than the specified limit." }, { "name": "from", "value": "", "type": "query", "description": "Start time of the events to retrieve (unix time in milliseconds). If not specified, `from` is set to the oldest event time." }, { "name": "to", "value": "", "type": "query", "description": "End time of the events to retrieve (unix time in milliseconds). If not specified, `to` is set to the current time." }, { "name": "sort", "value": "", "type": "query", "description": "Event list sort order.\n\n- `desc`: Descending order (newest events detected by SoraCam compatible camera device first).\n- `asc`: Ascending order (oldest events detected by SoraCam compatible camera device first).\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns list of SoraCam events." }, { "info": { "name": "Get a list of the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/images/exports", "params": [ { "name": "device_id", "value": "", "type": "query", "description": "Device ID of the target SoraCam compatible camera device. If not specified, returns all SoraCam compatible camera devices owned by the operator." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit." }, { "name": "sort", "value": "", "type": "query", "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets the list of the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedImage API](#!/SoraCam/exportSoraCamDeviceRecordedImage). This API can target all devices owned by the operator, or limit it to one SoraCam compatible camera device.\n\n**Warning**: The URL becomes unusable 10 minutes after export completion. The time until the URL becomes unusable can be checked with `expiryTime" }, { "info": { "name": "Get a list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/devices/videos/exports", "params": [ { "name": "device_id", "value": "", "type": "query", "description": "Device ID of the target SoraCam compatible camera device. If not specified, returns all SoraCam compatible camera devices owned by the operator." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Value of the `x-soracom-next-key` header in the previous response. Use this to continue pagination." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to retrieve in one request. Note that the response may contain fewer items than the specified limit." }, { "name": "sort", "value": "", "type": "query", "description": "Export list sort order.\n\n- `desc`: Descending order (newest export process first).\n- `asc`: Ascending order (oldest export process first).\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Gets the list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device started by [SoraCam:exportSoraCamDeviceRecordedVideo API](#!/SoraCam/exportSoraCamDeviceRecordedVideo). This API can target all devices owned by the operator, or limit it to one SoraCam compatible camera device.\n\n**Warning**: The URL becomes unusable 10 minutes after export completion. The time until the URL becomes unusable can be checked with `expiryTime`. Additionally, " }, { "info": { "name": "List license packs of Soracom Cloud Camera Services", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/sora_cam/license_packs", "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns the list of license packs which you can use. Currently, this API is only available for Japan coverage." }, { "info": { "name": "Update the license quantity of Soracom Cloud Camera Services", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/sora_cam/license_packs/:license_pack_id/quantity", "params": [ { "name": "license_pack_id", "value": "", "type": "path", "description": "ID of the license pack." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates the license quantity for the license pack identified by license_pack_id. This operation will cost you monthly fee based on number of licenses. Currently, this API is only available for Japan coverage." } ] }, { "info": { "name": "Soralet", "type": "folder" }, "items": [ { "info": { "name": "List Soralets", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/soralets", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items in a response." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The identifier of the last Soralet retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next Soralet onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of Soralets." }, { "info": { "name": "Create a Soralet", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/soralets", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Create a Soralet." }, { "info": { "name": "Get a Soralet", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/soralets/:soralet_id", "params": [ { "name": "soralet_id", "value": "", "type": "path", "description": "The identifier of Soralet." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a Soralet." }, { "info": { "name": "Delete Soralet", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/soralets/:soralet_id", "params": [ { "name": "soralet_id", "value": "", "type": "path", "description": "The identifier of Soralet." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete the specified Soralet." }, { "info": { "name": "Get log messages from Soralet", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/soralets/:soralet_id/logs", "params": [ { "name": "soralet_id", "value": "", "type": "path", "description": "The identifier of Soralet." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items in a response." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The identifier of the last log message retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next log message onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of log messages from the specified Soralet." }, { "info": { "name": "Execute Soralet with arguments", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/soralets/:soralet_id/test", "params": [ { "name": "soralet_id", "value": "", "type": "path", "description": "The identifier of Soralet." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Execute the specified Soralet with the specified arguments." }, { "info": { "name": "List versions of Soralet", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/soralets/:soralet_id/versions", "params": [ { "name": "soralet_id", "value": "", "type": "path", "description": "The identifier of Soralet." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items in a response." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The identifier of the last version retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next version onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of Soralet versions." }, { "info": { "name": "Upload code and create a new version", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/soralets/:soralet_id/versions", "headers": [ { "name": "content-type", "value": "" } ], "params": [ { "name": "soralet_id", "value": "", "type": "path", "description": "The identifier of Soralet." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Upload code and create a new version." }, { "info": { "name": "Delete a Soralet version", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/soralets/:soralet_id/versions/:version", "params": [ { "name": "soralet_id", "value": "", "type": "path", "description": "The identifier of Soralet." }, { "name": "version", "value": "", "type": "path", "description": "Soralet version." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete the specified Soralet version." } ] }, { "info": { "name": "Stats", "type": "folder" }, "items": [ { "info": { "name": "Get Air Usage Report of a Group.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/stats/air/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "Group ID" }, { "name": "from", "value": "", "type": "query", "description": "Specify the start month/day of the period to be aggregated in UNIX time in seconds." }, { "name": "to", "value": "", "type": "query", "description": "Specify the end month/day of the period to be aggregated in UNIX time in seconds." }, { "name": "period", "value": "", "type": "query", "description": "Unit of aggregation.\n\n- `month`: Monthly.\n\n The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Daily\n\n The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the usage report aggregating all SIMs that belong to the specified Group." }, { "info": { "name": "Get Air Usage Report of an Operator.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/stats/air/operators/:operator_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "from", "value": "", "type": "query", "description": "Specify the start month/day of the period to be aggregated in UNIX time in seconds." }, { "name": "to", "value": "", "type": "query", "description": "Specify the end month/day of the period to be aggregated in UNIX time in seconds." }, { "name": "period", "value": "", "type": "query", "description": "Unit of aggregation.\n\n- `month`: Monthly.\n\n The `from` and `to` should be UNIX time (in seconds) from 3 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Daily\n\n The `from` and `to` should be UNIX time (in seconds) from 7 days before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the usage report aggregating all SIMs that belong to the specified Operator." }, { "info": { "name": "Export Air Usage Report of All Subscribers", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/stats/air/operators/:operator_id/export", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID. The operator ID can be obtained from the [Operator:getOperator API](#!/Operator/getOperator)." }, { "name": "export_mode", "value": "", "type": "query", "description": "Specify how to obtain the URL to download the Air Data Usage Report CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL. If the file size of the Air Data Usage Report CSV is huge, specify `async`.\n- `sync` (default): Wait for the URL to be issued on the Soracom platform. However, if the file size of the Air Data Usage Report CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Download the Air Data Traffic Actual Data CSV file that contains the usage report of all the IoT SIMs for the specified operator.\n\n**Warning**: If there is no data usage during the specified period, a CSV file with only a header row will be output.\n**Info**: You can also check the data usage of terminated IoT SIMs.\n" }, { "info": { "name": "Get Air Usage Report of SIM.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/stats/air/sims/:sim_id", "params": [ { "name": "sim_id", "value": "", "type": "path", "description": "SIM ID of the target SIM. The SIM ID can be obtained from the [Sim:listSims API](#!/Sim/listSims)." }, { "name": "from", "value": "", "type": "query", "description": "Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "to", "value": "", "type": "query", "description": "Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "period", "value": "", "type": "query", "description": "Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the usage report for the SIM specified by the SIM ID.\n\n**Warning**: The data traffic of the terminated IoT SIM cannot be confirmed.\n" }, { "info": { "name": "Get Air Usage Report of Subscriber.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/stats/air/subscribers/:imsi", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "The target IMSI. The IMSI can be obtained from the [Sim:listSims API](#!/Sim/listSims)." }, { "name": "from", "value": "", "type": "query", "description": "Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "to", "value": "", "type": "query", "description": "Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "period", "value": "", "type": "query", "description": "Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the usage report for the subscriber specified by the IMSI.\n\n**Warning**: The data traffic of the terminated IoT SIM cannot be confirmed.\n" }, { "info": { "name": "Export Beam Usage Report of All Subscribers", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/stats/beam/operators/:operator_id/export", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "export_mode", "value": "", "type": "query", "description": "export_mode (async, sync)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a file containing the Soracom Beam usage report of all subscribers for the specified operator. The report data range is specified with from, to in unixtime. The report contains monthly data. The file output destination is AWS S3. The file output format is CSV." }, { "info": { "name": "Get Beam Usage Report of Subscriber", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/stats/beam/subscribers/:imsi", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "imsi" }, { "name": "from", "value": "", "type": "query", "description": "Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "to", "value": "", "type": "query", "description": "Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "period", "value": "", "type": "query", "description": "Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the Soracom Beam usage report for the subscriber specified by the IMSI." }, { "info": { "name": "Export Funk Usage Report of All Subscribers", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/stats/funk/operators/:operator_id/export", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "export_mode", "value": "", "type": "query", "description": "export_mode (async, sync)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a file containing the Soracom Funk usage report of all subscribers for the specified operator. The report data range is specified with from, to in unixtime. The report contains monthly data. The file output destination is AWS S3. The file output format is CSV." }, { "info": { "name": "Get Funk Usage Report of Subscriber", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/stats/funk/subscribers/:imsi", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "imsi" }, { "name": "from", "value": "", "type": "query", "description": "Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "to", "value": "", "type": "query", "description": "Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "period", "value": "", "type": "query", "description": "Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the Soracom Funk usage report for the subscriber specified by the IMSI." }, { "info": { "name": "Export Funnel Usage Report of All Subscribers", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/stats/funnel/operators/:operator_id/export", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "export_mode", "value": "", "type": "query", "description": "export_mode (async, sync)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves a file containing the Soracom Funnel usage report of all subscribers for the specified operator. The report data range is specified with from, to in unixtime. The report contains monthly data. The file output destination is AWS S3. The file output format is CSV." }, { "info": { "name": "Get Funnel Usage Report of Subscriber", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/stats/funnel/subscribers/:imsi", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "imsi" }, { "name": "from", "value": "", "type": "query", "description": "Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "to", "value": "", "type": "query", "description": "Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "period", "value": "", "type": "query", "description": "Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the Soracom Funnel usage report for the subscriber specified by the IMSI." }, { "info": { "name": "Get 'Harvest usage report' for the specified operator.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/stats/harvest/operators/:operator_id", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID" }, { "name": "year_month", "value": "", "type": "query", "description": "Specify the year and month from 18 months before the current time to the current time in the YYYYMM format." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the Soracom Harvest usage report for the operator." }, { "info": { "name": "Export Harvest Data Write Counts Report of all IoT SIMs", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/stats/harvest/operators/:operator_id/export", "params": [ { "name": "operator_id", "value": "", "type": "path", "description": "Operator ID." }, { "name": "export_mode", "value": "", "type": "query", "description": "Specify how to obtain the URL to download the Harvest Data Write Count Results Data CSV.\n\n- `async`: Get the `exportedFieldId` without waiting for the URL to be issued on the Soracom platform. Specify this `exportedFieldId` in [Files:getExportedFile API](#!/Files/getExportedFile) to get the URL for downloading. If the file size of the Harvest Data Write Count Results Data CSV is huge, specify `async`.\n- `sync` (default): Wait for the URL for downloading to be issued on the Soracom platform. However, if the file size of the Harvest Data Write Count Results Data CSV is huge, it may time out and the URL cannot be retrieved. If the timeout occurs, specify `async`.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Download the Harvest Data Write Count Results Data CSV file that contains the usage report of all the IoT SIMs for the specified operator.\n\n**Info**: You can also check the Harvest Data write counts of the terminated IoT SIM.\n" }, { "info": { "name": "Get Harvest Usage Report of Subscriber", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/stats/harvest/subscribers/:imsi", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "imsi" }, { "name": "from", "value": "", "type": "query", "description": "Specify the start month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "to", "value": "", "type": "query", "description": "Specify the end month/day/minute of the period to be aggregated in UNIX time in seconds." }, { "name": "period", "value": "", "type": "query", "description": "Unit of aggregation.\n\n- `month`: Aggregate by month.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 on the first day of the month, including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the last day of the month containing the specified UNIX time (in seconds). |\n- `day`: Aggregate by day.\n\n The `from` and `to` should be UNIX time (in seconds) from 18 months before the current time to the current time. The actual period of interest is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual start time | 00:00:00 of the day including the specified UNIX time (in seconds). |\n | Actual end time | 24:00:00 of the day including the specified UNIX time (in seconds). |\n- `minutes`: Aggregate by approximately every 5 minutes.\n\n The `from` and `to` must be between 32 days before the current time and the UNIX time (in seconds) of the current time. The actual period to be aggregated is not the time specified by `from` and `to`.\n\n | Item | Description |\n |-|-|\n | Actual Start Time | Start time of approximately 5 minutes including the specified UNIX time (seconds). |\n | Actual End Time | End time of approximately 5 minutes including the specified UNIX time (seconds). |\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the Soracom Harvest usage report for the subscriber specified by the IMSI." }, { "info": { "name": "Get Napter audit logs' monthly exported data stats.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/stats/napter/audit_logs", "params": [ { "name": "year_month", "value": "", "type": "query", "description": "Specify the year and month from 18 months before the current time to the current time in the YYYYMM format." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get Napter audit logs' monthly exported data stats." } ] }, { "info": { "name": "Subscriber", "type": "folder" }, "items": [ { "info": { "name": "List Subscribers.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/subscribers", "params": [ { "name": "tag_name", "value": "", "type": "query", "description": "Tag name for filtering the search (exact match)." }, { "name": "tag_value", "value": "", "type": "query", "description": "Tag search string for filtering the search. Required when `tag_name` has been specified." }, { "name": "tag_value_match_mode", "value": "", "type": "query", "description": "Tag match mode." }, { "name": "status_filter", "value": "", "type": "query", "description": "Status for filtering the search. Can specify multiple values delimited by `|`. Valid values include: `active`, `inactive`, `ready`, `instock`, `shipped`, `suspended`, and `terminated`." }, { "name": "speed_class_filter", "value": "", "type": "query", "description": "Speed class for filtering the search. Can specify multiple values delimited by `|`. Valid values include:\n\n- `s1.minimum`\n- `s1.slow`\n- `s1.standard`\n- `s1.fast`\n- `s1.4xfast`\n- `s1.8xfast`\n- `u1.standard`\n- `u1.slow`\n- `t1.standard`\n- `arc.standard`\n" }, { "name": "serial_number_filter", "value": "", "type": "query", "description": "Serial number for filtering the search. Can specify multiple values delimited by `|`. Returns subscribers with serial number starting with the specified value(s)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of subscribers to retrieve (value range is 1 to 100). However, the number of subscribers returned may be less than the specified value." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of subscribers that match certain criteria. If the total number of subscribers does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Get Subscriber.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/subscribers/:imsi", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns information about the specified subscriber." }, { "info": { "name": "Activate Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/activate", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Activates status of specified subscriber." }, { "info": { "name": "Set Bundles to Subscriber.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/subscribers/:imsi/bundles", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber. The IMSI can be obtained from the [Sim:listSims API](#!/Sim/listSims)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sets bundles to the specified subscriber." }, { "info": { "name": "Get data sent from a subscriber to Harvest Data.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/subscribers/:imsi/data", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber that generated data entries." }, { "name": "from", "value": "", "type": "query", "description": "Start time for the data entries search range (UNIX time in milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "End time for the data entries search range (UNIX time in milliseconds)." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "Key in the last data entry retrieved in the previous page. The key for data entries in this API is `${UNIX time in milliseconds}_${IMSI}`. By specifying this parameter, you can continue to retrieve the list from the next page onward.\n" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of data entries sent to Harvest Data from a subscriber that match certain criteria. If the total number of data entries does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Deactivate Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/deactivate", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deactivates specified subscriber." }, { "info": { "name": "Delete Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/delete_session", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes session for the specified subscriber." }, { "info": { "name": "Disable Termination of Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/disable_termination", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Disables termination of specified subscriber." }, { "info": { "name": "Send ping requests to a subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/downlink/ping", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Send ICMP ping requests to a subscriber." }, { "info": { "name": "Enable Termination of Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/enable_termination", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables termination of specified subscriber." }, { "info": { "name": "List Session Events.", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/subscribers/:imsi/events/sessions", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." }, { "name": "from", "value": "", "type": "query", "description": "Start time for the events search range (UNIX time in milliseconds)." }, { "name": "to", "value": "", "type": "query", "description": "End time for the events search range (UNIX time in milliseconds)." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of events to retrieve." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The time stamp of the last event retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next event onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns the event history of session creation/modification/disconnection on the specified subscriber in the last 32 days. If the total number of events does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n" }, { "info": { "name": "Register Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/register", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Registers a subscriber." }, { "info": { "name": "Triggers Subscriber to report SIM local info.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/report_local_info", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Triggers Subscriber to report SIM local info." }, { "info": { "name": "Send SMS to Subscriber", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/send_sms", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Send SMS to the specified subscriber." }, { "info": { "name": "Update Expiry Time of Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/set_expiry_time", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates expiry time of specified subscriber." }, { "info": { "name": "Adds a SIM to a SIM group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/set_group", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target SIM. The IMSI can be obtained using the [Sim:listSims API](#!/Sim/listSims)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds a SIM to a SIM group." }, { "info": { "name": "Set IMEI lock configuration for Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/set_imei_lock", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Set IMEI that the subscriber should be locked to." }, { "info": { "name": "Set Subscriber to standby mode.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/set_to_standby", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Set the specified subscriber to standby mode." }, { "info": { "name": "Suspend Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/suspend", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Suspends the specified subscriber." }, { "info": { "name": "Bulk Insert or Update Subscriber Tags.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/subscribers/:imsi/tags", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Inserts/updates tags for the specified subscriber." }, { "info": { "name": "Delete Subscriber Tag.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/subscribers/:imsi/tags/:tag_name", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." }, { "name": "tag_name", "value": "", "type": "path", "description": "Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a tag from the specified subscriber." }, { "info": { "name": "Terminate Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/terminate", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Terminates the specified subscriber" }, { "info": { "name": "Delete Expiry Time of Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/unset_expiry_time", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes expiry time of specified subscriber and changes it to indefinite." }, { "info": { "name": "Removes a SIM from a SIM group", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/unset_group", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target SIM. The IMSI can be obtained using the [Sim:listSims API](#!/Sim/listSims)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Removes a SIM from a SIM group." }, { "info": { "name": "Unset IMEI lock configuration for Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/unset_imei_lock", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Remove any existing IMEI lock configuration for the subscriber." }, { "info": { "name": "Update Subscriber speed class.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/:imsi/update_speed_class", "params": [ { "name": "imsi", "value": "", "type": "path", "description": "IMSI of the target subscriber." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Changes the speed class of the specified subscriber." }, { "info": { "name": "Export all subscribers.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/export", "params": [ { "name": "export_mode", "value": "", "type": "query", "description": "export mode (async, sync)" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Export all subscribers as a CSV file." }, { "info": { "name": "Send SMS to Subscriber by MSISDN", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/msisdn/:msisdn/send_sms", "params": [ { "name": "msisdn", "value": "", "type": "path", "description": "MSISDN of the target subscriber." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Send SMS to a subscriber specified with MSISDN." }, { "info": { "name": "Cancel the transfer of Ready status SIMs (Invalidate the transfer token)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/subscribers/transfer_token/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Transfer token. The transfer token can be obtained from [Subscriber:issueSubscriberTransferToken](#!/Subscriber/issueSubscriberTransferToken)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Invalidate the transfer token for SIMs and cancels the transfer of all SIMs associated with the transfer token. To use this API, you need an API key and token issued with the source operator." }, { "info": { "name": "Initiate the transfer of Ready status SIMs (Issue a transfer token)", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/transfer_token/issue", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Initiates the transfer of Ready status SIMs. To use this API, you need an API key and token issued with the source operator. When this API is executed, a transfer token is issued and sent to the destination operator via email. For more information about SIM transfers, please refer to [Transferring Ready Status SIMs](/en/docs/air/transfer/#transferring-ready-status-sims).\n\n- To cancel a transfer, cancel each transfer token individually. If there is a possibility of canceling SIMs one by one, spec" }, { "info": { "name": "Accept the transfer of Ready status SIMs (Verify the transfer token)", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/subscribers/transfer_token/verify", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Verifies the transfer token for SIMs and accepts the transfer. To use this API, you need an API key and token issued with the destination operator." } ] }, { "info": { "name": "VirtualPrivateGateway", "type": "folder" }, "items": [ { "info": { "name": "List Virtual Private Gateways", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/virtual_private_gateways", "params": [ { "name": "tag_name", "value": "", "type": "query", "description": "Tag name of the VPG. Filters through all VPGs that exactly match the tag name. When tag_name is specified, tag_value is required." }, { "name": "tag_value", "value": "", "type": "query", "description": "Tag value of the VPG." }, { "name": "tag_value_match_mode", "value": "", "type": "query", "description": "Tag match mode." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results per response page." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The last VPG ID retrieved on the current page. By specifying this parameter, you can continue to retrieve the list from the next VPG onward." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Returns a list of VPGs." }, { "info": { "name": "Create Virtual Private Gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Create a new VPG." }, { "info": { "name": "Get Virtual Private Gateway", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves information about the specified VPG." }, { "info": { "name": "Create routing table entry", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/customer_routes", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a routing table entry for the specified VPG." }, { "info": { "name": "Update routing table entry", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/customer_routes/:route_id", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." }, { "name": "route_id", "value": "", "type": "path", "description": "Target route ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates a routing table entry for the specified VPG." }, { "info": { "name": "Delete routing table entry", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/customer_routes/:route_id", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." }, { "name": "route_id", "value": "", "type": "path", "description": "Target route ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a routing table entry from the specified VPG." }, { "info": { "name": "Enable the fixed global IP address option for the VPG", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses", "params": [ { "name": "vpg_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables the fixed global IP address option for the VPG." }, { "info": { "name": "Disable the fixed global IP address option for the VPG", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses", "params": [ { "name": "vpg_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Disables the fixed global IP address option for the VPG." }, { "info": { "name": "Close SORACOM Gate.", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/close", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Close Soracom Gate on the specified VPG." }, { "info": { "name": "Disables Soracom Gate's privacy separator feature on the specified VPG", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/disable_privacy_separator", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Disables Soracom Gate's privacy separator feature on the specified VPG and enables the Gate D2D feature." }, { "info": { "name": "Enables Soracom Gate privacy separator feature on the specified VPG", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/enable_privacy_separator", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables Soracom Gate's privacy separator feature on the specified VPG and disables the Gate D2D feature." }, { "info": { "name": "Open Soracom Gate", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/open", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Open Soracom Gate on the specified VPG." }, { "info": { "name": "List VPG Gate Peers", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/peers", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "List Gate Peers registered in the Virtual Private Gateway." }, { "info": { "name": "Register VPG Gate Peer", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/peers", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Register a host as a Gate Peer in the Virtual Private Gateway." }, { "info": { "name": "Unregister VPG Gate Peer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/peers/:outer_ip_address", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." }, { "name": "outer_ip_address", "value": "", "type": "path", "description": "ID of the target node." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Unregister a Gate Peer from the Virtual Private Gateway." }, { "info": { "name": "Disable SIM-Based Routing", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/routing/static/sims/disable", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Disables SIM-Based Routing." }, { "info": { "name": "Enable SIM-Based Routing", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/routing/static/sims/enable", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Enables SIM-Based Routing." }, { "info": { "name": "Associate a router's LAN IP address range with its SIM ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/routing/static/sims/routes", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Associates a router's LAN IP address range with its SIM ID." }, { "info": { "name": "Set VXLAN ID for Gate", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/set_vxlan_id", "params": [ { "name": "vpg_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Set VXLAN ID for Gate." }, { "info": { "name": "List VPG IP address map entries", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/ip_address_map", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of IP address map entries to retrieve. The response may contain fewer entries than the specified value." }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "The last IP address retrieved in the previous page. Use this parameter to retrieve the next page of IP address map entries." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Retrieves the list of IP address map entries for the specified VPG.\n" }, { "info": { "name": "Adds or updates an entry in VPG IP address map", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/ip_address_map", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds or updates an IP address map entry for the specified VPG.\n\n**Warning**: The [VirtualPrivateGateway:listVirtualPrivateGatewayIpAddressMapEntries API](#/VirtualPrivateGateway/listVirtualPrivateGatewayIpAddressMapEntries) response includes entries that are automatically assigned to Gate Peers and the VPG, but these cannot be added or updated using the VirtualPrivateGateway:putVirtualPrivateGatewayIpAddressMapEntry API.\n" }, { "info": { "name": "Delete VPG IP address map entry", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/ip_address_map/:key", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." }, { "name": "key", "value": "", "type": "path", "description": "Identifier of the IP address map entry to delete (IMSI of the IoT SIM)." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes an entry from the IP address map of the specified VPG.\n\n**Warning**: The [VirtualPrivateGateway:listVirtualPrivateGatewayIpAddressMapEntries API](#/VirtualPrivateGateway/listVirtualPrivateGatewayIpAddressMapEntries) response includes automatically assigned entries for Gate Peers and the VPG. These entries cannot be deleted using the VirtualPrivateGateway:deleteVirtualPrivateGatewayIpAddressMapEntry API.\n" }, { "info": { "name": "Adds node in the list of Junction mirroring peers", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/mirroring/peers", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds node in the list of Junction mirroring peers." }, { "info": { "name": "Updates a Junction mirroring peer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/mirroring/peers/:ipaddr", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" }, { "name": "ipaddr", "value": "", "type": "path", "description": "Mirroring peer IP address" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Updates a Junction mirroring peer." }, { "info": { "name": "Remove peer from the list of Junction mirroring peers", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/mirroring/peers/:ipaddr", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" }, { "name": "ipaddr", "value": "", "type": "path", "description": "IP address of mirroring peer" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Remove peer from the list of Junction mirroring peers." }, { "info": { "name": "Sets configuration for Junction inspection feature", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/set_inspection", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sets configuration for Junction inspection feature." }, { "info": { "name": "Sets configuration for Junction redirection feature", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/set_redirection", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sets configuration for Junction redirection feature." }, { "info": { "name": "Unset configuration for Junction inspection feature", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/unset_inspection", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Unset configuration for Junction inspection feature." }, { "info": { "name": "Unset configuration for Junction redirection feature", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/unset_redirection", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Unset configuration for Junction redirection feature." }, { "info": { "name": "List Packet Capture Sessions associated with the VPG", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/packet_capture_sessions", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" }, { "name": "last_evaluated_key", "value": "", "type": "query", "description": "ID of the last packet capture session in the previous page. By specifying this parameter, you can continue to retrieve the list from the next packet capture session onward." }, { "name": "limit", "value": "", "type": "query", "description": "Max number of results in a response." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "List packet capture sessions associated with the VPG." }, { "info": { "name": "Create a packet capture session associated with the VPG", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/packet_capture_sessions", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Create a packet capture session associated with the VPG." }, { "info": { "name": "Get a packet capture session associated with the VPG", "type": "http" }, "http": { "method": "GET", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" }, { "name": "session_id", "value": "", "type": "path", "description": "Packet capture session ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Get a packet capture session associated with the VPG." }, { "info": { "name": "Delete a packet capture session associated with the VPG", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" }, { "name": "session_id", "value": "", "type": "path", "description": "Packet capture session ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Delete a packet capture session associated with the VPG." }, { "info": { "name": "Stop a packet capture session associated with the VPG", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id/stop", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "VPG ID" }, { "name": "session_id", "value": "", "type": "path", "description": "Packet capture session ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Stop a packet capture session associated with the VPG." }, { "info": { "name": "Sets Virtual Private Gateway outbound routing filter", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/set_routing_filter", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Sets Virtual Private Gateway outbound routing filter." }, { "info": { "name": "Update VPG tags", "type": "http" }, "http": { "method": "PUT", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/tags", "params": [ { "name": "vpg_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Adds/updates tags of the specified VPG." }, { "info": { "name": "Delete a VPG Tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/tags/:tag_name", "params": [ { "name": "vpg_id", "value": "", "type": "path" }, { "name": "tag_name", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a tag from the specified VPG." }, { "info": { "name": "Terminate Virtual Private Gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/terminate", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Terminates the specified VPG." }, { "info": { "name": "Create transit gateway peering connection", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a transit gateway peering connection for the specified VPG." }, { "info": { "name": "Delete transit gateway peering connection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections/:soracom_tgw_peering_attachment_id", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." }, { "name": "soracom_tgw_peering_attachment_id", "value": "", "type": "path", "description": "Transit gateway peering connection ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a transit gateway peering connection from the specified VPG." }, { "info": { "name": "Create transit gateway VPC attachment", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a transit gateway VPC attachment for the specified VPG." }, { "info": { "name": "Delete transit gateway VPC attachment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." }, { "name": "customer_tgw_vpc_attachment_id", "value": "", "type": "path", "description": "Transit gateway VPC attachment ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes a transit gateway VPC attachment from the specified VPG." }, { "info": { "name": "Accept transit gateway VPC attachment connection request", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id/accept", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." }, { "name": "customer_tgw_vpc_attachment_id", "value": "", "type": "path", "description": "Transit gateway VPC attachment ID" } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Accepts the specified transit gateway VPC attachment connection request." }, { "info": { "name": "Create VPC Peering Connection", "type": "http" }, "http": { "method": "POST", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/vpc_peering_connections", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Creates a VPC peering connection for the specified VPG." }, { "info": { "name": "Delete VPC Peering Connection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/vpc_peering_connections/:pcx_id", "params": [ { "name": "vpg_id", "value": "", "type": "path", "description": "Target VPG ID." }, { "name": "pcx_id", "value": "", "type": "path", "description": "VPC peering connection ID to be deleted." } ], "auth": { "type": "apikey", "key": "X-Soracom-API-Key", "value": "{{X-Soracom-API-Key}}", "placement": "header" } }, "docs": "Deletes the specified VPC peering connection." } ] } ], "bundled": true }