Contents

# PulpcoreClient::OrphansCleanupApi

All URIs are relative to *https://pulp*

Method | HTTP request | Description
------------- | ------------- | -------------
[**cleanup**](OrphansCleanupApi.md#cleanup) | **POST** /pulp/api/v3/orphans/cleanup/ | 



## cleanup

> AsyncOperationResponse cleanup(orphans_cleanup)



Trigger an asynchronous orphan cleanup operation.

### Example

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

api_instance = PulpcoreClient::OrphansCleanupApi.new
orphans_cleanup = PulpcoreClient::OrphansCleanup.new # OrphansCleanup | 

begin
  result = api_instance.cleanup(orphans_cleanup)
  p result
rescue PulpcoreClient::ApiError => e
  puts "Exception when calling OrphansCleanupApi->cleanup: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **orphans_cleanup** | [**OrphansCleanup**](OrphansCleanup.md)|  | 

### Return type

[**AsyncOperationResponse**](AsyncOperationResponse.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

214 entries across 214 versions & 1 rubygems

Version	Path
pulpcore_client-3.22.28	docs/OrphansCleanupApi.md
pulpcore_client-3.21.31	docs/OrphansCleanupApi.md
pulpcore_client-3.28.29	docs/OrphansCleanupApi.md
pulpcore_client-3.28.28	docs/OrphansCleanupApi.md
pulpcore_client-3.22.27	docs/OrphansCleanupApi.md
pulpcore_client-3.21.30	docs/OrphansCleanupApi.md
pulpcore_client-3.28.26	docs/OrphansCleanupApi.md
pulpcore_client-3.22.25	docs/OrphansCleanupApi.md
pulpcore_client-3.22.24	docs/OrphansCleanupApi.md
pulpcore_client-3.28.25	docs/OrphansCleanupApi.md
pulpcore_client-3.28.24	docs/OrphansCleanupApi.md
pulpcore_client-3.21.26	docs/OrphansCleanupApi.md
pulpcore_client-3.18.35	docs/OrphansCleanupApi.md
pulpcore_client-3.28.23	docs/OrphansCleanupApi.md
pulpcore_client-3.22.22	docs/OrphansCleanupApi.md
pulpcore_client-3.28.22	docs/OrphansCleanupApi.md
pulpcore_client-3.28.21	docs/OrphansCleanupApi.md
pulpcore_client-3.28.20	docs/OrphansCleanupApi.md
pulpcore_client-3.18.34	docs/OrphansCleanupApi.md
pulpcore_client-3.22.21	docs/OrphansCleanupApi.md