github.com/twilio/twilio-go@v1.20.1/rest/microvisor/v1/docs/DevicesApi.md (about)

     1  # DevicesApi
     2  
     3  All URIs are relative to *https://microvisor.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchDevice**](DevicesApi.md#FetchDevice) | **Get** /v1/Devices/{Sid} | 
     8  [**ListDevice**](DevicesApi.md#ListDevice) | **Get** /v1/Devices | 
     9  [**UpdateDevice**](DevicesApi.md#UpdateDevice) | **Post** /v1/Devices/{Sid} | 
    10  
    11  
    12  
    13  ## FetchDevice
    14  
    15  > MicrovisorV1Device FetchDevice(ctx, Sid)
    16  
    17  
    18  
    19  Fetch a specific Device.
    20  
    21  ### Path Parameters
    22  
    23  
    24  Name | Type | Description
    25  ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **Sid** | **string** | A 34-character string that uniquely identifies this Device.
    28  
    29  ### Other Parameters
    30  
    31  Other parameters are passed through a pointer to a FetchDeviceParams struct
    32  
    33  
    34  Name | Type | Description
    35  ------------- | ------------- | -------------
    36  
    37  ### Return type
    38  
    39  [**MicrovisorV1Device**](MicrovisorV1Device.md)
    40  
    41  ### Authorization
    42  
    43  [accountSid_authToken](../README.md#accountSid_authToken)
    44  
    45  ### HTTP request headers
    46  
    47  - **Content-Type**: Not defined
    48  - **Accept**: application/json
    49  
    50  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    51  [[Back to Model list]](../README.md#documentation-for-models)
    52  [[Back to README]](../README.md)
    53  
    54  
    55  ## ListDevice
    56  
    57  > []MicrovisorV1Device ListDevice(ctx, optional)
    58  
    59  
    60  
    61  Retrieve a list of all Devices registered with the Account.
    62  
    63  ### Path Parameters
    64  
    65  This endpoint does not need any path parameter.
    66  
    67  ### Other Parameters
    68  
    69  Other parameters are passed through a pointer to a ListDeviceParams struct
    70  
    71  
    72  Name | Type | Description
    73  ------------- | ------------- | -------------
    74  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
    75  **Limit** | **int** | Max number of records to return.
    76  
    77  ### Return type
    78  
    79  [**[]MicrovisorV1Device**](MicrovisorV1Device.md)
    80  
    81  ### Authorization
    82  
    83  [accountSid_authToken](../README.md#accountSid_authToken)
    84  
    85  ### HTTP request headers
    86  
    87  - **Content-Type**: Not defined
    88  - **Accept**: application/json
    89  
    90  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    91  [[Back to Model list]](../README.md#documentation-for-models)
    92  [[Back to README]](../README.md)
    93  
    94  
    95  ## UpdateDevice
    96  
    97  > MicrovisorV1Device UpdateDevice(ctx, Sidoptional)
    98  
    99  
   100  
   101  Update a specific Device.
   102  
   103  ### Path Parameters
   104  
   105  
   106  Name | Type | Description
   107  ------------- | ------------- | -------------
   108  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   109  **Sid** | **string** | A 34-character string that uniquely identifies this Device.
   110  
   111  ### Other Parameters
   112  
   113  Other parameters are passed through a pointer to a UpdateDeviceParams struct
   114  
   115  
   116  Name | Type | Description
   117  ------------- | ------------- | -------------
   118  **UniqueName** | **string** | A unique and addressable name to be assigned to this Device by the developer. It may be used in place of the Device SID.
   119  **TargetApp** | **string** | The SID or unique name of the App to be targeted to the Device.
   120  **LoggingEnabled** | **bool** | A Boolean flag specifying whether to enable application logging. Logs will be enabled or extended for 24 hours.
   121  **RestartApp** | **bool** | Set to true to restart the App running on the Device.
   122  
   123  ### Return type
   124  
   125  [**MicrovisorV1Device**](MicrovisorV1Device.md)
   126  
   127  ### Authorization
   128  
   129  [accountSid_authToken](../README.md#accountSid_authToken)
   130  
   131  ### HTTP request headers
   132  
   133  - **Content-Type**: application/x-www-form-urlencoded
   134  - **Accept**: application/json
   135  
   136  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   137  [[Back to Model list]](../README.md#documentation-for-models)
   138  [[Back to README]](../README.md)
   139