{ "opencollection": "1.0.0", "info": { "name": "Soracom and Query Analysis Sim API", "version": "20250903-043502" }, "items": [ { "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." } ] } ], "bundled": true }