Blurit On-Premise Documentation
1.0.0
1.0.0
  • Blurit On-Premise
    • 🚀Getting started
    • 💻Requirements
    • 🖊️Installation
      • Linux dependencies
      • Windows dependencies (WSL)
      • Configuration
      • Run BlurIt OP
      • Multi-servers installation
      • Post installation verifications
    • 🎇Usage
      • Manager Webapp
      • API
        • License
        • Tasks
          • Process a directory
          • Process a file
          • Get the status of a task
    • Version notes
Powered by GitBook
On this page
  1. Blurit On-Premise
  2. Usage

API

PreviousManager WebappNextLicense

The BlurIt OP API offers several functionalities. It allows you to obtain the current license by using the GET method on the endpoint. Additionally, you can add a new license by using the POST method on the same endpoint. If a license already exists, it will be replaced by the new license.

Furthermore, the API provides the capability to add a blur task to the queue by using the POST method on the endpoint. You can also add a blur task for a directory by using the POST method on the endpoint.

Moreover, the API allows you to retrieve the status of a task by using the GET method on the endpoint, where "task_id" is the task identifier.

The API documentation can be found at http://<HOST>:<API_PORT>/docs, where HOST is the IP address of the machine, and API_PORT is the value configured in the section (default value is 8080).

🎇
/api/license
/api/blur_it
/api/blur_it/directory
/api/task/{task_id}
Configuration

License

Blur it

Blur it directory

Task