package
0.0.3
Repository: https://github.com/ks6088ts/soracom-sdk-go.git
Documentation: pkg.go.dev

# 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

ClassMethodHTTP requestDescription
AuditLogApiGetApiAuditLogsGet /audit_logs/apiSORACOM API 呼び出しの監査ログを取得する
AuditLogApiGetNapterAuditLogsGet /audit_logs/napterSORACOM Napter の監査ログを取得する
AuthApiAuthPost /authAPI アクセスの認証を行い、API キーと API トークンを発行します。
AuthApiIssuePasswordResetTokenPost /auth/password_reset_token/issueパスワードリセット用のトークンを発行します。
AuthApiLogoutPost /auth/logoutSORACOM API にアクセスするための API キーと API トークンを無効化します。
AuthApiVerifyPasswordResetTokenPost /auth/password_reset_token/verifyパスワードリセット用のトークンを検証し、パスワードを更新します。
BillingApiExportBillingPost /bills/{yyyyMM}/export指定月の課金詳細情報 CSV をダウンロードするための URL を発行する
BillingApiExportLatestBillingPost /bills/latest/exportExport latest billing CSV file to S3
BillingApiGetBillingGet /bills/{yyyyMM}指定した月の確定した利用料金を取得する
BillingApiGetBillingHistoryGet /bills過去の確定した利用料金を取得する
BillingApiGetBillingPerDayGet /bills/{yyyyMM}/daily日ごとの利用料金を取得する
BillingApiGetLatestBillingGet /bills/latestGet latest bill
CellLocationApiBatchGetCellLocationsPost /cell_locations複数の基地局の位置情報を一度に取得します。
CellLocationApiGetCellLocationGet /cell_locations基地局の位置情報を取得します。
CredentialApiCreateCredentialPost /credentials/{credentials_id}認証情報の作成
CredentialApiDeleteCredentialDelete /credentials/{credentials_id}認証情報の削除
CredentialApiListCredentialsGet /credentials認証情報の表示
CredentialApiUpdateCredentialPut /credentials/{credentials_id}認証情報の更新
DataEntryApiDeleteDataEntryDelete /data/{resource_type}/{resource_id}/{time}Deletes a data entry
DataEntryApiGetDataEntriesGet /data/{resource_type}/{resource_id}Get data sent from a resource
DataEntryApiGetDataEntryGet /data/{resource_type}/{resource_id}/{time}Gets a data entry
DataEntryApiListDataSourceResourcesGet /data/resourcesGet the list of data source resources
DeviceApiCreateDevicePost /devices新しいデバイスを作成します。
DeviceApiDeleteDeviceDelete /devices/{device_id}デバイスを削除します。
DeviceApiDeleteDeviceTagDelete /devices/{device_id}/tags/{tag_name}デバイスのタグを削除します。
DeviceApiExecuteDeviceResourcePost /devices/{device_id}/{object}/{instance}/{resource}/executeデバイスの Resource を Execute します。
DeviceApiGetDataFromDeviceGet /devices/{device_id}/dataデバイスから送信されたデータを取得します。
DeviceApiGetDeviceGet /devices/{device_id}指定されたデバイス ID のデバイスを取得します。
DeviceApiListDevicesGet /devicesデバイスのリストを取得します。
DeviceApiObserveDeviceResourcePost /devices/{device_id}/{object}/{instance}/{resource}/observe指定されたデバイスの Resource の Observe を開始します。
DeviceApiObserveDeviceResourcesPost /devices/{device_id}/{object}/{instance}/observe指定されたデバイスの Object Instance 下の Resource 全体の Observe を開始します。
DeviceApiPutDeviceTagsPut /devices/{device_id}/tagsデバイスのタグを更新します。
DeviceApiReadDeviceResourceGet /devices/{device_id}/{object}/{instance}/{resource}指定されたデバイスの Resource を Read します。
DeviceApiReadDeviceResourcesGet /devices/{device_id}/{object}/{instance}デバイスの Instance 以下のすべての Resource を Read します。
DeviceApiSetDeviceGroupPost /devices/{device_id}/set_groupデバイスをグループに参加させます。
DeviceApiUnobserveDeviceResourcePost /devices/{device_id}/{object}/{instance}/{resource}/unobserveデバイスの Resource の Observe を停止します。
DeviceApiUnobserveDeviceResourcesPost /devices/{device_id}/{object}/{instance}/unobserve指定されたデバイスの Object Instance への Observe を停止します。
DeviceApiUnsetDeviceGroupPost /devices/{device_id}/unset_groupデバイスをグループから外します。
DeviceApiWriteDeviceResourcePut /devices/{device_id}/{object}/{instance}/{resource}デバイスの Resource に値を Write します。
DeviceObjectModelApiCreateDeviceObjectModelPost /device_object_models新しいデバイスオブジェクトモデルを作成します。
DeviceObjectModelApiDeleteDeviceObjectModelDelete /device_object_models/{model_id}対象のデバイスオブジェクトモデルを削除します。
DeviceObjectModelApiGetDeviceObjectModelGet /device_object_models/{model_id}デバイスオブジェクトモデルを取得します。
DeviceObjectModelApiListDeviceObjectModelsGet /device_object_modelsデバイスオブジェクトモデルのリストを返します。
DeviceObjectModelApiSetDeviceObjectModelScopePost /device_object_models/{model_id}/set_scope対象のデバイスオブジェクトモデルが適用される Scope をセットします。
DeviceObjectModelApiUpdateDeviceObjectModelPost /device_object_models/{model_id}デバイスオブジェクトモデルを更新します。
DiagnosticApiGetDiagnosticGet /diagnostics/{diagnostic_id}診断結果を取得します。
DiagnosticApiSendDiagnosticRequestPost /diagnostics診断リクエストを送信します。
EmailApiDeleteEmailDelete /operators/{operator_id}/emails/{email_id}Delete email address
EmailApiGetEmailGet /operators/{operator_id}/emails/{email_id}Get email address
EmailApiIssueAddEmailTokenPost /operators/add_email_token/issueIssue a token to add an email address
EmailApiListEmailsGet /operators/{operator_id}/emailsList email addresses
EmailApiVerifyAddEmailTokenPost /operators/add_email_token/verifyVerify a token to add an email address
EventHandlerApiCreateEventHandlerPost /event_handlersCreate Event Handler
EventHandlerApiDeleteEventHandlerDelete /event_handlers/{handler_id}Delete Event Handler
EventHandlerApiDeleteIgnoreEventHandlerDelete /event_handlers/{handler_id}/subscribers/{imsi}/ignoreDelete Ignore Event Handler
EventHandlerApiGetEventHandlerGet /event_handlers/{handler_id}Get Event Handler
EventHandlerApiListEventHandlersGet /event_handlersList Event Handlers
EventHandlerApiListEventHandlersBySubscriberGet /event_handlers/subscribers/{imsi}List Event Handlers related to Subscriber
EventHandlerApiSetIgnoreEventHandlerPost /event_handlers/{handler_id}/subscribers/{imsi}/ignoreIgnore Event Handler
EventHandlerApiUpdateEventHandlerPut /event_handlers/{handler_id}Update Event Handler
FileEntryApiDeleteDirectoryDelete /files/{scope}/{path}/scope と path で指定されたディレクトリを削除します。
FileEntryApiDeleteFileDelete /files/{scope}/{path}scope と path で指定されたファイルを削除します。
FileEntryApiFindFilesGet /filesscope と prefix にマッチするファイルを探します。
FileEntryApiGetFileGet /files/{scope}/{path}scope と path で指定されたファイルをダウンロードします。
FileEntryApiGetFileMetadataHead /files/{scope}/{path}scope と path で指定されたファイルのメタデータを取得します。
FileEntryApiListFilesGet /files/{scope}/{path}/scope と path で指定されたファイルやディレクトリの一覧を取得します。
FileEntryApiPutFilePut /files/{scope}/{path}指定された scope 内の path にファイルをアップロードします。
FilesApiGetExportedFileGet /files/exported/{exported_file_id}非同期でファイルをエクスポートした場合の処理の進捗を取得する
GadgetApiDeleteGadgetTagDelete /gadgets/{product_id}/{serial_number}/tags/{tag_name}Delete Gadget Tag
GadgetApiDisableTerminationOnGadgetPost /gadgets/{product_id}/{serial_number}/disable_terminationDisable Termination of Gadget
GadgetApiEnableTerminationOnGadgetPost /gadgets/{product_id}/{serial_number}/enable_terminationEnable Termination of Gadget
GadgetApiGetGadgetGet /gadgets/{product_id}/{serial_number}Get Gadget
GadgetApiListGadgetsGet /gadgetsList Gadgets
GadgetApiPutGadgetTagsPut /gadgets/{product_id}/{serial_number}/tagsBulk Insert or Update Gadget Tags
GadgetApiRegisterGadgetPost /gadgets/{product_id}/{serial_number}/registerRegister a Gadget.
GadgetApiSetGadgetGroupPost /gadgets/{product_id}/{serial_number}/set_groupSet Group to Gadget
GadgetApiTerminateGadgetPost /gadgets/{product_id}/{serial_number}/terminateTerminate Gadget
GadgetApiUnsetGadgetGroupPost /gadgets/{product_id}/{serial_number}/unset_groupUnset Group to Gadget
GroupApiCreateGroupPost /groupsCreate Group
GroupApiDeleteConfigurationNamespaceDelete /groups/{group_id}/configuration/{namespace}Delete Group Configuration Namespace
GroupApiDeleteConfigurationParameterDelete /groups/{group_id}/configuration/{namespace}/{name}Delete Group Configuration Parameters
GroupApiDeleteGroupDelete /groups/{group_id}Delete Group
GroupApiDeleteGroupTagDelete /groups/{group_id}/tags/{tag_name}Delete Group Tag
GroupApiGetGroupGet /groups/{group_id}Get Group
GroupApiListGroupsGet /groupsList Groups
GroupApiListSubscribersInGroupGet /groups/{group_id}/subscribersList Subscribers in a group
GroupApiPutConfigurationParametersPut /groups/{group_id}/configuration/{namespace}Update Group Configuration Parameters
GroupApiPutGroupTagsPut /groups/{group_id}/tagsUpdate Group Tags
LagoonApiCreateLagoonUserPost /lagoon/usersSORACOM Lagoon のユーザーを新たに作成します。
LagoonApiDeleteLagoonUserDelete /lagoon/users/{lagoon_user_id}SORACOM Lagoon のユーザーを削除します。
LagoonApiGetImageLinkGet /lagoon/image/linkSORACOM Lagoon の提供するカスタムアイコンのイメージへのリンク提供
LagoonApiGetLagoonMigrationInfoGet /lagoon/migration(廃止されました) この API は常に `410 GONE` を返却します: SORACOM Lagoon のバージョン移行に関連する情報の取得
LagoonApiInitializeLagoonDashboardPermissionsPost /lagoon/dashboards/{dashboard_id}/permissions/initSORACOM Lagoon のダッシュボードの権限初期化
LagoonApiListLagoonDashboardsPermissionsGet /lagoon/dashboards/permissionsSORACOM Lagoon の全ダッシュボードの権限取得
LagoonApiListLagoonLicensePackStatusGet /lagoon/license_packsSORACOM Lagoon のライセンスパックのステータス取得
LagoonApiListLagoonUsersGet /lagoon/usersオペレーターに属する SORACOM Lagoon のユーザー一覧を取得します。
LagoonApiMigrateLagoonPost /lagoon/migration(廃止されました) この API は常に `410 GONE` を返却します: SORACOM Lagoon のバージョン移行の実行
LagoonApiRegisterLagoonPost /lagoon/registerSORACOM Lagoon サービスを有効にします。
LagoonApiTerminateLagoonPost /lagoon/terminateSORACOM Lagoon サービスの使用を終了します。
LagoonApiUpdateLagoonDashboardPermissionsPut /lagoon/dashboards/{dashboard_id}/permissionsSORACOM Lagoon のダッシュボード権限更新
LagoonApiUpdateLagoonLicensePackPut /lagoon/license_packsSORACOM Lagoon の追加ライセンスパック更新・変更
LagoonApiUpdateLagoonPlanPut /lagoon/planSORACOM Lagoon のプラン変更
LagoonApiUpdateLagoonUserEmailPut /lagoon/users/{lagoon_user_id}/emailSORACOM Lagoon のユーザーのメールアドレスを変更します。
LagoonApiUpdateLagoonUserPasswordPut /lagoon/users/{lagoon_user_id}/passwordSORACOM Lagoon のユーザーのパスワードを変更します。
LagoonApiUpdateLagoonUserPermissionPut /lagoon/users/{lagoon_user_id}/permissionSORACOM Lagoon のユーザーの権限を変更します。
LogApiGetLogsGet /logsGet Logs.
LoraDeviceApiDeleteLoraDeviceTagDelete /lora_devices/{device_id}/tags/{tag_name}Delete LoRa device Tag
LoraDeviceApiDisableTerminationOnLoraDevicePost /lora_devices/{device_id}/disable_terminationDisable Termination of LoRa device
LoraDeviceApiEnableTerminationOnLoraDevicePost /lora_devices/{device_id}/enable_terminationEnable Termination of LoRa device
LoraDeviceApiGetDataFromLoraDeviceGet /lora_devices/{device_id}/dataGet data sent from a LoRa device.
LoraDeviceApiGetLoraDeviceGet /lora_devices/{device_id}Get LoRa device
LoraDeviceApiListLoraDevicesGet /lora_devicesList LoRa devices
LoraDeviceApiPutLoraDeviceTagsPut /lora_devices/{device_id}/tagsBulk Insert or Update LoRa device Tags
LoraDeviceApiRegisterLoraDevicePost /lora_devices/{device_id}/registerRegister LoRa device
LoraDeviceApiSendDataToLoraDevicePost /lora_devices/{device_id}/dataSend data to a LoRa device.
LoraDeviceApiSetLoraDeviceGroupPost /lora_devices/{device_id}/set_groupSet Group to LoRa device
LoraDeviceApiTerminateLoraDevicePost /lora_devices/{device_id}/terminateTerminate LoRa device
LoraDeviceApiUnsetLoraDeviceGroupPost /lora_devices/{device_id}/unset_groupUnset Group to LoRa device
LoraGatewayApiDeleteLoraGatewayTagDelete /lora_gateways/{gateway_id}/tags/{tag_name}Delete LoRa gateway tag.
LoraGatewayApiDisableTerminationOnLoraGatewayPost /lora_gateways/{gateway_id}/disable_terminationDisable Termination of LoRa gateway.
LoraGatewayApiEnableTerminationOnLoraGatewayPost /lora_gateways/{gateway_id}/enable_terminationEnable Termination of LoRa gateway.
LoraGatewayApiGetLoraGatewayGet /lora_gateways/{gateway_id}Get LoRa gateway.
LoraGatewayApiListLoraGatewaysGet /lora_gatewaysList LoRa gateways.
LoraGatewayApiPutLoraGatewayTagsPut /lora_gateways/{gateway_id}/tagsBulk Insert or Update LoRa gateway Tags.
LoraGatewayApiSetLoraNetworkSetPost /lora_gateways/{gateway_id}/set_network_setSet Network Set ID of LoRa gateway.
LoraGatewayApiTerminateLoraGatewayPost /lora_gateways/{gateway_id}/terminateTerminate LoRa gateway.
LoraGatewayApiUnsetLoraNetworkSetPost /lora_gateways/{gateway_id}/unset_network_setUnset Network Set ID of LoRa gateway.
LoraNetworkSetApiAddPermissionToLoraNetworkSetPost /lora_network_sets/{ns_id}/add_permissionAdds permission to a LoRa network set.
LoraNetworkSetApiCreateLoraNetworkSetPost /lora_network_setsCreates a LoRa network set
LoraNetworkSetApiDeleteLoraNetworkSetDelete /lora_network_sets/{ns_id}Delete LoRa network set.
LoraNetworkSetApiDeleteLoraNetworkSetTagDelete /lora_network_sets/{ns_id}/tags/{tag_name}Delete LoRa network set tag.
LoraNetworkSetApiGetLoraNetworkSetGet /lora_network_sets/{ns_id}Get LoRa network set.
LoraNetworkSetApiListGatewaysInLoraNetworkSetGet /lora_network_sets/{ns_id}/gatewaysList LoRa Gateways in a Network Set.
LoraNetworkSetApiListLoraNetworkSetsGet /lora_network_setsList LoRa Network Sets.
LoraNetworkSetApiPutLoraNetworkSetTagsPut /lora_network_sets/{ns_id}/tagsBulk Insert or Update LoRa network set tags.
LoraNetworkSetApiRevokePermissionFromLoraNetworkSetPost /lora_network_sets/{ns_id}/revoke_permissionRevokes a permission from a LoRa network set.
OperatorApiAddCoverageTypePost /operators/{operator_id}/coverage_type/{coverage_type}Add coverage type
OperatorApiAddOperatorContractPost /operators/{operator_id}/contractsAdd Operator Contract
OperatorApiCreateCompanyInformationPost /operators/{operator_id}/company_informationCreate company information
OperatorApiCreateIndividualInformationPost /operators/{operator_id}/individual_informationCreate individual information
OperatorApiCreateOperatorPost /operatorsCreate Operator
OperatorApiDeleteOperatorAuthKeyDelete /operators/{operator_id}/auth_keys/{auth_key_id}Delete Operator AuthKey
OperatorApiDeleteOperatorContractDelete /operators/{operator_id}/contracts/{contract_name}Delete Operator Contract
OperatorApiEnableMFAPost /operators/{operator_id}/mfaEnable Operator's MFA.
OperatorApiGenerateAuthTokenPost /operators/{operator_id}/tokenGenerate Authentication Token
OperatorApiGenerateOperatorAuthKeyPost /operators/{operator_id}/auth_keysGenerate Operator AuthKey
OperatorApiGenerateSupportTokenPost /operators/{operator_id}/support/tokenGenerate Token for Support Console
OperatorApiGetCompanyInformationGet /operators/{operator_id}/company_informationGet company information
OperatorApiGetIndividualInformationGet /operators/{operator_id}/individual_informationGet individual information
OperatorApiGetMFAStatusGet /operators/{operator_id}/mfaGet Operator's MFA Status.
OperatorApiGetOperatorGet /operators/{operator_id}Get Operator
OperatorApiIssueMFARevokingTokenPost /operators/mfa_revoke_token/issueIssue Operator's MFA Revoke Token.
OperatorApiListOperatorAuthKeysGet /operators/{operator_id}/auth_keysList Operator AuthKeys
OperatorApiRevokeMFADelete /operators/{operator_id}/mfaRevoke Operator's MFA.
OperatorApiRevokeOperatorAuthTokensDelete /operators/{operator_id}/tokensルートユーザーが発行した全ての API キーと API トークンを無効化します。
OperatorApiUpdateCompanyInformationPut /operators/{operator_id}/company_informationUpdate company information
OperatorApiUpdateIndividualInformationPut /operators/{operator_id}/individual_informationUpdate individual information
OperatorApiUpdateOperatorPasswordPost /operators/{operator_id}/passwordUpdate Operator Password
OperatorApiVerifyMFAPost /operators/{operator_id}/mfa/verifyVerify Operator's MFA OTP Code.
OperatorApiVerifyMFARevokingTokenPost /operators/mfa_revoke_token/verifyVerify Operator's MFA revoke token.
OperatorApiVerifyOperatorPost /operators/verifyVerify Operator
OrderApiCancelOrderPut /orders/{order_id}/cancelCancel order.
OrderApiConfirmCouponOrderPut /coupons/{order_id}/confirmConfirm coupon order.
OrderApiConfirmOrderPut /orders/{order_id}/confirmConfirm order.
OrderApiConfirmVolumeDiscountOrderPut /volume_discounts/{order_id}/confirmConfirm long term discount order.
OrderApiCreateCouponQuotationPost /couponsCreate coupon quotation.
OrderApiCreateQuotationPost /ordersCreate Quotation
OrderApiCreateVolumeDiscountQuotationPost /volume_discountsCreate long term discount quotation.
OrderApiGetOrderGet /orders/{order_id}発注確定済みの発注情報を 1 件だけ取得する
OrderApiListAvailableDiscountsGet /volume_discounts/available_discountsList available long term discounts.
OrderApiListOrderedSubscribersGet /orders/{order_id}/subscribersList ordered subscribers.
OrderApiListOrdersGet /orders発注確定済みの注文履歴の一覧を取得する
OrderApiListProductsGet /productsList products
OrderApiRegisterOrderedSimPost /orders/{order_id}/subscribers/registerRegister subscribers for operator.
PaymentApiActivatePaymentMethodPost /payment_methods/current/activateActivate payment method.
PaymentApiExportPaymentStatementPost /payment_statements/{payment_statement_id}/exportExport payment statement.
PaymentApiGetPayerInformationGet /payment_statements/payer_informationExport payer information.
PaymentApiGetPaymentMethodGet /payment_methods/currentGet payment method information.
PaymentApiGetPaymentTransactionGet /payment_history/transactions/{payment_transaction_id}Get payment transaction result.
PaymentApiGetVolumeDiscountGet /volume_discounts/{contract_id}Get long term discount.
PaymentApiListCouponsGet /couponsList coupons.
PaymentApiListPaymentStatementsGet /payment_statementsList payment statements.
PaymentApiListVolumeDiscountsGet /volume_discountsList long term discounts.
PaymentApiRegisterCouponPost /coupons/{coupon_code}/registerRegister Coupon.
PaymentApiRegisterPayerInformationPost /payment_statements/payer_informationRegister payer information.
PortMappingApiCreatePortMappingPost /port_mappingsCreate Port Mapping.
PortMappingApiDeletePortMappingDelete /port_mappings/{ip_address}/{port}Delete PortMapping.
PortMappingApiListPortMappingsGet /port_mappingsList Port Mapping Entries.
PortMappingApiListPortMappingsForSubscriberGet /port_mappings/subscribers/{imsi}Get Port Mapping entries for a subscriber.
QueryApiSearchDevicesGet /query/devicesSORACOM Inventory デバイスをクエリに応じて検索します。
QueryApiSearchSigfoxDevicesGet /query/sigfox_devicesSigfox デバイスをクエリに応じて検索します。
QueryApiSearchSimsGet /query/simsSIM をクエリに応じて検索します。
QueryApiSearchSubscriberTrafficVolumeRankingGet /query/subscribers/traffic_volume/rankingSubscriber の通信量ランキングを返却します。
QueryApiSearchSubscribersGet /query/subscribers(非推奨) Subscriber をクエリに応じて検索します。
ResourceSummaryApiGetResourceSummaryGet /resource_summaries/{resource_summary_type}resource_summary_type で指定された種別のリソースの要約を取得します。
RoleApiAttachRolePost /operators/{operator_id}/users/{user_name}/rolesAttach Role to User
RoleApiCreateRolePost /operators/{operator_id}/roles/{role_id}Create Role
RoleApiDeleteRoleDelete /operators/{operator_id}/roles/{role_id}Delete Role
RoleApiDetachRoleDelete /operators/{operator_id}/users/{user_name}/roles/{role_id}Detach Role from User
RoleApiGetRoleGet /operators/{operator_id}/roles/{role_id}Get Role
RoleApiListRoleAttachedUsersGet /operators/{operator_id}/roles/{role_id}/usersList Role Attached Users
RoleApiListRolesGet /operators/{operator_id}/rolesList Roles
RoleApiListUserRolesGet /operators/{operator_id}/users/{user_name}/rolesList User Roles
RoleApiUpdateRolePut /operators/{operator_id}/roles/{role_id}Update Role
ShippingAddressApiCreateShippingAddressPost /operators/{operator_id}/shipping_addressesCreate shipping address
ShippingAddressApiDeleteShippingAddressDelete /operators/{operator_id}/shipping_addresses/{shipping_address_id}Delete shipping address
ShippingAddressApiGetShippingAddressGet /operators/{operator_id}/shipping_addresses/{shipping_address_id}Get shipping address
ShippingAddressApiListShippingAddressesGet /operators/{operator_id}/shipping_addressesList shipping addresses
ShippingAddressApiUpdateShippingAddressPut /operators/{operator_id}/shipping_addresses/{shipping_address_id}Update shipping address
SigfoxDeviceApiDeleteSigfoxDeviceTagDelete /sigfox_devices/{device_id}/tags/{tag_name}Delete Sigfox device Tag
SigfoxDeviceApiDisableTerminationOnSigfoxDevicePost /sigfox_devices/{device_id}/disable_terminationDisable Termination of Sigfox device
SigfoxDeviceApiEnableTerminationOnSigfoxDevicePost /sigfox_devices/{device_id}/enable_terminationEnable Termination of Sigfox device
SigfoxDeviceApiGetDataFromSigfoxDeviceGet /sigfox_devices/{device_id}/dataGet data sent from a Sigfox device.
SigfoxDeviceApiGetSigfoxDeviceGet /sigfox_devices/{device_id}Get Sigfox device
SigfoxDeviceApiListSigfoxDevicesGet /sigfox_devicesList Sigfox devices
SigfoxDeviceApiPutSigfoxDeviceTagsPut /sigfox_devices/{device_id}/tagsBulk Insert or Update Sigfox device Tags
SigfoxDeviceApiRegisterSigfoxDevicePost /sigfox_devices/{device_id}/registerRegister a Sigfox device.
SigfoxDeviceApiSendDataToSigfoxDevicePost /sigfox_devices/{device_id}/dataSend data to a Sigfox device.
SigfoxDeviceApiSetSigfoxDeviceGroupPost /sigfox_devices/{device_id}/set_groupSet Group to Sigfox device
SigfoxDeviceApiTerminateSigfoxDevicePost /sigfox_devices/{device_id}/terminateTerminate Sigfox device
SigfoxDeviceApiUnsetSigfoxDeviceGroupPost /sigfox_devices/{device_id}/unset_groupUnset Group to Sigfox device
SimApiActivateSimPost /sims/{sim_id}/activateActivate SIM
SimApiAddSubscriptionPost /sims/{sim_id}/profiles/{iccid}/add_subscription新しいセカンダリサブスクリプションを IoT SIM に追加する
SimApiAttachArcSimCredentialsPost /sims/{sim_id}/credentials/arc(非推奨) Arc のクレデンシャルを SIM へ付与
SimApiCancelSubscriptionContainerDownloadPost /sims/{sim_id}/profiles/{iccid}/subscribers/{imsi}/cancel_downloadCancel subscription download to subscription container
SimApiCreateArcSessionPost /sims/{sim_id}/sessions/arcSORACOM Arc セッションの作成
SimApiCreateSimPost /simsSIM の新規作成
SimApiCreateSimPacketCaptureSessionPost /sims/{sim_id}/packet_capture_sessionsCreate Packet Capture Session
SimApiDeactivateSimPost /sims/{sim_id}/deactivateDeactivate SIM
SimApiDeleteSimPacketCaptureSessionDelete /sims/{sim_id}/packet_capture_sessions/{session_id}Delete Packet Capture Session
SimApiDeleteSimSessionPost /sims/{sim_id}/delete_sessionDelete Session
SimApiDeleteSimTagDelete /sims/{sim_id}/tags/{tag_name}Delete SIM Tag
SimApiDeleteSubscriptionContainerCountryMappingEntryDelete /sims/{sim_id}/profiles/{iccid}/subscription_containers/country_mapping/{mcc}Delete subscription container mapping entries
SimApiDisableSimTerminationPost /sims/{sim_id}/disable_terminationDisable Termination of SIM
SimApiEnableSimTerminationPost /sims/{sim_id}/enable_terminationEnable Termination of SIM
SimApiEnableSubscriptionContainerPost /sims/{sim_id}/profiles/{iccid}/subscription_containers/{container_id}/enableEnables a subscription container.
SimApiGetDataFromSimGet /sims/{sim_id}/dataGet data sent from a SIM.
SimApiGetSimGet /sims/{sim_id}Get SIM
SimApiGetSimPacketCaptureSessionGet /sims/{sim_id}/packet_capture_sessions/{session_id}Get Packet Capture Session
SimApiListSimPacketCaptureSessionsGet /sims/{sim_id}/packet_capture_sessionsList packet capture sessions associated with the SIM
SimApiListSimSessionEventsGet /sims/{sim_id}/events/sessionsList Session Events
SimApiListSimsGet /simsList SIMs
SimApiListSubscriptionContainersGet /sims/{sim_id}/profiles/{iccid}/subscription_containersGet subscription container status.
SimApiPutSimTagsPut /sims/{sim_id}/tagsBulk Insert or Update SIM Tags
SimApiPutSubscriptionContainerCountryMappingEntriesPut /sims/{sim_id}/profiles/{iccid}/subscription_containers/country_mappingUpdates subscription container country mapping entries.
SimApiRegisterSimPost /sims/{sim_id}/registerRegister SIM
SimApiRemoveArcSimCredentialsDelete /sims/{sim_id}/credentials/arc(非推奨) Arc のクレデンシャルを SIM から除去
SimApiRenewArcSimCredentialsPut /sims/{sim_id}/credentials/arcSIM に対する Arc のクレデンシャルを更新する
SimApiReportSimLocalInfoPost /sims/{sim_id}/report_local_infoSIM ローカル情報レポートを取得する
SimApiSendDownlinkPingPost /sims/{sim_id}/downlink/pingSIM に対して ping リクエストを送信する。
SimApiSendSmsToSimPost /sims/{sim_id}/send_smsSend SMS to SIM
SimApiSetSimExpiryTimePost /sims/{sim_id}/set_expiry_timeUpdate Expiry Time of SIM
SimApiSetSimGroupPost /sims/{sim_id}/set_groupSet Group to SIM
SimApiSetSimImeiLockPost /sims/{sim_id}/set_imei_lockSet IMEI lock configuration for SIM.
SimApiSetSimToStandbyPost /sims/{sim_id}/set_to_standbySet SIM to standby mode.
SimApiStopSimPacketCaptureSessionPost /sims/{sim_id}/packet_capture_sessions/{session_id}/stopStop SIM Packet Capture Session
SimApiSuspendSimPost /sims/{sim_id}/suspendSuspend SIM
SimApiTerminateSimPost /sims/{sim_id}/terminateTerminate SIM
SimApiTerminateSubscriptionContainerPost /sims/{sim_id}/profiles/{iccid}/subscribers/{imsi}/terminateセカンダリサブスクリプションの利用終了
SimApiUnsetSimExpiryTimePost /sims/{sim_id}/unset_expiry_timeDelete Expiry Time of SIM
SimApiUnsetSimGroupPost /sims/{sim_id}/unset_groupUnset Group to SIM
SimApiUnsetSimImeiLockPost /sims/{sim_id}/unset_imei_lockUnset IMEI lock configuration for SIM.
SimApiUpdateSimSpeedClassPost /sims/{sim_id}/update_speed_classUpdate SIM speed class
SoraCamApiExportSoraCamDeviceRecordedImagePost /sora_cam/devices/{device_id}/images/exportsクラウド常時録画で保存された録画映像から静止画をエクスポートする処理を開始する
SoraCamApiExportSoraCamDeviceRecordedVideoPost /sora_cam/devices/{device_id}/videos/exportsクラウド常時録画で保存された録画映像をエクスポートする処理を開始する
SoraCamApiGetSoraCamDeviceGet /sora_cam/devices/{device_id}ソラカメ対応カメラの情報を取得する
SoraCamApiGetSoraCamDeviceExportUsageGet /sora_cam/devices/{device_id}/exports/usageソラカメ対応カメラの静止画のエクスポート可能枚数や録画映像のエクスポート可能時間を取得する
SoraCamApiGetSoraCamDeviceExportedImageGet /sora_cam/devices/{device_id}/images/exports/{export_id}クラウド常時録画で保存された録画映像から静止画をエクスポートする処理の現在の状況を取得する
SoraCamApiGetSoraCamDeviceExportedVideoGet /sora_cam/devices/{device_id}/videos/exports/{export_id}クラウド常時録画で保存された録画映像をエクスポートする処理の現在の状況を取得する
SoraCamApiGetSoraCamDeviceStreamingVideoGet /sora_cam/devices/{device_id}/streamストリーミング映像 (リアルタイム映像 / 録画映像) をダウンロードするための情報を取得する
SoraCamApiListSoraCamDeviceImageExportsGet /sora_cam/devices/images/exportsソラカメ対応カメラで撮影した録画映像から静止画をエクスポートする処理の現在の状況をリストで取得する
SoraCamApiListSoraCamDeviceImageExportsForDeviceGet /sora_cam/devices/{device_id}/images/exportsソラカメ対応カメラで撮影した録画映像から静止画をエクスポートする処理の現在の状況をリストで取得する
SoraCamApiListSoraCamDeviceVideoExportsGet /sora_cam/devices/videos/exportsソラカメ対応カメラで撮影した録画映像をエクスポートする処理の現在の状況をリストで取得する
SoraCamApiListSoraCamDeviceVideoExportsForDeviceGet /sora_cam/devices/{device_id}/videos/exportsソラカメ対応カメラで撮影した録画映像をエクスポートする処理の現在の状況をリストで取得する
SoraCamApiListSoraCamDevicesGet /sora_cam/devicesソラカメ対応カメラの一覧を取得する
SoraCamApiListSoraCamLicensePacksGet /sora_cam/license_packsSoracom Cloud Camera Services のライセンスパックの一覧を取得します。
SoraCamApiUpdateSoraCamLicensePackQuantityPut /sora_cam/license_packs/{license_pack_id}/quantitySoracom Cloud Camera Services のライセンス数を更新します。
SoraletApiCreateSoraletPost /soraletsSoralet を作成します。
SoraletApiDeleteSoraletDelete /soralets/{soralet_id}Soralet を削除します。
SoraletApiDeleteSoraletVersionDelete /soralets/{soralet_id}/versions/{version}Soralet のバージョンを削除します。
SoraletApiGetSoraletGet /soralets/{soralet_id}Soralet を取得します。
SoraletApiGetSoraletLogsGet /soralets/{soralet_id}/logsSoralet のログメッセージを取得します。
SoraletApiListSoraletVersionsGet /soralets/{soralet_id}/versionsSoralet のバージョン一覧を取得します。
SoraletApiListSoraletsGet /soraletsSoralet の一覧を取得します。
SoraletApiTestSoraletPost /soralets/{soralet_id}/test引数を指定して Soralet をテスト実行します。
SoraletApiUploadSoraletCodePost /soralets/{soralet_id}/versionsコードをアップロードし、新しいバージョンを作成します。
StatsApiExportAirStatsPost /stats/air/operators/{operator_id}/exportExport Air Usage Report of All Subscribers
StatsApiExportBeamStatsPost /stats/beam/operators/{operator_id}/exportExport Beam Usage Report of All Subscribers
StatsApiExportFunkStatsPost /stats/funk/operators/{operator_id}/exportExport Funk Usage Report of All Subscribers
StatsApiExportFunnelStatsPost /stats/funnel/operators/{operator_id}/exportExport Funnel Usage Report of All Subscribers
StatsApiGetAirStatsGet /stats/air/subscribers/{imsi}Get Air Usage Report of Subscriber
StatsApiGetAirStatsOfSimGet /stats/air/sims/{sim_id}Get Air Usage Report of SIM
StatsApiGetBeamStatsGet /stats/beam/subscribers/{imsi}Get Beam Usage Report of Subscriber
StatsApiGetFunkStatsGet /stats/funk/subscribers/{imsi}Get Funk Usage Report of Subscriber
StatsApiGetFunnelStatsGet /stats/funnel/subscribers/{imsi}Get Funnel Usage Report of Subscriber
StatsApiGetHarvestExportedDataStatsGet /stats/harvest/operators/{operator_id}Harvest の利用統計情報を取得します。
StatsApiGetHarvestStatsGet /stats/harvest/subscribers/{imsi}Get Harvest Usage Report of Subscriber
StatsApiGetNapterAuditLogsExportedDataStatsGet /stats/napter/audit_logsNapter 監査ログの月次読み込みデータ量を取得する。
SubscriberApiActivateSubscriberPost /subscribers/{imsi}/activateActivate Subscriber
SubscriberApiDeactivateSubscriberPost /subscribers/{imsi}/deactivateDeactivate Subscriber
SubscriberApiDeleteSubscriberSessionPost /subscribers/{imsi}/delete_sessionDelete Session
SubscriberApiDeleteSubscriberTagDelete /subscribers/{imsi}/tags/{tag_name}Delete Subscriber Tag
SubscriberApiDeleteSubscriberTransferTokenDelete /subscribers/transfer_token/{token}Delete Subscribers Transfer Token
SubscriberApiDisableTerminationPost /subscribers/{imsi}/disable_terminationDisable Termination of Subscriber
SubscriberApiEnableTerminationPost /subscribers/{imsi}/enable_terminationEnable Termination of Subscriber
SubscriberApiExportSubscribersPost /subscribers/exportExport all subscribers.
SubscriberApiGetDataFromSubscriberGet /subscribers/{imsi}/dataGet data sent from a subscriber.
SubscriberApiGetSubscriberGet /subscribers/{imsi}Get Subscriber
SubscriberApiIssueSubscriberTransferTokenPost /subscribers/transfer_token/issueIssue Subscribers Transfer Token
SubscriberApiListSessionEventsGet /subscribers/{imsi}/events/sessionsList Session Events
SubscriberApiListSubscribersGet /subscribersList Subscribers
SubscriberApiPutBundlesPut /subscribers/{imsi}/bundlesSet Bundles to Subscriber.
SubscriberApiPutSubscriberTagsPut /subscribers/{imsi}/tagsBulk Insert or Update Subscriber Tags
SubscriberApiRegisterSubscriberPost /subscribers/{imsi}/registerRegister Subscriber
SubscriberApiReportLocalInfoPost /subscribers/{imsi}/report_local_infoTriggers Subscriber to report SIM local info.
SubscriberApiSendSmsPost /subscribers/{imsi}/send_smsSend SMS to Subscriber
SubscriberApiSendSmsByMsisdnPost /subscribers/msisdn/{msisdn}/send_smsSend SMS to Subscriber by MSISDN
SubscriberApiSetExpiryTimePost /subscribers/{imsi}/set_expiry_timeUpdate Expiry Time of Subscriber
SubscriberApiSetGroupPost /subscribers/{imsi}/set_groupSet Group to Subscriber
SubscriberApiSetImeiLockPost /subscribers/{imsi}/set_imei_lockSet IMEI lock configuration for Subscriber.
SubscriberApiSetSubscriberToStandbyPost /subscribers/{imsi}/set_to_standbySet Subscriber to standby mode.
SubscriberApiSubscriberDownlinkPingToUserEquipmentPost /subscribers/{imsi}/downlink/pingSubscriber に対して ping リクエストを送信する。
SubscriberApiSuspendSubscriberPost /subscribers/{imsi}/suspendSuspend Subscriber
SubscriberApiTerminateSubscriberPost /subscribers/{imsi}/terminateTerminate Subscriber
SubscriberApiUnsetExpiryTimePost /subscribers/{imsi}/unset_expiry_timeDelete Expiry Time of Subscriber
SubscriberApiUnsetGroupPost /subscribers/{imsi}/unset_groupUnset Group to Subscriber
SubscriberApiUnsetImeiLockPost /subscribers/{imsi}/unset_imei_lockUnset IMEI lock configuration for Subscriber.
SubscriberApiUpdateSpeedClassPost /subscribers/{imsi}/update_speed_classUpdate Subscriber speed class
SubscriberApiVerifySubscriberTransferTokenPost /subscribers/transfer_token/verifyVerify Subscriber Transfer Token
SystemNotificationApiDeleteSystemNotificationDelete /operators/{operator_id}/system_notifications/{type}Delete system notification
SystemNotificationApiGetSystemNotificationGet /operators/{operator_id}/system_notifications/{type}Get system notification
SystemNotificationApiListSystemNotificationsGet /operators/{operator_id}/system_notificationsList system notifications
SystemNotificationApiSetSystemNotificationPost /operators/{operator_id}/system_notifications/{type}Set system notification
UserApiCreateUserPost /operators/{operator_id}/users/{user_name}Create User
UserApiCreateUserPasswordPost /operators/{operator_id}/users/{user_name}/passwordCreate Password
UserApiDeleteDefaultPermissionsDelete /operators/{operator_id}/users/default_permissionsすべての SAM ユーザーに適用されるデフォルト権限を削除する
UserApiDeleteUserDelete /operators/{operator_id}/users/{user_name}Delete User
UserApiDeleteUserAuthKeyDelete /operators/{operator_id}/users/{user_name}/auth_keys/{auth_key_id}Delete User AuthKey
UserApiDeleteUserPasswordDelete /operators/{operator_id}/users/{user_name}/passwordDelete Password
UserApiDeleteUserPermissionDelete /operators/{operator_id}/users/{user_name}/permissionSAM ユーザーの権限を削除する
UserApiEnableUserMFAPost /operators/{operator_id}/users/{user_name}/mfaEnable SAM user's MFA
UserApiGenerateUserAuthKeyPost /operators/{operator_id}/users/{user_name}/auth_keysGenerate AuthKey
UserApiGetDefaultPermissionsGet /operators/{operator_id}/users/default_permissionsすべての SAM ユーザーに適用されるデフォルト権限を取得する
UserApiGetUserGet /operators/{operator_id}/users/{user_name}Get User
UserApiGetUserAuthKeyGet /operators/{operator_id}/users/{user_name}/auth_keys/{auth_key_id}Get AuthKey
UserApiGetUserMFAStatusGet /operators/{operator_id}/users/{user_name}/mfaGet SAM user's MFA status
UserApiGetUserPermissionGet /operators/{operator_id}/users/{user_name}/permissionGet User Permission
UserApiHasUserPasswordGet /operators/{operator_id}/users/{user_name}/passwordHas User Password
UserApiListUserAuthKeysGet /operators/{operator_id}/users/{user_name}/auth_keysList User AuthKeys
UserApiListUsersGet /operators/{operator_id}/usersList Users
UserApiRevokeUserAuthTokensDelete /operators/{operator_id}/users/{user_name}/tokens指定された SAM ユーザーが発行した全ての API キーと API トークンを無効化します。
UserApiRevokeUserMFADelete /operators/{operator_id}/users/{user_name}/mfaRevoke SAM user's MFA
UserApiUpdateDefaultPermissionsPut /operators/{operator_id}/users/default_permissionsUpdate the default permissions
UserApiUpdateUserPut /operators/{operator_id}/users/{user_name}Update User
UserApiUpdateUserPasswordPut /operators/{operator_id}/users/{user_name}/passwordUpdate Password
UserApiUpdateUserPermissionPut /operators/{operator_id}/users/{user_name}/permissionSAM ユーザーの権限を更新する
UserApiVerifyUserMFAPost /operators/{operator_id}/users/{user_name}/mfa/verifyVerify SAM user's MFA OTP code when MFA activation phase
VirtualPrivateGatewayApiCloseGatePost /virtual_private_gateways/{vpg_id}/gate/closeClose SORACOM Gate.
VirtualPrivateGatewayApiCreateMirroringPeerPost /virtual_private_gateways/{vpg_id}/junction/mirroring/peersJunction ミラーリング peer を追加します。
VirtualPrivateGatewayApiCreatePacketCaptureSessionPost /virtual_private_gateways/{vpg_id}/packet_capture_sessionsCreate Packet Capture Session
VirtualPrivateGatewayApiCreateVirtualPrivateGatewayPost /virtual_private_gatewaysCreate Virtual Private Gateway
VirtualPrivateGatewayApiCreateVpcPeeringConnectionPost /virtual_private_gateways/{vpg_id}/vpc_peering_connectionsCreate VPC Peering Connection
VirtualPrivateGatewayApiDeleteMirroringPeerDelete /virtual_private_gateways/{vpg_id}/junction/mirroring/peers/{ipaddr}Junction ミラーリング peer を削除します。
VirtualPrivateGatewayApiDeletePacketCaptureSessionDelete /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}Delete Packet Capture Session
VirtualPrivateGatewayApiDeleteVirtualPrivateGatewayIpAddressMapEntryDelete /virtual_private_gateways/{vpg_id}/ip_address_map/{key}Delete VPG IP address map entry
VirtualPrivateGatewayApiDeleteVpcPeeringConnectionDelete /virtual_private_gateways/{vpg_id}/vpc_peering_connections/{pcx_id}Delete VPC Peering Connection
VirtualPrivateGatewayApiDisableGatePrivacySeparatorPost /virtual_private_gateways/{vpg_id}/gate/disable_privacy_separator指定された VPG に対して SORACOM Gate のプライバシーセパレーター機能を無効にする。
VirtualPrivateGatewayApiEnableGatePrivacySeparatorPost /virtual_private_gateways/{vpg_id}/gate/enable_privacy_separator指定された VPG に対して SORACOM Gate のプライバシーセパレーター機能を有効にする。
VirtualPrivateGatewayApiGetPacketCaptureSessionGet /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}Get Packet Capture Session
VirtualPrivateGatewayApiGetVirtualPrivateGatewayGet /virtual_private_gateways/{vpg_id}Get Virtual Private Gateway
VirtualPrivateGatewayApiListGatePeersGet /virtual_private_gateways/{vpg_id}/gate/peersList VPG Gate peers
VirtualPrivateGatewayApiListPacketCaptureSessionsGet /virtual_private_gateways/{vpg_id}/packet_capture_sessionsList Packet Capture Sessions
VirtualPrivateGatewayApiListVirtualPrivateGatewayIpAddressMapEntriesGet /virtual_private_gateways/{vpg_id}/ip_address_mapList VPG IP address map entries
VirtualPrivateGatewayApiListVirtualPrivateGatewaysGet /virtual_private_gatewaysList Virtual Private Gateways
VirtualPrivateGatewayApiOpenGatePost /virtual_private_gateways/{vpg_id}/gate/openOpen SORACOM Gate
VirtualPrivateGatewayApiPutVirtualPrivateGatewayIpAddressMapEntryPost /virtual_private_gateways/{vpg_id}/ip_address_mapPut VPG IP address map entry
VirtualPrivateGatewayApiRegisterGatePeerPost /virtual_private_gateways/{vpg_id}/gate/peersRegister VPG Gate Peer
VirtualPrivateGatewayApiSetInspectionConfigurationPost /virtual_private_gateways/{vpg_id}/junction/set_inspectionJunction インスペクション機能の設定を行います。
VirtualPrivateGatewayApiSetRedirectionConfigurationPost /virtual_private_gateways/{vpg_id}/junction/set_redirectionJunction リダイレクション機能の設定を行います。
VirtualPrivateGatewayApiSetRoutingFilterPost /virtual_private_gateways/{vpg_id}/set_routing_filterSets Virtual Private Gateway outbound routing filter.
VirtualPrivateGatewayApiStopPacketCaptureSessionPost /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}/stopStop Packet Capture Session
VirtualPrivateGatewayApiTerminateVirtualPrivateGatewayPost /virtual_private_gateways/{vpg_id}/terminateTerminate Virtual Private Gateway
VirtualPrivateGatewayApiUnregisterGatePeerDelete /virtual_private_gateways/{vpg_id}/gate/peers/{outer_ip_address}Unregister VPG Gate Peer
VirtualPrivateGatewayApiUnsetInspectionConfigurationPost /virtual_private_gateways/{vpg_id}/junction/unset_inspectionJunction インスペクション機能の設定を解除します。
VirtualPrivateGatewayApiUnsetRedirectionConfigurationPost /virtual_private_gateways/{vpg_id}/junction/unset_redirectionJunction リダイレクション機能の設定を行います。
VirtualPrivateGatewayApiUpdateMirroringPeerPut /virtual_private_gateways/{vpg_id}/junction/mirroring/peers/{ipaddr}Junction ミラーリング peer を更新します。

Documentation For Models

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

Author