Sha256: 4e13068ead2e44a3f342b806fd685ea1a8d0180bc2493641a64f77f2e1c45725

Contents?: true

Size: 1.8 KB

Versions: 4

Compression:

Stored size: 1.8 KB

Contents

# PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleClientConfigurationApi

All URIs are relative to *http://localhost:24817*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get**](PulpAnsibleApiV3PluginAnsibleClientConfigurationApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/v3/plugin/ansible/client-configuration/ | 



## get

> ClientConfigurationResponse get(path, opts)



Get the client configs.

### Example

```ruby
# load the gem
require 'pulp_ansible_client'
# setup authorization
PulpAnsibleClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleClientConfigurationApi.new
path = 'path_example' # String | 
opts = {
  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
}

begin
  result = api_instance.get(path, opts)
  p result
rescue PulpAnsibleClient::ApiError => e
  puts "Exception when calling PulpAnsibleApiV3PluginAnsibleClientConfigurationApi->get: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **path** | **String**|  | 
 **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
 **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 

### Return type

[**ClientConfigurationResponse**](ClientConfigurationResponse.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
pulp_ansible_client-0.16.6 docs/PulpAnsibleApiV3PluginAnsibleClientConfigurationApi.md
pulp_ansible_client-0.15.6 docs/PulpAnsibleApiV3PluginAnsibleClientConfigurationApi.md
pulp_ansible_client-0.16.5 docs/PulpAnsibleApiV3PluginAnsibleClientConfigurationApi.md
pulp_ansible_client-0.16.4 docs/PulpAnsibleApiV3PluginAnsibleClientConfigurationApi.md