# cloudmersive_cdr_api_client
Use the Content Disarm and Reconstruction API to remove security risks from documents by tearing them down, removing unsafe content and rebuilding them.
This Python package provides a native API client for [Cloudmersive CDR API](https://cloudmersive.com/cdr-api)
- API version: v1
- Package version: 3.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import cloudmersive_cdr_api_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import cloudmersive_cdr_api_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import cloudmersive_cdr_api_client
from cloudmersive_cdr_api_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Apikey
configuration = cloudmersive_cdr_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'
# create an instance of the API class
api_instance = cloudmersive_cdr_api_client.FileSanitizationApi(cloudmersive_cdr_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input document, or photos of a document, to extract data from (optional)
try:
# Complete Content Disarm and Reconstruction on an Input File, and output in same file format
api_instance.file(input_file=input_file)
except ApiException as e:
print("Exception when calling FileSanitizationApi->file: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.cloudmersive.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FileSanitizationApi* | [**file**](docs/FileSanitizationApi.md#file) | **POST** /cdr/sanitization/file | Complete Content Disarm and Reconstruction on an Input File, and output in same file format
*FileSanitizationApi* | [**file_to_pdf**](docs/FileSanitizationApi.md#file_to_pdf) | **POST** /cdr/sanitization/file/to/pdf | Complete Content Disarm and Reconstruction on an Input File with PDF/A Output
## Documentation For Models
## Documentation For Authorization
## Apikey
- **Type**: API key
- **API key parameter name**: Apikey
- **Location**: HTTP header
## Author
Raw data
{
"_id": null,
"home_page": "https://cloudmersive.com/cdr-api",
"name": "cloudmersive-cdr-api-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Swagger, CDR API",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9b/fb/4f6f65cbf656d012433aebaa4972d6a80cc99a93f74ba8d1d00e07d9b0d9/cloudmersive_cdr_api_client-3.0.0.tar.gz",
"platform": null,
"description": "# cloudmersive_cdr_api_client\r\nUse the Content Disarm and Reconstruction API to remove security risks from documents by tearing them down, removing unsafe content and rebuilding them.\r\n\r\nThis Python package provides a native API client for [Cloudmersive CDR API](https://cloudmersive.com/cdr-api)\r\n\r\n- API version: v1\r\n- Package version: 3.0.0\r\n- Build package: io.swagger.codegen.languages.PythonClientCodegen\r\n\r\n## Requirements.\r\n\r\nPython 2.7 and 3.4+\r\n\r\n## Installation & Usage\r\n### pip install\r\n\r\nIf the python package is hosted on Github, you can install directly from Github\r\n\r\n```sh\r\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\r\n```\r\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\r\n\r\nThen import the package:\r\n```python\r\nimport cloudmersive_cdr_api_client \r\n```\r\n\r\n### Setuptools\r\n\r\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\r\n\r\n```sh\r\npython setup.py install --user\r\n```\r\n(or `sudo python setup.py install` to install the package for all users)\r\n\r\nThen import the package:\r\n```python\r\nimport cloudmersive_cdr_api_client\r\n```\r\n\r\n## Getting Started\r\n\r\nPlease follow the [installation procedure](#installation--usage) and then run the following:\r\n\r\n```python\r\nfrom __future__ import print_function\r\nimport time\r\nimport cloudmersive_cdr_api_client\r\nfrom cloudmersive_cdr_api_client.rest import ApiException\r\nfrom pprint import pprint\r\n\r\n# Configure API key authorization: Apikey\r\nconfiguration = cloudmersive_cdr_api_client.Configuration()\r\nconfiguration.api_key['Apikey'] = 'YOUR_API_KEY'\r\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\r\n# configuration.api_key_prefix['Apikey'] = 'Bearer'\r\n\r\n# create an instance of the API class\r\napi_instance = cloudmersive_cdr_api_client.FileSanitizationApi(cloudmersive_cdr_api_client.ApiClient(configuration))\r\ninput_file = '/path/to/file.txt' # file | Input document, or photos of a document, to extract data from (optional)\r\n\r\ntry:\r\n # Complete Content Disarm and Reconstruction on an Input File, and output in same file format\r\n api_instance.file(input_file=input_file)\r\nexcept ApiException as e:\r\n print(\"Exception when calling FileSanitizationApi->file: %s\\n\" % e)\r\n\r\n```\r\n\r\n## Documentation for API Endpoints\r\n\r\nAll URIs are relative to *https://api.cloudmersive.com*\r\n\r\nClass | Method | HTTP request | Description\r\n------------ | ------------- | ------------- | -------------\r\n*FileSanitizationApi* | [**file**](docs/FileSanitizationApi.md#file) | **POST** /cdr/sanitization/file | Complete Content Disarm and Reconstruction on an Input File, and output in same file format\r\n*FileSanitizationApi* | [**file_to_pdf**](docs/FileSanitizationApi.md#file_to_pdf) | **POST** /cdr/sanitization/file/to/pdf | Complete Content Disarm and Reconstruction on an Input File with PDF/A Output\r\n\r\n\r\n## Documentation For Models\r\n\r\n\r\n\r\n## Documentation For Authorization\r\n\r\n\r\n## Apikey\r\n\r\n- **Type**: API key\r\n- **API key parameter name**: Apikey\r\n- **Location**: HTTP header\r\n\r\n\r\n## Author\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "CDR API",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://cloudmersive.com/cdr-api"
},
"split_keywords": [
"swagger",
" cdr api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9bfb4f6f65cbf656d012433aebaa4972d6a80cc99a93f74ba8d1d00e07d9b0d9",
"md5": "b5880f2382650cdb94fff715912953eb",
"sha256": "93c8237d8c0d8c2c8b4920ba7687276234fb22d1c85980ae27e1ad69ec435879"
},
"downloads": -1,
"filename": "cloudmersive_cdr_api_client-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b5880f2382650cdb94fff715912953eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19307,
"upload_time": "2025-08-29T05:09:24",
"upload_time_iso_8601": "2025-08-29T05:09:24.500324Z",
"url": "https://files.pythonhosted.org/packages/9b/fb/4f6f65cbf656d012433aebaa4972d6a80cc99a93f74ba8d1d00e07d9b0d9/cloudmersive_cdr_api_client-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 05:09:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cloudmersive-cdr-api-client"
}
JSON