github.com/filecoin-project/bacalhau@v0.3.23-0.20230228154132-45c989550ace/clients/python/docs/MiscApi.md (about)

     1  # bacalhau_apiclient.MiscApi
     2  
     3  All URIs are relative to *http://bootstrap.production.bacalhau.org:1234*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**api_serverversion**](MiscApi.md#api_serverversion) | **POST** /version | Returns the build version running on the server.
     8  
     9  
    10  # **api_serverversion**
    11  > VersionResponse api_serverversion(version_request)
    12  
    13  Returns the build version running on the server.
    14  
    15  See https://github.com/filecoin-project/bacalhau/releases for a complete list of `gitversion` tags.
    16  
    17  ### Example
    18  ```python
    19  from __future__ import print_function
    20  import time
    21  import bacalhau_apiclient
    22  from bacalhau_apiclient.rest import ApiException
    23  from pprint import pprint
    24  
    25  # create an instance of the API class
    26  api_instance = bacalhau_apiclient.MiscApi()
    27  version_request = bacalhau_apiclient.VersionRequest() # VersionRequest | Request must specify a `client_id`. To retrieve your `client_id`, you can do the following: (1) submit a dummy job to Bacalhau (or use one you created before), (2) run `bacalhau describe <job-id>` and fetch the `ClientID` field.
    28  
    29  try:
    30      # Returns the build version running on the server.
    31      api_response = api_instance.api_serverversion(version_request)
    32      pprint(api_response)
    33  except ApiException as e:
    34      print("Exception when calling MiscApi->api_serverversion: %s\n" % e)
    35  ```
    36  
    37  ### Parameters
    38  
    39  Name | Type | Description  | Notes
    40  ------------- | ------------- | ------------- | -------------
    41   **version_request** | [**VersionRequest**](VersionRequest.md)| Request must specify a &#x60;client_id&#x60;. To retrieve your &#x60;client_id&#x60;, you can do the following: (1) submit a dummy job to Bacalhau (or use one you created before), (2) run &#x60;bacalhau describe &lt;job-id&gt;&#x60; and fetch the &#x60;ClientID&#x60; field. | 
    42  
    43  ### Return type
    44  
    45  [**VersionResponse**](VersionResponse.md)
    46  
    47  ### Authorization
    48  
    49  No authorization required
    50  
    51  ### HTTP request headers
    52  
    53   - **Content-Type**: application/json
    54   - **Accept**: application/json
    55  
    56  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    57