# README
Go API client for api
SORACOM API v1
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: VERSION_PLACEHOLDER
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import api "github.com/ks6088ts/soracom-sdk-go"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Configuration of Server URL
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
Select Server Configuration
For using other server than the one defined on index 0 set context value sw.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), api.ContextServerIndex, 1)
Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), api.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
.
An operation is uniquely identified by "{classname}Service.{nickname}"
string.
Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices
and sw.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), api.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), api.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
Documentation for API Endpoints
All URIs are relative to https://api.soracom.io/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AuditLogApi | GetApiAuditLogs | Get /audit_logs/api | SORACOM API 呼び出しの監査ログを取得する |
AuditLogApi | GetNapterAuditLogs | Get /audit_logs/napter | SORACOM Napter の監査ログを取得する |
AuthApi | Auth | Post /auth | API アクセスの認証を行い、API キーと API トークンを発行します。 |
AuthApi | IssuePasswordResetToken | Post /auth/password_reset_token/issue | パスワードリセット用のトークンを発行します。 |
AuthApi | Logout | Post /auth/logout | SORACOM API にアクセスするための API キーと API トークンを無効化します。 |
AuthApi | VerifyPasswordResetToken | Post /auth/password_reset_token/verify | パスワードリセット用のトークンを検証し、パスワードを更新します。 |
BillingApi | ExportBilling | Post /bills/{yyyyMM}/export | 指定月の課金詳細情報 CSV をダウンロードするための URL を発行する |
BillingApi | ExportLatestBilling | Post /bills/latest/export | Export latest billing CSV file to S3 |
BillingApi | GetBilling | Get /bills/{yyyyMM} | 指定した月の確定した利用料金を取得する |
BillingApi | GetBillingHistory | Get /bills | 過去の確定した利用料金を取得する |
BillingApi | GetBillingPerDay | Get /bills/{yyyyMM}/daily | 日ごとの利用料金を取得する |
BillingApi | GetLatestBilling | Get /bills/latest | Get latest bill |
CellLocationApi | BatchGetCellLocations | Post /cell_locations | 複数の基地局の位置情報を一度に取得します。 |
CellLocationApi | GetCellLocation | Get /cell_locations | 基地局の位置情報を取得します。 |
CredentialApi | CreateCredential | Post /credentials/{credentials_id} | 認証情報の作成 |
CredentialApi | DeleteCredential | Delete /credentials/{credentials_id} | 認証情報の削除 |
CredentialApi | ListCredentials | Get /credentials | 認証情報の表示 |
CredentialApi | UpdateCredential | Put /credentials/{credentials_id} | 認証情報の更新 |
DataEntryApi | DeleteDataEntry | Delete /data/{resource_type}/{resource_id}/{time} | Deletes a data entry |
DataEntryApi | GetDataEntries | Get /data/{resource_type}/{resource_id} | Get data sent from a resource |
DataEntryApi | GetDataEntry | Get /data/{resource_type}/{resource_id}/{time} | Gets a data entry |
DataEntryApi | ListDataSourceResources | Get /data/resources | Get the list of data source resources |
DeviceApi | CreateDevice | Post /devices | 新しいデバイスを作成します。 |
DeviceApi | DeleteDevice | Delete /devices/{device_id} | デバイスを削除します。 |
DeviceApi | DeleteDeviceTag | Delete /devices/{device_id}/tags/{tag_name} | デバイスのタグを削除します。 |
DeviceApi | ExecuteDeviceResource | Post /devices/{device_id}/{object}/{instance}/{resource}/execute | デバイスの Resource を Execute します。 |
DeviceApi | GetDataFromDevice | Get /devices/{device_id}/data | デバイスから送信されたデータを取得します。 |
DeviceApi | GetDevice | Get /devices/{device_id} | 指定されたデバイス ID のデバイスを取得します。 |
DeviceApi | ListDevices | Get /devices | デバイスのリストを取得します。 |
DeviceApi | ObserveDeviceResource | Post /devices/{device_id}/{object}/{instance}/{resource}/observe | 指定されたデバイスの Resource の Observe を開始します。 |
DeviceApi | ObserveDeviceResources | Post /devices/{device_id}/{object}/{instance}/observe | 指定されたデバイスの Object Instance 下の Resource 全体の Observe を開始します。 |
DeviceApi | PutDeviceTags | Put /devices/{device_id}/tags | デバイスのタグを更新します。 |
DeviceApi | ReadDeviceResource | Get /devices/{device_id}/{object}/{instance}/{resource} | 指定されたデバイスの Resource を Read します。 |
DeviceApi | ReadDeviceResources | Get /devices/{device_id}/{object}/{instance} | デバイスの Instance 以下のすべての Resource を Read します。 |
DeviceApi | SetDeviceGroup | Post /devices/{device_id}/set_group | デバイスをグループに参加させます。 |
DeviceApi | UnobserveDeviceResource | Post /devices/{device_id}/{object}/{instance}/{resource}/unobserve | デバイスの Resource の Observe を停止します。 |
DeviceApi | UnobserveDeviceResources | Post /devices/{device_id}/{object}/{instance}/unobserve | 指定されたデバイスの Object Instance への Observe を停止します。 |
DeviceApi | UnsetDeviceGroup | Post /devices/{device_id}/unset_group | デバイスをグループから外します。 |
DeviceApi | WriteDeviceResource | Put /devices/{device_id}/{object}/{instance}/{resource} | デバイスの Resource に値を Write します。 |
DeviceObjectModelApi | CreateDeviceObjectModel | Post /device_object_models | 新しいデバイスオブジェクトモデルを作成します。 |
DeviceObjectModelApi | DeleteDeviceObjectModel | Delete /device_object_models/{model_id} | 対象のデバイスオブジェクトモデルを削除します。 |
DeviceObjectModelApi | GetDeviceObjectModel | Get /device_object_models/{model_id} | デバイスオブジェクトモデルを取得します。 |
DeviceObjectModelApi | ListDeviceObjectModels | Get /device_object_models | デバイスオブジェクトモデルのリストを返します。 |
DeviceObjectModelApi | SetDeviceObjectModelScope | Post /device_object_models/{model_id}/set_scope | 対象のデバイスオブジェクトモデルが適用される Scope をセットします。 |
DeviceObjectModelApi | UpdateDeviceObjectModel | Post /device_object_models/{model_id} | デバイスオブジェクトモデルを更新します。 |
DiagnosticApi | GetDiagnostic | Get /diagnostics/{diagnostic_id} | 診断結果を取得します。 |
DiagnosticApi | SendDiagnosticRequest | Post /diagnostics | 診断リクエストを送信します。 |
EmailApi | DeleteEmail | Delete /operators/{operator_id}/emails/{email_id} | Delete email address |
EmailApi | GetEmail | Get /operators/{operator_id}/emails/{email_id} | Get email address |
EmailApi | IssueAddEmailToken | Post /operators/add_email_token/issue | Issue a token to add an email address |
EmailApi | ListEmails | Get /operators/{operator_id}/emails | List email addresses |
EmailApi | VerifyAddEmailToken | Post /operators/add_email_token/verify | Verify a token to add an email address |
EventHandlerApi | CreateEventHandler | Post /event_handlers | Create Event Handler |
EventHandlerApi | DeleteEventHandler | Delete /event_handlers/{handler_id} | Delete Event Handler |
EventHandlerApi | DeleteIgnoreEventHandler | Delete /event_handlers/{handler_id}/subscribers/{imsi}/ignore | Delete Ignore Event Handler |
EventHandlerApi | GetEventHandler | Get /event_handlers/{handler_id} | Get Event Handler |
EventHandlerApi | ListEventHandlers | Get /event_handlers | List Event Handlers |
EventHandlerApi | ListEventHandlersBySubscriber | Get /event_handlers/subscribers/{imsi} | List Event Handlers related to Subscriber |
EventHandlerApi | SetIgnoreEventHandler | Post /event_handlers/{handler_id}/subscribers/{imsi}/ignore | Ignore Event Handler |
EventHandlerApi | UpdateEventHandler | Put /event_handlers/{handler_id} | Update Event Handler |
FileEntryApi | DeleteDirectory | Delete /files/{scope}/{path}/ | scope と path で指定されたディレクトリを削除します。 |
FileEntryApi | DeleteFile | Delete /files/{scope}/{path} | scope と path で指定されたファイルを削除します。 |
FileEntryApi | FindFiles | Get /files | scope と prefix にマッチするファイルを探します。 |
FileEntryApi | GetFile | Get /files/{scope}/{path} | scope と path で指定されたファイルをダウンロードします。 |
FileEntryApi | GetFileMetadata | Head /files/{scope}/{path} | scope と path で指定されたファイルのメタデータを取得します。 |
FileEntryApi | ListFiles | Get /files/{scope}/{path}/ | scope と path で指定されたファイルやディレクトリの一覧を取得します。 |
FileEntryApi | PutFile | Put /files/{scope}/{path} | 指定された scope 内の path にファイルをアップロードします。 |
FilesApi | GetExportedFile | Get /files/exported/{exported_file_id} | 非同期でファイルをエクスポートした場合の処理の進捗を取得する |
GadgetApi | DeleteGadgetTag | Delete /gadgets/{product_id}/{serial_number}/tags/{tag_name} | Delete Gadget Tag |
GadgetApi | DisableTerminationOnGadget | Post /gadgets/{product_id}/{serial_number}/disable_termination | Disable Termination of Gadget |
GadgetApi | EnableTerminationOnGadget | Post /gadgets/{product_id}/{serial_number}/enable_termination | Enable Termination of Gadget |
GadgetApi | GetGadget | Get /gadgets/{product_id}/{serial_number} | Get Gadget |
GadgetApi | ListGadgets | Get /gadgets | List Gadgets |
GadgetApi | PutGadgetTags | Put /gadgets/{product_id}/{serial_number}/tags | Bulk Insert or Update Gadget Tags |
GadgetApi | RegisterGadget | Post /gadgets/{product_id}/{serial_number}/register | Register a Gadget. |
GadgetApi | SetGadgetGroup | Post /gadgets/{product_id}/{serial_number}/set_group | Set Group to Gadget |
GadgetApi | TerminateGadget | Post /gadgets/{product_id}/{serial_number}/terminate | Terminate Gadget |
GadgetApi | UnsetGadgetGroup | Post /gadgets/{product_id}/{serial_number}/unset_group | Unset Group to Gadget |
GroupApi | CreateGroup | Post /groups | Create Group |
GroupApi | DeleteConfigurationNamespace | Delete /groups/{group_id}/configuration/{namespace} | Delete Group Configuration Namespace |
GroupApi | DeleteConfigurationParameter | Delete /groups/{group_id}/configuration/{namespace}/{name} | Delete Group Configuration Parameters |
GroupApi | DeleteGroup | Delete /groups/{group_id} | Delete Group |
GroupApi | DeleteGroupTag | Delete /groups/{group_id}/tags/{tag_name} | Delete Group Tag |
GroupApi | GetGroup | Get /groups/{group_id} | Get Group |
GroupApi | ListGroups | Get /groups | List Groups |
GroupApi | ListSubscribersInGroup | Get /groups/{group_id}/subscribers | List Subscribers in a group |
GroupApi | PutConfigurationParameters | Put /groups/{group_id}/configuration/{namespace} | Update Group Configuration Parameters |
GroupApi | PutGroupTags | Put /groups/{group_id}/tags | Update Group Tags |
LagoonApi | CreateLagoonUser | Post /lagoon/users | SORACOM Lagoon のユーザーを新たに作成します。 |
LagoonApi | DeleteLagoonUser | Delete /lagoon/users/{lagoon_user_id} | SORACOM Lagoon のユーザーを削除します。 |
LagoonApi | GetImageLink | Get /lagoon/image/link | SORACOM Lagoon の提供するカスタムアイコンのイメージへのリンク提供 |
LagoonApi | GetLagoonMigrationInfo | Get /lagoon/migration | (廃止されました) この API は常に `410 GONE` を返却します: SORACOM Lagoon のバージョン移行に関連する情報の取得 |
LagoonApi | InitializeLagoonDashboardPermissions | Post /lagoon/dashboards/{dashboard_id}/permissions/init | SORACOM Lagoon のダッシュボードの権限初期化 |
LagoonApi | ListLagoonDashboardsPermissions | Get /lagoon/dashboards/permissions | SORACOM Lagoon の全ダッシュボードの権限取得 |
LagoonApi | ListLagoonLicensePackStatus | Get /lagoon/license_packs | SORACOM Lagoon のライセンスパックのステータス取得 |
LagoonApi | ListLagoonUsers | Get /lagoon/users | オペレーターに属する SORACOM Lagoon のユーザー一覧を取得します。 |
LagoonApi | MigrateLagoon | Post /lagoon/migration | (廃止されました) この API は常に `410 GONE` を返却します: SORACOM Lagoon のバージョン移行の実行 |
LagoonApi | RegisterLagoon | Post /lagoon/register | SORACOM Lagoon サービスを有効にします。 |
LagoonApi | TerminateLagoon | Post /lagoon/terminate | SORACOM Lagoon サービスの使用を終了します。 |
LagoonApi | UpdateLagoonDashboardPermissions | Put /lagoon/dashboards/{dashboard_id}/permissions | SORACOM Lagoon のダッシュボード権限更新 |
LagoonApi | UpdateLagoonLicensePack | Put /lagoon/license_packs | SORACOM Lagoon の追加ライセンスパック更新・変更 |
LagoonApi | UpdateLagoonPlan | Put /lagoon/plan | SORACOM Lagoon のプラン変更 |
LagoonApi | UpdateLagoonUserEmail | Put /lagoon/users/{lagoon_user_id}/email | SORACOM Lagoon のユーザーのメールアドレスを変更します。 |
LagoonApi | UpdateLagoonUserPassword | Put /lagoon/users/{lagoon_user_id}/password | SORACOM Lagoon のユーザーのパスワードを変更します。 |
LagoonApi | UpdateLagoonUserPermission | Put /lagoon/users/{lagoon_user_id}/permission | SORACOM Lagoon のユーザーの権限を変更します。 |
LogApi | GetLogs | Get /logs | Get Logs. |
LoraDeviceApi | DeleteLoraDeviceTag | Delete /lora_devices/{device_id}/tags/{tag_name} | Delete LoRa device Tag |
LoraDeviceApi | DisableTerminationOnLoraDevice | Post /lora_devices/{device_id}/disable_termination | Disable Termination of LoRa device |
LoraDeviceApi | EnableTerminationOnLoraDevice | Post /lora_devices/{device_id}/enable_termination | Enable Termination of LoRa device |
LoraDeviceApi | GetDataFromLoraDevice | Get /lora_devices/{device_id}/data | Get data sent from a LoRa device. |
LoraDeviceApi | GetLoraDevice | Get /lora_devices/{device_id} | Get LoRa device |
LoraDeviceApi | ListLoraDevices | Get /lora_devices | List LoRa devices |
LoraDeviceApi | PutLoraDeviceTags | Put /lora_devices/{device_id}/tags | Bulk Insert or Update LoRa device Tags |
LoraDeviceApi | RegisterLoraDevice | Post /lora_devices/{device_id}/register | Register LoRa device |
LoraDeviceApi | SendDataToLoraDevice | Post /lora_devices/{device_id}/data | Send data to a LoRa device. |
LoraDeviceApi | SetLoraDeviceGroup | Post /lora_devices/{device_id}/set_group | Set Group to LoRa device |
LoraDeviceApi | TerminateLoraDevice | Post /lora_devices/{device_id}/terminate | Terminate LoRa device |
LoraDeviceApi | UnsetLoraDeviceGroup | Post /lora_devices/{device_id}/unset_group | Unset Group to LoRa device |
LoraGatewayApi | DeleteLoraGatewayTag | Delete /lora_gateways/{gateway_id}/tags/{tag_name} | Delete LoRa gateway tag. |
LoraGatewayApi | DisableTerminationOnLoraGateway | Post /lora_gateways/{gateway_id}/disable_termination | Disable Termination of LoRa gateway. |
LoraGatewayApi | EnableTerminationOnLoraGateway | Post /lora_gateways/{gateway_id}/enable_termination | Enable Termination of LoRa gateway. |
LoraGatewayApi | GetLoraGateway | Get /lora_gateways/{gateway_id} | Get LoRa gateway. |
LoraGatewayApi | ListLoraGateways | Get /lora_gateways | List LoRa gateways. |
LoraGatewayApi | PutLoraGatewayTags | Put /lora_gateways/{gateway_id}/tags | Bulk Insert or Update LoRa gateway Tags. |
LoraGatewayApi | SetLoraNetworkSet | Post /lora_gateways/{gateway_id}/set_network_set | Set Network Set ID of LoRa gateway. |
LoraGatewayApi | TerminateLoraGateway | Post /lora_gateways/{gateway_id}/terminate | Terminate LoRa gateway. |
LoraGatewayApi | UnsetLoraNetworkSet | Post /lora_gateways/{gateway_id}/unset_network_set | Unset Network Set ID of LoRa gateway. |
LoraNetworkSetApi | AddPermissionToLoraNetworkSet | Post /lora_network_sets/{ns_id}/add_permission | Adds permission to a LoRa network set. |
LoraNetworkSetApi | CreateLoraNetworkSet | Post /lora_network_sets | Creates a LoRa network set |
LoraNetworkSetApi | DeleteLoraNetworkSet | Delete /lora_network_sets/{ns_id} | Delete LoRa network set. |
LoraNetworkSetApi | DeleteLoraNetworkSetTag | Delete /lora_network_sets/{ns_id}/tags/{tag_name} | Delete LoRa network set tag. |
LoraNetworkSetApi | GetLoraNetworkSet | Get /lora_network_sets/{ns_id} | Get LoRa network set. |
LoraNetworkSetApi | ListGatewaysInLoraNetworkSet | Get /lora_network_sets/{ns_id}/gateways | List LoRa Gateways in a Network Set. |
LoraNetworkSetApi | ListLoraNetworkSets | Get /lora_network_sets | List LoRa Network Sets. |
LoraNetworkSetApi | PutLoraNetworkSetTags | Put /lora_network_sets/{ns_id}/tags | Bulk Insert or Update LoRa network set tags. |
LoraNetworkSetApi | RevokePermissionFromLoraNetworkSet | Post /lora_network_sets/{ns_id}/revoke_permission | Revokes a permission from a LoRa network set. |
OperatorApi | AddCoverageType | Post /operators/{operator_id}/coverage_type/{coverage_type} | Add coverage type |
OperatorApi | AddOperatorContract | Post /operators/{operator_id}/contracts | Add Operator Contract |
OperatorApi | CreateCompanyInformation | Post /operators/{operator_id}/company_information | Create company information |
OperatorApi | CreateIndividualInformation | Post /operators/{operator_id}/individual_information | Create individual information |
OperatorApi | CreateOperator | Post /operators | Create Operator |
OperatorApi | DeleteOperatorAuthKey | Delete /operators/{operator_id}/auth_keys/{auth_key_id} | Delete Operator AuthKey |
OperatorApi | DeleteOperatorContract | Delete /operators/{operator_id}/contracts/{contract_name} | Delete Operator Contract |
OperatorApi | EnableMFA | Post /operators/{operator_id}/mfa | Enable Operator's MFA. |
OperatorApi | GenerateAuthToken | Post /operators/{operator_id}/token | Generate Authentication Token |
OperatorApi | GenerateOperatorAuthKey | Post /operators/{operator_id}/auth_keys | Generate Operator AuthKey |
OperatorApi | GenerateSupportToken | Post /operators/{operator_id}/support/token | Generate Token for Support Console |
OperatorApi | GetCompanyInformation | Get /operators/{operator_id}/company_information | Get company information |
OperatorApi | GetIndividualInformation | Get /operators/{operator_id}/individual_information | Get individual information |
OperatorApi | GetMFAStatus | Get /operators/{operator_id}/mfa | Get Operator's MFA Status. |
OperatorApi | GetOperator | Get /operators/{operator_id} | Get Operator |
OperatorApi | IssueMFARevokingToken | Post /operators/mfa_revoke_token/issue | Issue Operator's MFA Revoke Token. |
OperatorApi | ListOperatorAuthKeys | Get /operators/{operator_id}/auth_keys | List Operator AuthKeys |
OperatorApi | RevokeMFA | Delete /operators/{operator_id}/mfa | Revoke Operator's MFA. |
OperatorApi | RevokeOperatorAuthTokens | Delete /operators/{operator_id}/tokens | ルートユーザーが発行した全ての API キーと API トークンを無効化します。 |
OperatorApi | UpdateCompanyInformation | Put /operators/{operator_id}/company_information | Update company information |
OperatorApi | UpdateIndividualInformation | Put /operators/{operator_id}/individual_information | Update individual information |
OperatorApi | UpdateOperatorPassword | Post /operators/{operator_id}/password | Update Operator Password |
OperatorApi | VerifyMFA | Post /operators/{operator_id}/mfa/verify | Verify Operator's MFA OTP Code. |
OperatorApi | VerifyMFARevokingToken | Post /operators/mfa_revoke_token/verify | Verify Operator's MFA revoke token. |
OperatorApi | VerifyOperator | Post /operators/verify | Verify Operator |
OrderApi | CancelOrder | Put /orders/{order_id}/cancel | Cancel order. |
OrderApi | ConfirmCouponOrder | Put /coupons/{order_id}/confirm | Confirm coupon order. |
OrderApi | ConfirmOrder | Put /orders/{order_id}/confirm | Confirm order. |
OrderApi | ConfirmVolumeDiscountOrder | Put /volume_discounts/{order_id}/confirm | Confirm long term discount order. |
OrderApi | CreateCouponQuotation | Post /coupons | Create coupon quotation. |
OrderApi | CreateQuotation | Post /orders | Create Quotation |
OrderApi | CreateVolumeDiscountQuotation | Post /volume_discounts | Create long term discount quotation. |
OrderApi | GetOrder | Get /orders/{order_id} | 発注確定済みの発注情報を 1 件だけ取得する |
OrderApi | ListAvailableDiscounts | Get /volume_discounts/available_discounts | List available long term discounts. |
OrderApi | ListOrderedSubscribers | Get /orders/{order_id}/subscribers | List ordered subscribers. |
OrderApi | ListOrders | Get /orders | 発注確定済みの注文履歴の一覧を取得する |
OrderApi | ListProducts | Get /products | List products |
OrderApi | RegisterOrderedSim | Post /orders/{order_id}/subscribers/register | Register subscribers for operator. |
PaymentApi | ActivatePaymentMethod | Post /payment_methods/current/activate | Activate payment method. |
PaymentApi | ExportPaymentStatement | Post /payment_statements/{payment_statement_id}/export | Export payment statement. |
PaymentApi | GetPayerInformation | Get /payment_statements/payer_information | Export payer information. |
PaymentApi | GetPaymentMethod | Get /payment_methods/current | Get payment method information. |
PaymentApi | GetPaymentTransaction | Get /payment_history/transactions/{payment_transaction_id} | Get payment transaction result. |
PaymentApi | GetVolumeDiscount | Get /volume_discounts/{contract_id} | Get long term discount. |
PaymentApi | ListCoupons | Get /coupons | List coupons. |
PaymentApi | ListPaymentStatements | Get /payment_statements | List payment statements. |
PaymentApi | ListVolumeDiscounts | Get /volume_discounts | List long term discounts. |
PaymentApi | RegisterCoupon | Post /coupons/{coupon_code}/register | Register Coupon. |
PaymentApi | RegisterPayerInformation | Post /payment_statements/payer_information | Register payer information. |
PortMappingApi | CreatePortMapping | Post /port_mappings | Create Port Mapping. |
PortMappingApi | DeletePortMapping | Delete /port_mappings/{ip_address}/{port} | Delete PortMapping. |
PortMappingApi | ListPortMappings | Get /port_mappings | List Port Mapping Entries. |
PortMappingApi | ListPortMappingsForSubscriber | Get /port_mappings/subscribers/{imsi} | Get Port Mapping entries for a subscriber. |
QueryApi | SearchDevices | Get /query/devices | SORACOM Inventory デバイスをクエリに応じて検索します。 |
QueryApi | SearchSigfoxDevices | Get /query/sigfox_devices | Sigfox デバイスをクエリに応じて検索します。 |
QueryApi | SearchSims | Get /query/sims | SIM をクエリに応じて検索します。 |
QueryApi | SearchSubscriberTrafficVolumeRanking | Get /query/subscribers/traffic_volume/ranking | Subscriber の通信量ランキングを返却します。 |
QueryApi | SearchSubscribers | Get /query/subscribers | (非推奨) Subscriber をクエリに応じて検索します。 |
ResourceSummaryApi | GetResourceSummary | Get /resource_summaries/{resource_summary_type} | resource_summary_type で指定された種別のリソースの要約を取得します。 |
RoleApi | AttachRole | Post /operators/{operator_id}/users/{user_name}/roles | Attach Role to User |
RoleApi | CreateRole | Post /operators/{operator_id}/roles/{role_id} | Create Role |
RoleApi | DeleteRole | Delete /operators/{operator_id}/roles/{role_id} | Delete Role |
RoleApi | DetachRole | Delete /operators/{operator_id}/users/{user_name}/roles/{role_id} | Detach Role from User |
RoleApi | GetRole | Get /operators/{operator_id}/roles/{role_id} | Get Role |
RoleApi | ListRoleAttachedUsers | Get /operators/{operator_id}/roles/{role_id}/users | List Role Attached Users |
RoleApi | ListRoles | Get /operators/{operator_id}/roles | List Roles |
RoleApi | ListUserRoles | Get /operators/{operator_id}/users/{user_name}/roles | List User Roles |
RoleApi | UpdateRole | Put /operators/{operator_id}/roles/{role_id} | Update Role |
ShippingAddressApi | CreateShippingAddress | Post /operators/{operator_id}/shipping_addresses | Create shipping address |
ShippingAddressApi | DeleteShippingAddress | Delete /operators/{operator_id}/shipping_addresses/{shipping_address_id} | Delete shipping address |
ShippingAddressApi | GetShippingAddress | Get /operators/{operator_id}/shipping_addresses/{shipping_address_id} | Get shipping address |
ShippingAddressApi | ListShippingAddresses | Get /operators/{operator_id}/shipping_addresses | List shipping addresses |
ShippingAddressApi | UpdateShippingAddress | Put /operators/{operator_id}/shipping_addresses/{shipping_address_id} | Update shipping address |
SigfoxDeviceApi | DeleteSigfoxDeviceTag | Delete /sigfox_devices/{device_id}/tags/{tag_name} | Delete Sigfox device Tag |
SigfoxDeviceApi | DisableTerminationOnSigfoxDevice | Post /sigfox_devices/{device_id}/disable_termination | Disable Termination of Sigfox device |
SigfoxDeviceApi | EnableTerminationOnSigfoxDevice | Post /sigfox_devices/{device_id}/enable_termination | Enable Termination of Sigfox device |
SigfoxDeviceApi | GetDataFromSigfoxDevice | Get /sigfox_devices/{device_id}/data | Get data sent from a Sigfox device. |
SigfoxDeviceApi | GetSigfoxDevice | Get /sigfox_devices/{device_id} | Get Sigfox device |
SigfoxDeviceApi | ListSigfoxDevices | Get /sigfox_devices | List Sigfox devices |
SigfoxDeviceApi | PutSigfoxDeviceTags | Put /sigfox_devices/{device_id}/tags | Bulk Insert or Update Sigfox device Tags |
SigfoxDeviceApi | RegisterSigfoxDevice | Post /sigfox_devices/{device_id}/register | Register a Sigfox device. |
SigfoxDeviceApi | SendDataToSigfoxDevice | Post /sigfox_devices/{device_id}/data | Send data to a Sigfox device. |
SigfoxDeviceApi | SetSigfoxDeviceGroup | Post /sigfox_devices/{device_id}/set_group | Set Group to Sigfox device |
SigfoxDeviceApi | TerminateSigfoxDevice | Post /sigfox_devices/{device_id}/terminate | Terminate Sigfox device |
SigfoxDeviceApi | UnsetSigfoxDeviceGroup | Post /sigfox_devices/{device_id}/unset_group | Unset Group to Sigfox device |
SimApi | ActivateSim | Post /sims/{sim_id}/activate | Activate SIM |
SimApi | AddSubscription | Post /sims/{sim_id}/profiles/{iccid}/add_subscription | 新しいセカンダリサブスクリプションを IoT SIM に追加する |
SimApi | AttachArcSimCredentials | Post /sims/{sim_id}/credentials/arc | (非推奨) Arc のクレデンシャルを SIM へ付与 |
SimApi | CancelSubscriptionContainerDownload | Post /sims/{sim_id}/profiles/{iccid}/subscribers/{imsi}/cancel_download | Cancel subscription download to subscription container |
SimApi | CreateArcSession | Post /sims/{sim_id}/sessions/arc | SORACOM Arc セッションの作成 |
SimApi | CreateSim | Post /sims | SIM の新規作成 |
SimApi | CreateSimPacketCaptureSession | Post /sims/{sim_id}/packet_capture_sessions | Create Packet Capture Session |
SimApi | DeactivateSim | Post /sims/{sim_id}/deactivate | Deactivate SIM |
SimApi | DeleteSimPacketCaptureSession | Delete /sims/{sim_id}/packet_capture_sessions/{session_id} | Delete Packet Capture Session |
SimApi | DeleteSimSession | Post /sims/{sim_id}/delete_session | Delete Session |
SimApi | DeleteSimTag | Delete /sims/{sim_id}/tags/{tag_name} | Delete SIM Tag |
SimApi | DeleteSubscriptionContainerCountryMappingEntry | Delete /sims/{sim_id}/profiles/{iccid}/subscription_containers/country_mapping/{mcc} | Delete subscription container mapping entries |
SimApi | DisableSimTermination | Post /sims/{sim_id}/disable_termination | Disable Termination of SIM |
SimApi | EnableSimTermination | Post /sims/{sim_id}/enable_termination | Enable Termination of SIM |
SimApi | EnableSubscriptionContainer | Post /sims/{sim_id}/profiles/{iccid}/subscription_containers/{container_id}/enable | Enables a subscription container. |
SimApi | GetDataFromSim | Get /sims/{sim_id}/data | Get data sent from a SIM. |
SimApi | GetSim | Get /sims/{sim_id} | Get SIM |
SimApi | GetSimPacketCaptureSession | Get /sims/{sim_id}/packet_capture_sessions/{session_id} | Get Packet Capture Session |
SimApi | ListSimPacketCaptureSessions | Get /sims/{sim_id}/packet_capture_sessions | List packet capture sessions associated with the SIM |
SimApi | ListSimSessionEvents | Get /sims/{sim_id}/events/sessions | List Session Events |
SimApi | ListSims | Get /sims | List SIMs |
SimApi | ListSubscriptionContainers | Get /sims/{sim_id}/profiles/{iccid}/subscription_containers | Get subscription container status. |
SimApi | PutSimTags | Put /sims/{sim_id}/tags | Bulk Insert or Update SIM Tags |
SimApi | PutSubscriptionContainerCountryMappingEntries | Put /sims/{sim_id}/profiles/{iccid}/subscription_containers/country_mapping | Updates subscription container country mapping entries. |
SimApi | RegisterSim | Post /sims/{sim_id}/register | Register SIM |
SimApi | RemoveArcSimCredentials | Delete /sims/{sim_id}/credentials/arc | (非推奨) Arc のクレデンシャルを SIM から除去 |
SimApi | RenewArcSimCredentials | Put /sims/{sim_id}/credentials/arc | SIM に対する Arc のクレデンシャルを更新する |
SimApi | ReportSimLocalInfo | Post /sims/{sim_id}/report_local_info | SIM ローカル情報レポートを取得する |
SimApi | SendDownlinkPing | Post /sims/{sim_id}/downlink/ping | SIM に対して ping リクエストを送信する。 |
SimApi | SendSmsToSim | Post /sims/{sim_id}/send_sms | Send SMS to SIM |
SimApi | SetSimExpiryTime | Post /sims/{sim_id}/set_expiry_time | Update Expiry Time of SIM |
SimApi | SetSimGroup | Post /sims/{sim_id}/set_group | Set Group to SIM |
SimApi | SetSimImeiLock | Post /sims/{sim_id}/set_imei_lock | Set IMEI lock configuration for SIM. |
SimApi | SetSimToStandby | Post /sims/{sim_id}/set_to_standby | Set SIM to standby mode. |
SimApi | StopSimPacketCaptureSession | Post /sims/{sim_id}/packet_capture_sessions/{session_id}/stop | Stop SIM Packet Capture Session |
SimApi | SuspendSim | Post /sims/{sim_id}/suspend | Suspend SIM |
SimApi | TerminateSim | Post /sims/{sim_id}/terminate | Terminate SIM |
SimApi | TerminateSubscriptionContainer | Post /sims/{sim_id}/profiles/{iccid}/subscribers/{imsi}/terminate | セカンダリサブスクリプションの利用終了 |
SimApi | UnsetSimExpiryTime | Post /sims/{sim_id}/unset_expiry_time | Delete Expiry Time of SIM |
SimApi | UnsetSimGroup | Post /sims/{sim_id}/unset_group | Unset Group to SIM |
SimApi | UnsetSimImeiLock | Post /sims/{sim_id}/unset_imei_lock | Unset IMEI lock configuration for SIM. |
SimApi | UpdateSimSpeedClass | Post /sims/{sim_id}/update_speed_class | Update SIM speed class |
SoraCamApi | ExportSoraCamDeviceRecordedImage | Post /sora_cam/devices/{device_id}/images/exports | クラウド常時録画で保存された録画映像から静止画をエクスポートする処理を開始する |
SoraCamApi | ExportSoraCamDeviceRecordedVideo | Post /sora_cam/devices/{device_id}/videos/exports | クラウド常時録画で保存された録画映像をエクスポートする処理を開始する |
SoraCamApi | GetSoraCamDevice | Get /sora_cam/devices/{device_id} | ソラカメ対応カメラの情報を取得する |
SoraCamApi | GetSoraCamDeviceExportUsage | Get /sora_cam/devices/{device_id}/exports/usage | ソラカメ対応カメラの静止画のエクスポート可能枚数や録画映像のエクスポート可能時間を取得する |
SoraCamApi | GetSoraCamDeviceExportedImage | Get /sora_cam/devices/{device_id}/images/exports/{export_id} | クラウド常時録画で保存された録画映像から静止画をエクスポートする処理の現在の状況を取得する |
SoraCamApi | GetSoraCamDeviceExportedVideo | Get /sora_cam/devices/{device_id}/videos/exports/{export_id} | クラウド常時録画で保存された録画映像をエクスポートする処理の現在の状況を取得する |
SoraCamApi | GetSoraCamDeviceStreamingVideo | Get /sora_cam/devices/{device_id}/stream | ストリーミング映像 (リアルタイム映像 / 録画映像) をダウンロードするための情報を取得する |
SoraCamApi | ListSoraCamDeviceImageExports | Get /sora_cam/devices/images/exports | ソラカメ対応カメラで撮影した録画映像から静止画をエクスポートする処理の現在の状況をリストで取得する |
SoraCamApi | ListSoraCamDeviceImageExportsForDevice | Get /sora_cam/devices/{device_id}/images/exports | ソラカメ対応カメラで撮影した録画映像から静止画をエクスポートする処理の現在の状況をリストで取得する |
SoraCamApi | ListSoraCamDeviceVideoExports | Get /sora_cam/devices/videos/exports | ソラカメ対応カメラで撮影した録画映像をエクスポートする処理の現在の状況をリストで取得する |
SoraCamApi | ListSoraCamDeviceVideoExportsForDevice | Get /sora_cam/devices/{device_id}/videos/exports | ソラカメ対応カメラで撮影した録画映像をエクスポートする処理の現在の状況をリストで取得する |
SoraCamApi | ListSoraCamDevices | Get /sora_cam/devices | ソラカメ対応カメラの一覧を取得する |
SoraCamApi | ListSoraCamLicensePacks | Get /sora_cam/license_packs | Soracom Cloud Camera Services のライセンスパックの一覧を取得します。 |
SoraCamApi | UpdateSoraCamLicensePackQuantity | Put /sora_cam/license_packs/{license_pack_id}/quantity | Soracom Cloud Camera Services のライセンス数を更新します。 |
SoraletApi | CreateSoralet | Post /soralets | Soralet を作成します。 |
SoraletApi | DeleteSoralet | Delete /soralets/{soralet_id} | Soralet を削除します。 |
SoraletApi | DeleteSoraletVersion | Delete /soralets/{soralet_id}/versions/{version} | Soralet のバージョンを削除します。 |
SoraletApi | GetSoralet | Get /soralets/{soralet_id} | Soralet を取得します。 |
SoraletApi | GetSoraletLogs | Get /soralets/{soralet_id}/logs | Soralet のログメッセージを取得します。 |
SoraletApi | ListSoraletVersions | Get /soralets/{soralet_id}/versions | Soralet のバージョン一覧を取得します。 |
SoraletApi | ListSoralets | Get /soralets | Soralet の一覧を取得します。 |
SoraletApi | TestSoralet | Post /soralets/{soralet_id}/test | 引数を指定して Soralet をテスト実行します。 |
SoraletApi | UploadSoraletCode | Post /soralets/{soralet_id}/versions | コードをアップロードし、新しいバージョンを作成します。 |
StatsApi | ExportAirStats | Post /stats/air/operators/{operator_id}/export | Export Air Usage Report of All Subscribers |
StatsApi | ExportBeamStats | Post /stats/beam/operators/{operator_id}/export | Export Beam Usage Report of All Subscribers |
StatsApi | ExportFunkStats | Post /stats/funk/operators/{operator_id}/export | Export Funk Usage Report of All Subscribers |
StatsApi | ExportFunnelStats | Post /stats/funnel/operators/{operator_id}/export | Export Funnel Usage Report of All Subscribers |
StatsApi | GetAirStats | Get /stats/air/subscribers/{imsi} | Get Air Usage Report of Subscriber |
StatsApi | GetAirStatsOfSim | Get /stats/air/sims/{sim_id} | Get Air Usage Report of SIM |
StatsApi | GetBeamStats | Get /stats/beam/subscribers/{imsi} | Get Beam Usage Report of Subscriber |
StatsApi | GetFunkStats | Get /stats/funk/subscribers/{imsi} | Get Funk Usage Report of Subscriber |
StatsApi | GetFunnelStats | Get /stats/funnel/subscribers/{imsi} | Get Funnel Usage Report of Subscriber |
StatsApi | GetHarvestExportedDataStats | Get /stats/harvest/operators/{operator_id} | Harvest の利用統計情報を取得します。 |
StatsApi | GetHarvestStats | Get /stats/harvest/subscribers/{imsi} | Get Harvest Usage Report of Subscriber |
StatsApi | GetNapterAuditLogsExportedDataStats | Get /stats/napter/audit_logs | Napter 監査ログの月次読み込みデータ量を取得する。 |
SubscriberApi | ActivateSubscriber | Post /subscribers/{imsi}/activate | Activate Subscriber |
SubscriberApi | DeactivateSubscriber | Post /subscribers/{imsi}/deactivate | Deactivate Subscriber |
SubscriberApi | DeleteSubscriberSession | Post /subscribers/{imsi}/delete_session | Delete Session |
SubscriberApi | DeleteSubscriberTag | Delete /subscribers/{imsi}/tags/{tag_name} | Delete Subscriber Tag |
SubscriberApi | DeleteSubscriberTransferToken | Delete /subscribers/transfer_token/{token} | Delete Subscribers Transfer Token |
SubscriberApi | DisableTermination | Post /subscribers/{imsi}/disable_termination | Disable Termination of Subscriber |
SubscriberApi | EnableTermination | Post /subscribers/{imsi}/enable_termination | Enable Termination of Subscriber |
SubscriberApi | ExportSubscribers | Post /subscribers/export | Export all subscribers. |
SubscriberApi | GetDataFromSubscriber | Get /subscribers/{imsi}/data | Get data sent from a subscriber. |
SubscriberApi | GetSubscriber | Get /subscribers/{imsi} | Get Subscriber |
SubscriberApi | IssueSubscriberTransferToken | Post /subscribers/transfer_token/issue | Issue Subscribers Transfer Token |
SubscriberApi | ListSessionEvents | Get /subscribers/{imsi}/events/sessions | List Session Events |
SubscriberApi | ListSubscribers | Get /subscribers | List Subscribers |
SubscriberApi | PutBundles | Put /subscribers/{imsi}/bundles | Set Bundles to Subscriber. |
SubscriberApi | PutSubscriberTags | Put /subscribers/{imsi}/tags | Bulk Insert or Update Subscriber Tags |
SubscriberApi | RegisterSubscriber | Post /subscribers/{imsi}/register | Register Subscriber |
SubscriberApi | ReportLocalInfo | Post /subscribers/{imsi}/report_local_info | Triggers Subscriber to report SIM local info. |
SubscriberApi | SendSms | Post /subscribers/{imsi}/send_sms | Send SMS to Subscriber |
SubscriberApi | SendSmsByMsisdn | Post /subscribers/msisdn/{msisdn}/send_sms | Send SMS to Subscriber by MSISDN |
SubscriberApi | SetExpiryTime | Post /subscribers/{imsi}/set_expiry_time | Update Expiry Time of Subscriber |
SubscriberApi | SetGroup | Post /subscribers/{imsi}/set_group | Set Group to Subscriber |
SubscriberApi | SetImeiLock | Post /subscribers/{imsi}/set_imei_lock | Set IMEI lock configuration for Subscriber. |
SubscriberApi | SetSubscriberToStandby | Post /subscribers/{imsi}/set_to_standby | Set Subscriber to standby mode. |
SubscriberApi | SubscriberDownlinkPingToUserEquipment | Post /subscribers/{imsi}/downlink/ping | Subscriber に対して ping リクエストを送信する。 |
SubscriberApi | SuspendSubscriber | Post /subscribers/{imsi}/suspend | Suspend Subscriber |
SubscriberApi | TerminateSubscriber | Post /subscribers/{imsi}/terminate | Terminate Subscriber |
SubscriberApi | UnsetExpiryTime | Post /subscribers/{imsi}/unset_expiry_time | Delete Expiry Time of Subscriber |
SubscriberApi | UnsetGroup | Post /subscribers/{imsi}/unset_group | Unset Group to Subscriber |
SubscriberApi | UnsetImeiLock | Post /subscribers/{imsi}/unset_imei_lock | Unset IMEI lock configuration for Subscriber. |
SubscriberApi | UpdateSpeedClass | Post /subscribers/{imsi}/update_speed_class | Update Subscriber speed class |
SubscriberApi | VerifySubscriberTransferToken | Post /subscribers/transfer_token/verify | Verify Subscriber Transfer Token |
SystemNotificationApi | DeleteSystemNotification | Delete /operators/{operator_id}/system_notifications/{type} | Delete system notification |
SystemNotificationApi | GetSystemNotification | Get /operators/{operator_id}/system_notifications/{type} | Get system notification |
SystemNotificationApi | ListSystemNotifications | Get /operators/{operator_id}/system_notifications | List system notifications |
SystemNotificationApi | SetSystemNotification | Post /operators/{operator_id}/system_notifications/{type} | Set system notification |
UserApi | CreateUser | Post /operators/{operator_id}/users/{user_name} | Create User |
UserApi | CreateUserPassword | Post /operators/{operator_id}/users/{user_name}/password | Create Password |
UserApi | DeleteDefaultPermissions | Delete /operators/{operator_id}/users/default_permissions | すべての SAM ユーザーに適用されるデフォルト権限を削除する |
UserApi | DeleteUser | Delete /operators/{operator_id}/users/{user_name} | Delete User |
UserApi | DeleteUserAuthKey | Delete /operators/{operator_id}/users/{user_name}/auth_keys/{auth_key_id} | Delete User AuthKey |
UserApi | DeleteUserPassword | Delete /operators/{operator_id}/users/{user_name}/password | Delete Password |
UserApi | DeleteUserPermission | Delete /operators/{operator_id}/users/{user_name}/permission | SAM ユーザーの権限を削除する |
UserApi | EnableUserMFA | Post /operators/{operator_id}/users/{user_name}/mfa | Enable SAM user's MFA |
UserApi | GenerateUserAuthKey | Post /operators/{operator_id}/users/{user_name}/auth_keys | Generate AuthKey |
UserApi | GetDefaultPermissions | Get /operators/{operator_id}/users/default_permissions | すべての SAM ユーザーに適用されるデフォルト権限を取得する |
UserApi | GetUser | Get /operators/{operator_id}/users/{user_name} | Get User |
UserApi | GetUserAuthKey | Get /operators/{operator_id}/users/{user_name}/auth_keys/{auth_key_id} | Get AuthKey |
UserApi | GetUserMFAStatus | Get /operators/{operator_id}/users/{user_name}/mfa | Get SAM user's MFA status |
UserApi | GetUserPermission | Get /operators/{operator_id}/users/{user_name}/permission | Get User Permission |
UserApi | HasUserPassword | Get /operators/{operator_id}/users/{user_name}/password | Has User Password |
UserApi | ListUserAuthKeys | Get /operators/{operator_id}/users/{user_name}/auth_keys | List User AuthKeys |
UserApi | ListUsers | Get /operators/{operator_id}/users | List Users |
UserApi | RevokeUserAuthTokens | Delete /operators/{operator_id}/users/{user_name}/tokens | 指定された SAM ユーザーが発行した全ての API キーと API トークンを無効化します。 |
UserApi | RevokeUserMFA | Delete /operators/{operator_id}/users/{user_name}/mfa | Revoke SAM user's MFA |
UserApi | UpdateDefaultPermissions | Put /operators/{operator_id}/users/default_permissions | Update the default permissions |
UserApi | UpdateUser | Put /operators/{operator_id}/users/{user_name} | Update User |
UserApi | UpdateUserPassword | Put /operators/{operator_id}/users/{user_name}/password | Update Password |
UserApi | UpdateUserPermission | Put /operators/{operator_id}/users/{user_name}/permission | SAM ユーザーの権限を更新する |
UserApi | VerifyUserMFA | Post /operators/{operator_id}/users/{user_name}/mfa/verify | Verify SAM user's MFA OTP code when MFA activation phase |
VirtualPrivateGatewayApi | CloseGate | Post /virtual_private_gateways/{vpg_id}/gate/close | Close SORACOM Gate. |
VirtualPrivateGatewayApi | CreateMirroringPeer | Post /virtual_private_gateways/{vpg_id}/junction/mirroring/peers | Junction ミラーリング peer を追加します。 |
VirtualPrivateGatewayApi | CreatePacketCaptureSession | Post /virtual_private_gateways/{vpg_id}/packet_capture_sessions | Create Packet Capture Session |
VirtualPrivateGatewayApi | CreateVirtualPrivateGateway | Post /virtual_private_gateways | Create Virtual Private Gateway |
VirtualPrivateGatewayApi | CreateVpcPeeringConnection | Post /virtual_private_gateways/{vpg_id}/vpc_peering_connections | Create VPC Peering Connection |
VirtualPrivateGatewayApi | DeleteMirroringPeer | Delete /virtual_private_gateways/{vpg_id}/junction/mirroring/peers/{ipaddr} | Junction ミラーリング peer を削除します。 |
VirtualPrivateGatewayApi | DeletePacketCaptureSession | Delete /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id} | Delete Packet Capture Session |
VirtualPrivateGatewayApi | DeleteVirtualPrivateGatewayIpAddressMapEntry | Delete /virtual_private_gateways/{vpg_id}/ip_address_map/{key} | Delete VPG IP address map entry |
VirtualPrivateGatewayApi | DeleteVpcPeeringConnection | Delete /virtual_private_gateways/{vpg_id}/vpc_peering_connections/{pcx_id} | Delete VPC Peering Connection |
VirtualPrivateGatewayApi | DisableGatePrivacySeparator | Post /virtual_private_gateways/{vpg_id}/gate/disable_privacy_separator | 指定された VPG に対して SORACOM Gate のプライバシーセパレーター機能を無効にする。 |
VirtualPrivateGatewayApi | EnableGatePrivacySeparator | Post /virtual_private_gateways/{vpg_id}/gate/enable_privacy_separator | 指定された VPG に対して SORACOM Gate のプライバシーセパレーター機能を有効にする。 |
VirtualPrivateGatewayApi | GetPacketCaptureSession | Get /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id} | Get Packet Capture Session |
VirtualPrivateGatewayApi | GetVirtualPrivateGateway | Get /virtual_private_gateways/{vpg_id} | Get Virtual Private Gateway |
VirtualPrivateGatewayApi | ListGatePeers | Get /virtual_private_gateways/{vpg_id}/gate/peers | List VPG Gate peers |
VirtualPrivateGatewayApi | ListPacketCaptureSessions | Get /virtual_private_gateways/{vpg_id}/packet_capture_sessions | List Packet Capture Sessions |
VirtualPrivateGatewayApi | ListVirtualPrivateGatewayIpAddressMapEntries | Get /virtual_private_gateways/{vpg_id}/ip_address_map | List VPG IP address map entries |
VirtualPrivateGatewayApi | ListVirtualPrivateGateways | Get /virtual_private_gateways | List Virtual Private Gateways |
VirtualPrivateGatewayApi | OpenGate | Post /virtual_private_gateways/{vpg_id}/gate/open | Open SORACOM Gate |
VirtualPrivateGatewayApi | PutVirtualPrivateGatewayIpAddressMapEntry | Post /virtual_private_gateways/{vpg_id}/ip_address_map | Put VPG IP address map entry |
VirtualPrivateGatewayApi | RegisterGatePeer | Post /virtual_private_gateways/{vpg_id}/gate/peers | Register VPG Gate Peer |
VirtualPrivateGatewayApi | SetInspectionConfiguration | Post /virtual_private_gateways/{vpg_id}/junction/set_inspection | Junction インスペクション機能の設定を行います。 |
VirtualPrivateGatewayApi | SetRedirectionConfiguration | Post /virtual_private_gateways/{vpg_id}/junction/set_redirection | Junction リダイレクション機能の設定を行います。 |
VirtualPrivateGatewayApi | SetRoutingFilter | Post /virtual_private_gateways/{vpg_id}/set_routing_filter | Sets Virtual Private Gateway outbound routing filter. |
VirtualPrivateGatewayApi | StopPacketCaptureSession | Post /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}/stop | Stop Packet Capture Session |
VirtualPrivateGatewayApi | TerminateVirtualPrivateGateway | Post /virtual_private_gateways/{vpg_id}/terminate | Terminate Virtual Private Gateway |
VirtualPrivateGatewayApi | UnregisterGatePeer | Delete /virtual_private_gateways/{vpg_id}/gate/peers/{outer_ip_address} | Unregister VPG Gate Peer |
VirtualPrivateGatewayApi | UnsetInspectionConfiguration | Post /virtual_private_gateways/{vpg_id}/junction/unset_inspection | Junction インスペクション機能の設定を解除します。 |
VirtualPrivateGatewayApi | UnsetRedirectionConfiguration | Post /virtual_private_gateways/{vpg_id}/junction/unset_redirection | Junction リダイレクション機能の設定を行います。 |
VirtualPrivateGatewayApi | UpdateMirroringPeer | Put /virtual_private_gateways/{vpg_id}/junction/mirroring/peers/{ipaddr} | Junction ミラーリング peer を更新します。 |
Documentation For Models
- APIAuditLogEntry
- APICallError
- APICallErrorMessage
- ActionConfig
- ActionConfigProperty
- AddSubscriptionRequest
- AirStatsResponse
- ArcCredentialAttachRequest
- ArcCredentialAttachResponse
- ArcCredentialRenewRequest
- ArcCredentialRenewResponse
- ArcSessionCreateResponse
- ArcSessionStatus
- AttachRoleRequest
- AttributeUpdate
- AuthKeyResponse
- AuthRequest
- AuthResponse
- AvailableLongTermDiscountModel
- AvailableLongTermDiscountResponse
- BeamStatsResponse
- Capabilities
- Cell
- CellIdentifier
- CellLocation
- CompanyInformationModel
- ContractUpdatedResponse
- ContractUpdatingRequest
- CouponResponse
- CreateAndUpdateCredentialsModel
- CreateEstimatedCouponRequest
- CreateEstimatedOrderRequest
- CreateEstimatedVolumeDiscountRequest
- CreateEventHandlerRequest
- CreateGroupRequest
- CreateOrUpdateRoleRequest
- CreatePortMappingRequest
- CreateRoleResponse
- CreateSimRequest
- CreateSoraletRequest
- CreateUserPasswordRequest
- CreateUserRequest
- CreateVirtualPrivateGatewayRequest
- CreateVpcPeeringConnectionRequest
- CredentialsModel
- CreditCard
- DailyBill
- DailyBillResponse
- DataEntry
- DataSourceResourceMetadata
- DataTrafficStats
- Device
- DeviceObjectModel
- DiagnosticRequest
- DiagnosticResponse
- DownlinkPingRequest
- DownlinkPingResponse
- EmailsModel
- EnableMFAOTPResponse
- Error
- EstimatedCouponModel
- EstimatedOrderItemModel
- EstimatedOrderModel
- EstimatedVolumeDiscountModel
- EventHandlerModel
- ExecuteDeviceResourceRequest
- ExecuteSoraletRequest
- ExecuteSoraletResponse
- ExpiryTime
- ExportRequest
- FileEntry
- FileExportResponse
- FunkStatsResponse
- FunnelAWSFirehoseDestination
- FunnelAWSIoTDestination
- FunnelAWSKinesisDestination
- FunnelAcroquestTorrentioDestination
- FunnelAppressoDataSpiderDestination
- FunnelAzureEventHubDestination
- FunnelBrainsTechImpulseDestination
- FunnelConfiguration
- FunnelConfigurationDestination
- FunnelContentType
- FunnelDestination
- FunnelEsrijArcgisOnlineDestination
- FunnelFusicMockmockDatarecorderDestination
- FunnelGooglePubSubDestination
- FunnelInfoteriaPlatioDestination
- FunnelKiiThingifDestination
- FunnelLandlogDestination
- FunnelOptimCloudiotosDestination
- FunnelSensorCorpusDestination
- FunnelStatsResponse
- FunnelTeradataIntellicloudDestination
- FunnelWingarcMotionboardDestination
- FunnelYaskawaMmcloudDestination
- Gadget
- GadgetRegistrationRequest
- GatePeer
- GenerateOperatorsAuthKeyResponse
- GenerateTokenRequest
- GenerateTokenResponse
- GenerateUserAuthKeyResponse
- GetBillingHistoryResponse
- GetDefaultPermissionsResponse
- GetExportedFileResponse
- GetLatestBill
- GetOperatorResponse
- GetOrderResponse
- GetPaymentMethodResult
- GetPaymentTransactionResult
- GetShippingAddressResponse
- GetUserPasswordResponse
- GetUserPermissionResponse
- GetVolumeDiscountResponse
- GlobalSimAppletPLMNRecord
- Group
- GroupConfigurationUpdateRequest
- HarvestExportedDataStatsResponse
- HarvestStatsResponse
- ImeiLock
- IndividualInformationModel
- Insight
- IpAddressMapEntry
- IssueAddEmailTokenRequest
- IssuePasswordResetTokenRequest
- IssueSubscriberTransferTokenRequest
- IssueSubscriberTransferTokenResponse
- JunctionInspectionConfiguration
- JunctionMirroringConfiguration
- JunctionMirroringPeer
- JunctionRedirectionConfiguration
- LagoonDashboardPermissionsResponse
- LagoonDashboardPermissionsResponsePermissionsInner
- LagoonDashboardPermissionsUpdatingRequest
- LagoonDashboardPermissionsUpdatingRequestPermissionsInner
- LagoonLicensePackStatusResponse
- LagoonLicensePacksUpdatingRequest
- LagoonLicensePacksUpdatingRequestLicensePackQuantitiesInner
- LagoonMigrationFromClassicRequest
- LagoonPlanChangingRequest
- LagoonRegistrationRequest
- LagoonRegistrationResponse
- LagoonUser
- LagoonUserCreationRequest
- LagoonUserCreationResponse
- LagoonUserEmailUpdatingRequest
- LagoonUserPasswordUpdatingRequest
- LagoonUserPermissionUpdatingRequest
- LastSeen
- ListCouponResponse
- ListOrderResponse
- ListOrderedSubscriberResponse
- ListPaymentStatementResponse
- ListProductResponse
- ListRolesResponse
- ListShippingAddressResponse
- ListVolumeDiscountResponse
- LocationRegistrationStatus
- LocationRegistrationStatusForNetwork
- LogEntry
- LoraData
- LoraDevice
- LoraGateway
- LoraNetworkSet
- MFAAuthenticationRequest
- MFAIssueRevokingTokenRequest
- MFARevokingTokenVerifyRequest
- MFAStatusOfUseResponse
- MappingEntries
- MonthlyBill
- NapterAuditLogDirection
- NapterAuditLogEntry
- NapterAuditLogsExportedDataStatsResponse
- ObjectInstance
- OpenGateRequest
- OperatorMFAVerifyingResponse
- OrderItemModel
- OrderedSubscriber
- PacketCaptureSession
- PacketCaptureSessionRequest
- PaymentAmount
- PaymentDescription
- PaymentStatementResponse
- Placement
- PortMapping
- PortMappingDestination
- PortMappingSource
- PreviousSessionStatus
- PriceByQuantity
- ProductModel
- PutIpAddressMapEntryRequest
- ReferenceUrl
- RegisterGatePeerRequest
- RegisterLoraDeviceRequest
- RegisterOperatorsRequest
- RegisterPayerInformationModel
- RegisterSimRequest
- RegisterSubscribersRequest
- ResourceInstance
- ResourceSummary
- ResourceSummaryItem
- ResourceSummaryItemDimension
- ResourceSummaryItemValue
- RoleResponse
- RoutingFilterEntry
- RuleConfig
- RuleConfigProperty
- SessionEvent
- SessionStatus
- SetDeviceGroupRequest
- SetDeviceObjectModelScopeRequest
- SetGroupRequest
- SetImeiLockRequest
- SetNetworkSetRequest
- SetSystemNotificationsRequest
- SetUserPermissionRequest
- ShippingAddressModel
- ShippingCostModel
- SigfoxData
- SigfoxDevice
- SigfoxRegistrationRequest
- Sim
- SimProfile
- SimplifiedSubscriber
- SmsForwardingReport
- SmsForwardingRequest
- SoraCamDevice
- SoraCamDeviceConfiguration
- SoraCamDeviceLicenseInfo
- SoraCamExportUsage
- SoraCamImageExportInfo
- SoraCamImageExportSpecification
- SoraCamImageExportUsage
- SoraCamLicensePackQuantityUpdatingRequest
- SoraCamLicensePackResponse
- SoraCamPlayListEntry
- SoraCamStreamingVideo
- SoraCamVideoExportInfo
- SoraCamVideoExportSpecification
- SoraCamVideoExportUsage
- SoracomBeamStats
- SoracomFunkStats
- SoracomFunnelStats
- SoracomHarvestStats
- Soralet
- SoraletDataSource
- SoraletLog
- SoraletVersion
- Subscriber
- SubscriptionContainer
- SubscriptionContainerStatus
- SubscriptionContainerStatusCountryMappingValue
- SubscriptionContainerStatusCountryMappingValueMappingRecord
- SupportTokenResponse
- SystemNotificationsModel
- TagUpdateRequest
- TrafficVolumeRanking
- UpdateDefaultPermissionsRequest
- UpdatePasswordRequest
- UpdatePermissionRequest
- UpdateSpeedClassRequest
- UpdateUserRequest
- UserDetailResponse
- VerifyAddEmailTokenRequest
- VerifyOperatorsRequest
- VerifyPasswordResetTokenRequest
- VerifySubscriberTransferTokenRequest
- VerifySubscriberTransferTokenResponse
- VirtualPrivateGateway
- VolumeDiscountModel
- VpcPeeringConnection
- WriteDeviceResourceRequest
- WriteDeviceResourceRequestValue
Documentation For Authorization
api_key
- Type: API key
- API key parameter name: X-Soracom-API-Key
- Location: HTTP header
Note, each API key must be added to a map of map[string]APIKey
where the key is: X-Soracom-API-Key and passed in as the auth context for each request.
api_token
- Type: API key
- API key parameter name: X-Soracom-Token
- Location: HTTP header
Note, each API key must be added to a map of map[string]APIKey
where the key is: X-Soracom-Token and passed in as the auth context for each request.
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime