Contents

# PulpFileClient::ImportersPulpImportCheckApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**pulp_import_check_post**](ImportersPulpImportCheckApi.md#pulp_import_check_post) | **POST** /pulp/api/v3/importers/core/pulp/import-check/ | Validate the parameters to be used for a PulpImport call



## pulp_import_check_post

> PulpImportCheckResponse pulp_import_check_post(pulp_import_check)

Validate the parameters to be used for a PulpImport call

Evaluates validity of proposed PulpImport parameters 'toc', 'path', and 'repo_mapping'.  * Checks that toc, path are in ALLOWED_IMPORT_PATHS * if ALLOWED:   * Checks that toc, path exist and are readable   * If toc specified, checks that containing dir is writeable * Checks that repo_mapping is valid JSON

### Example

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

api_instance = PulpFileClient::ImportersPulpImportCheckApi.new
pulp_import_check = PulpFileClient::PulpImportCheck.new # PulpImportCheck | 

begin
  #Validate the parameters to be used for a PulpImport call
  result = api_instance.pulp_import_check_post(pulp_import_check)
  p result
rescue PulpFileClient::ApiError => e
  puts "Exception when calling ImportersPulpImportCheckApi->pulp_import_check_post: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **pulp_import_check** | [**PulpImportCheck**](PulpImportCheck.md)|  | 

### Return type

[**PulpImportCheckResponse**](PulpImportCheckResponse.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
pulp_file_client-3.55.2	docs/ImportersPulpImportCheckApi.md
pulp_file_client-3.49.14	docs/ImportersPulpImportCheckApi.md