### Get List Folder API Request Example

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/7

This snippet demonstrates how to make a GET request to the 'Get List Folder' API endpoint. It includes query parameters for filtering by 'is_local' and for pagination ('page', 'limit'). The URL structure and common parameters are illustrated.

```http
GET http://127.0.0.1:2222/v1/folder/list?is_local=false&page=1&limit=10
```

--------------------------------

### Example Profile Response Object

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/6

A successful JSON response containing detailed profile information, including configuration, proxy settings, and timestamps. The structure is consistent for both local and cloud profiles.

```json
{
    "type": "success",
    "title": "Request successfully.",
    "content": {
        "uuid": "99801eb6-41c0-4f94-a3f7-f14d2886f594",
        "name": "Xander Crist I [3]",
        "config": {
            "name": "Xander Crist I [3]",
            "version": 112,
            "os": "win",
            "browser_type": "hidemium",
            "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.5615.121 Safari/537.36",
            "osVersion": "Windows NT 10.0; Win64; x64",
            "browserVersion": "112.0.5615.121",
            "Resolution": {
                "width": 1920,
                "height": 1080,
                "pixelRatio": 2
            },
            "canvas": "noise",
            "WebGLImage": true,
            "WebGLMeta": true,
            "clientRectsEnable": false,
            "WebGLMetadataVendor": "Google Inc. (NVIDIA)",
            "WebGLMetadataRenderer": "ANGLE (NVIDIA, NVIDIA GeForce GTX 1070 Ti Direct3D11 vs_5_0 ps_5_0, D3D11-27.21.14.5671)",
            "languages": "en-US,en;q=0.9",
            "mediaDevices": true,
            "timezone": "Asia/Bangkok"
        },
        "proxy": "",
        "created_at": "2023-06-26T04:58:23.000000Z",
        "created_at_diff": "1 day ago",
        "note": "",
        "last_open": null,
        "last_open_diff": null,
        "status": null,
        "status_chil": 0,
        "tags": []
    }
}
```

--------------------------------

### Example Request to List Status Profiles (HTTP)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/3

This snippet shows an example HTTP GET request to retrieve a list of status profiles. The 'is_local' query parameter can be used to filter results between cloud and local profiles. The response is a JSON array of status objects.

```HTTP
GET http://127.0.0.1:2222/v2/status-profile?is_local=true
```

--------------------------------

### Open Profile API Request Example

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/1

Demonstrates how to make a GET request to the openProfile API endpoint. It includes essential parameters like the profile's UUID and optional command-line arguments and proxy configurations. The proxy parameter supports multiple types like HTTP, SOCKS5, SOCKS4, and SSH, with specific formatting requirements.

```http
GET http://127.0.0.1:2222/openProfile?uuid=22387ee6-7386-4710-815c-d47d03a69f58&command=--window-position=500,500 --window-size=1280,800&proxy=HTTP|117.7.228.236|60001|E9Jr0ZzaPQD8|0vBZs1uroVnm
```

--------------------------------

### Example Response for List Version

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/5

This is an example of the JSON response received when requesting a list of browser versions. It details the available versions for Windows ('win'), Linux ('lin'), Android ('android'), and macOS ('mac').

```json
{
    "win": [
        "115.0.5790.32",
        "114.0.5735.61"
    ],
    "lin": [
        "115.0.5790.32",
        "114.0.5735.90"
    ],
    "android": [
        "115.0.5790.32",
        "114.0.5735.196"
    ],
    "mac": [
        "115.0.5790.3",
        "114.0.5735.90"
    ]
}
```

--------------------------------

### Grant execute permissions to Hidemium4 configuration directory

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/installation-guide-for-hidemium4-on-macos

This command recursively grants execute permissions to the Hidemium4 configuration directory, typically located in the user's home directory. This is necessary for machines that have previously had Hidemium 4 installed and ensures the application can access and execute its configuration files. The command requires replacing 'ten_may' with the actual username.

```bash
chmod -R +x /Users/ten_may/.hidemium_4
```

--------------------------------

### Hidemium Ports to Protect Configuration Example

Source: https://docs.hidemium.io/hidemium-4/v.-tai-lieu-nang-cao-and-nghien-cuu/tin-tuc-va-bai-viet-ve-antidetect/nguyen-ly-hoat-dong-ports-to-protect-cua-hidemium

This example demonstrates how to configure the 'Ports to Protect' feature in Hidemium. Users can input a comma-separated list of ports that they want to prevent systems from detecting. This is crucial for users operating on VPS environments to mask their activities.

```plaintext
Add Port that you want to protect like this: 5900,3389,2112
```

--------------------------------

### Example Response for Schedule Update

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/update-schedule-status

This is an example of a successful response when updating a schedule's status. It confirms the operation was completed successfully.

```json
{
    "message": "Update schedule success!!!"
}
```

--------------------------------

### Example Close Profile Response

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/2

This is an example JSON response indicating the successful closure of a profile. It confirms the operation's outcome.

```json
{
    "result": true
}
```

--------------------------------

### Example API Response for Opening Profile

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/1

Illustrates a successful JSON response from the openProfile API. The response includes the status of the operation, remote port, the local path to the profile directory, and the execution path of the browser used to open the profile.

```json
{
    "status": "successfully",
    "data": {
        "remote_port": 4000,
        "profile_path": "C:\\Users\\*****\\AppData\\Local\\Temp\\.hidemium\\99bed28d-7d71-432e-87c8-71d24926acb3",
        "execute_path": "C:\\Users\\*****\\.hidemium\\browser\\mulbrowser\\115.0.0.0_v6\\chrome.exe"
    }
}
```

--------------------------------

### GET /v2/default-config

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/2

Retrieves a list of default configurations. You can specify the page number, the number of items per page, and filter by configuration type (creation or purchase).

```APIDOC
## GET /v2/default-config

### Description
Retrieves a list of default configurations. Supports pagination and filtering by type.

### Method
GET

### Endpoint
/v2/default-config

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of items to return per page. Defaults to 10.
- **type** (string) - Optional - Filters the results. Accepts 'create' for creation configurations or 'order' for purchase configurations. If not provided, both types are returned.

### Request Example
```json
{
  "example": "GET /v2/default-config?page=1&limit=10&type=create"
}
```

### Response
#### Success Response (200)
- **Array of Objects** - Each object represents a default configuration with details like id, name, isDefault, config, and created_at.

#### Response Example
```json
[
    {
        "id": 433,
        "name": "1",
        "isDefault": true,
        "config": {
            "os": [
                "win",
                "mac",
                "lin",
                "android"
            ],
            "browser": [
                "chrome"
            ],
            "name": "1",
            "id": 433,
            "StartUrl": null
        },
        "created_at": "2024-01-08T01:19:37.000000Z"
    },
    {
        "id": 427,
        "name": "3 browser",
        "isDefault": false,
        "config": {
            "browser": [
                "chrome",
                "edge",
                "opera"
            ],
            "name": "3 browser",
            "profileName": "fgh",
            "id": 427,
            "StartUrl": null
        },
        "created_at": "2024-01-06T04:49:52.000000Z"
    }
]
```
```

--------------------------------

### GET /v2/browser/get-list-version

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/5

Retrieves a list of tag versions for various operating systems.

```APIDOC
## GET /v2/browser/get-list-version

### Description
Returns a list of tag versions available for different operating systems.

### Method
GET

### Endpoint
/v2/browser/get-list-version

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET http://127.0.0.1:2222/v2/browser/get-list-version
```

### Response
#### Success Response (200)
- **win** (array[string]) - List of tag versions for Windows.
- **lin** (array[string]) - List of tag versions for Linux.
- **android** (array[string]) - List of tag versions for Android.
- **mac** (array[string]) - List of tag versions for macOS.

#### Response Example
```json
{
    "win": [
        "115.0.5790.32",
        "114.0.5735.61"
    ],
    "lin": [
        "115.0.5790.32",
        "114.0.5735.90"
    ],
    "android": [
        "115.0.5790.32",
        "114.0.5735.196"
    ],
    "mac": [
        "115.0.5790.3",
        "114.0.5735.90"
    ]
}
```
```

--------------------------------

### Get Profile by UUID - API Request

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/6

Example GET request to retrieve profile information using a UUID. The `is_local` parameter filters between cloud and local profiles.

```http
GET http://localhost:2222/v2/browser/get-profile-by-uuid/734e3202-4840-4507-a980-143d6f18eade?is_local=false
```

--------------------------------

### GET /v1/folder/list

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/7

Retrieves a list of folders. You can specify whether to list local or cloud profiles and control the pagination with page and limit parameters.

```APIDOC
## GET /v1/folder/list

### Description
Returns a list of your folders. You can filter by local or cloud profiles and paginate the results.

### Method
GET

### Endpoint
`/v1/folder/list`

### Parameters
#### Query Parameters
- **is_local** (boolean) - Optional - `true` to show local profiles, `false` to show cloud profiles.
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of items to return per page. Defaults to 10.

### Request Example
```json
{
  "example": "GET /v1/folder/list?is_local=false&page=1&limit=10"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the folder.
- **uuid** (string) - The universally unique identifier of the folder.
- **name** (string) - The name of the folder.
- **total_browser** (integer) - The total number of browsers associated with the folder.
- **created_at** (string) - The timestamp when the folder was created (ISO 8601 format).
- **created_at_diff** (string) - A human-readable difference string indicating when the folder was created (e.g., '18 hours ago').

#### Response Example
```json
{
  "example": [
    {
        "id": 598,
        "uuid": "9a7dc6b9-b088-49c4-9030-e28298f9bfa1",
        "name": "Facebook",
        "total_browser": 10,
        "created_at": "2023-10-30T07:12:36.000000Z",
        "created_at_diff": "18 hours ago"
    },
    {
        "id": 602,
        "uuid": "9a7f52ac-e791-4915-9912-d1c93c8c2556",
        "name": "Youtube",
        "total_browser": 10,
        "created_at": "2023-10-31T01:39:45.000000Z",
        "created_at_diff": "1 minute ago"
    }
  ]
}
```
```

--------------------------------

### JSON Response Example 2

Source: https://docs.hidemium.io/hidemium-4/iv.-tu-dong-hoa-automation-and-ai/automation-foundation-automation-co-ban/data/http

This JSON snippet shows a more complex API response with a 'status' field and a 'data' array containing user objects. Each user object includes 'id', 'email', 'first_name', and 'last_name'. This example is used to demonstrate accessing nested data.

```json
{
    "status": "success",
    "data": [
        {
            "id": 7,
            "email": "michael.lawson@gmail.com.",
            "first_name": "Michael",
            "last_name": "Lawson"
        },
        {
            "id": 8,
            "email": "lindsay.ferguson@gmail.com",
            "first_name": "Lindsay",
            "last_name": "Ferguson"
        },
        {
            "id": 9,
            "email": "tobias.funke@gmail.com",
            "first_name": "Tobias",
            "last_name": "Funke"
        }
    ]
    
}
```

--------------------------------

### GET /automation/campaign

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/get-campaign

Retrieves a list of campaigns. Supports filtering by name, pagination, and limiting results.

```APIDOC
## GET /automation/campaign

### Description
Returns a list of campaigns. You can search for a specific campaign by name, or retrieve all campaigns if the search parameter is left blank. Supports pagination and limiting the number of results per page.

### Method
GET

### Endpoint
/automation/campaign

### Parameters
#### Query Parameters
- **search** (string) - Optional - Enter the name of the campaign you want to get the ID from, if left blank it will display all.
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of results to return per page. Defaults to 10.

### Request Example
```json
{
  "example": "GET /automation/campaign?search=&page=1&limit=10"
}
```

### Response
#### Success Response (200)
- **campaign** (array) - A list of campaign objects.

#### Response Example
```json
{
 "campaign":[
 //content
 ]
 }
```
```

--------------------------------

### List Tags API Request (HTTP)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/4

An example HTTP GET request to the /v2/tag endpoint to retrieve a list of tags. The 'is_local' query parameter can be used to filter results, showing either cloud or local profiles.

```http
GET http://127.0.0.1:2222/v2/tag?is_local=true
```

--------------------------------

### API Automation V4 - Get Profile

Source: https://docs.hidemium.io/hidemium-4/index

Endpoints for retrieving information about Hidemium profiles.

```APIDOC
## Get Profile Information

### Description
Endpoints for retrieving lists of profiles, default configurations, statuses, tags, versions, and individual profile details by UUID.

### Method
GET

### Endpoint
/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile

### Parameters
#### Path Parameters
None

#### Query Parameters
- **type** (string) - Optional - Specifies the type of information to retrieve (e.g., "list_profile", "list_config_default", "list_status", "list_tag", "list_version", "get_profile_by_uuid", "get_list_folder").
- **uuid** (string) - Optional - The UUID of the profile to retrieve (used with "get_profile_by_uuid").

### Request Example
```json
{
  "type": "list_profile"
}
```

### Response
#### Success Response (200)
- **data** (array) - A list of relevant items based on the requested type.

#### Response Example
```json
{
  "data": [
    {
      "uuid": "example-uuid-123",
      "name": "My Profile"
    }
  ]
}
```
```

--------------------------------

### Create Profile with Custom Settings (JSON)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/interact-profile/2

This JSON object defines the parameters for creating a new profile with specific customizations. It includes settings for the operating system, browser, version, canvas fingerprinting, WebGL, audio context, client rects, language, device memory, hardware concurrency, resolution, start URL, and command-line arguments. Ensure the 'osVersion' matches the valid versions listed for the selected 'os'.

```json
{
  "os": "mac",  // win, mac, lin. android, ios
  "osVersion": "10", //Verison list in description. Local: available for version 2512+
  "browser": "chrome", //chrome,edge,opera,brave,yandex,safari,operagx,chromium
  "version": "136",
  "userAgent": "",
  "canvas": "noise",   //noise   off   noise-e  perfect  noise-brave
  "webGLImage": "false",   // true   false 
  "audioContext": "false",   // true   false 
  "webGLMetadata": "false",    // true   false 
  "webGLVendor":"",
  "webGLMetadataRenderer":"",
  "clientRectsEnable": "false",   // true   false 
  "noiseFont": "false",     // true   false 
  "language": "vi-VN",
  "deviceMemory":4,  // If you want to randomize this value, please comment out this line.
  "hardwareConcurrency":32,     // number , only 2 to 56. If you want to randomize this value, please comment out this line.
  "resolution":"1280x800",
  //"portsToProtect": "1111",
  "StartURL": "https://hidemium.io/",
   //"proxy": "HTTP|host|port|user|password", //type includes: HTTP, SSH, SOCKS5, SOCKS4. Type must be uppercase
  //"disableAutofillPopup": "true",  //true false 
  //"disableWebsiteClipboardAccess" : "off", // off|allow|block
  "command":"--lang=vi"
  "name" : "Test amazon book", // profile name
  //"checkname" : true //true|false Add condition to check duplicate name when creating
   "folder_name" : "ten folder" //check if there is then use that folder otherwise will create
   //"cookies" : [] //cookie array
}
```

--------------------------------

### Get Campaign List (HTTP GET)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/get-campaign

This snippet demonstrates how to make an HTTP GET request to retrieve a list of campaigns. It supports filtering by campaign name, pagination, and limiting the number of results. The response will contain a JSON object with a 'campaign' key holding an array of campaign objects.

```HTTP
GET http://localhost:2222/automation/campaign?search=&page=1&limit=10
```

--------------------------------

### API Automation V4 - Get Profile

Source: https://docs.hidemium.io/hidemium-4/i

Endpoints for retrieving information about browser profiles.

```APIDOC
## GET /get-profile/list

### Description
Retrieves a list of all available browser profiles.

### Method
GET

### Endpoint
/get-profile/list

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **profiles** (array) - A list of profile objects, each containing profile details.

#### Response Example
```json
{
  "profiles": [
    {
      "uuid": "profile-uuid-1",
      "name": "Profile 1"
    },
    {
      "uuid": "profile-uuid-2",
      "name": "Profile 2"
    }
  ]
}
```

## GET /get-profile/config-default

### Description
Retrieves the default configuration settings for new profiles.

### Method
GET

### Endpoint
/get-profile/config-default

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **config** (object) - An object containing default configuration parameters.

#### Response Example
```json
{
  "config": {
    "user_agent": "Mozilla/5.0 ...",
    "platform": "Windows"
  }
}
```

## GET /get-profile/status

### Description
Retrieves the status of all browser profiles.

### Method
GET

### Endpoint
/get-profile/status

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **statuses** (object) - An object mapping profile UUIDs to their current status.

#### Response Example
```json
{
  "statuses": {
    "profile-uuid-1": "active",
    "profile-uuid-2": "inactive"
  }
}
```

## GET /get-profile/tag

### Description
Retrieves a list of all tags used across profiles.

### Method
GET

### Endpoint
/get-profile/tag

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **tags** (array) - A list of available tags.

#### Response Example
```json
{
  "tags": [
    "important",
    "testing"
  ]
}
```

## GET /get-profile/version

### Description
Retrieves the current version of Hidemium.

### Method
GET

### Endpoint
/get-profile/version

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **version** (string) - The Hidemium version number.

#### Response Example
```json
{
  "version": "4.0.0"
}
```

## GET /get-profile/by-uuid/{profile_uuid}

### Description
Retrieves detailed information for a specific browser profile using its UUID.

### Method
GET

### Endpoint
/get-profile/by-uuid/{profile_uuid}

### Parameters
#### Path Parameters
- **profile_uuid** (string) - Required - The unique identifier of the profile.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **profile** (object) - An object containing detailed information about the profile.

#### Response Example
```json
{
  "profile": {
    "uuid": "profile-uuid-1",
    "name": "Profile 1",
    "fingerprint": "...",
    "status": "active"
  }
}
```

## GET /get-profile/list-folder

### Description
Retrieves a list of all folders used for organizing profiles.

### Method
GET

### Endpoint
/get-profile/list-folder

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **folders** (array) - A list of folder objects, each containing folder details.

#### Response Example
```json
{
  "folders": [
    {
      "id": "folder-id-1",
      "name": "My Folder"
    }
  ]
}
```
```

--------------------------------

### Example WebSocket Requests for Port Scanning

Source: https://docs.hidemium.io/hidemium-4/v.-tai-lieu-nang-cao-and-nghien-cuu/tin-tuc-va-bai-viet-ve-antidetect/nguyen-ly-hoat-dong-ports-to-protect-cua-hidemium

This snippet shows example WebSocket requests observed during a port scan on eBay's 'Create Account' page. These requests indicate the ports being checked by the system to identify running services and potential malicious activity. The ports listed are commonly associated with remote access and virtual machine services.

```plaintext
wss://127.0.0.1:5900/
wss://127.0.0.1:63333/
wss://127.0.0.1:5901/
wss://127.0.0.1:3389/
wss://127.0.0.1:5903/
wss://127.0.0.1:5902/
wss://127.0.0.1:5950/
wss://127.0.0.1:5931/
wss://127.0.0.1:5944/
wss://127.0.0.1:6040/
wss://127.0.0.1:5939/
wss://127.0.0.1:5938/
wss://127.0.0.1:6039/
wss://127.0.0.1:5279/
wss://127.0.0.1:2112/
wss://127.0.0.1:7070/
```

--------------------------------

### GET /automation/schedule

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/get-schedule

Retrieves a list of schedules associated with a specific campaign, with options for pagination.

```APIDOC
## GET /automation/schedule

### Description
Returns a list of schedules in a campaign. Allows filtering by campaign ID and pagination.

### Method
GET

### Endpoint
/automation/schedule

### Parameters
#### Query Parameters
- **campaign_id** (integer) - Required - The ID of the campaign for which to retrieve schedules.
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - The number of schedules to return per page. Defaults to 10.

### Request Example
```json
{
  "example": "GET http://localhost:2222/automation/schedule?campaign_id=25&page=1&limit=10"
}
```

### Response
#### Success Response (200)
- **schedule** (array) - A list of schedule objects.

#### Response Example
```json
{
  "schedule": [
    // schedule objects will be listed here
  ]
}
```
```

--------------------------------

### List Scripts API Request (Hidemium V4)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/automation/list-scripts

Demonstrates how to make a GET request to the Hidemium V4 API to retrieve a paginated list of scripts. The request includes query parameters for page number and limit. No specific client libraries are required, as it's a standard HTTP request.

```HTTP
GET http://127.0.0.1:2222/v2/automation/script?page=1&limit=10
```

--------------------------------

### List Browser Versions (HTTP GET)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/5

This snippet shows how to make an HTTP GET request to the /v2/browser/get-list-version endpoint to retrieve a list of available browser versions. The response is a JSON object where keys are operating system identifiers (e.g., 'win', 'lin', 'android', 'mac') and values are arrays of version strings.

```http
GET http://127.0.0.1:2222/v2/browser/get-list-version
```

--------------------------------

### GET /v2/browser/get-profile-by-uuid/{uuid}

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/6

Retrieves profile information for a given UUID. Supports filtering between local and cloud profiles.

```APIDOC
## GET /v2/browser/get-profile-by-uuid/{uuid}

### Description
Retrieves detailed profile information associated with a specific UUID. This endpoint allows you to fetch either local or cloud profiles based on the `is_local` query parameter.

### Method
GET

### Endpoint
`/v2/browser/get-profile-by-uuid/{uuid}`

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the profile to retrieve.

#### Query Parameters
- **is_local** (boolean) - Optional - Defaults to `false`. If `true`, returns local profiles. If `false`, returns cloud profiles.

### Request Example
```json
{
  "example": "GET http://localhost:2222/v2/browser/get-profile-by-uuid/734e3202-4840-4507-a980-143d6f18eade?is_local=false"
}
```

### Response
#### Success Response (200)
- **type** (string) - Indicates the success status of the request.
- **title** (string) - A brief title describing the outcome of the request.
- **content** (object) - Contains the profile data.
  - **uuid** (string) - The profile's unique identifier.
  - **name** (string) - The name of the profile.
  - **config** (object) - Configuration details for the profile.
  - **proxy** (string) - Proxy information associated with the profile.
  - **created_at** (string) - Timestamp of when the profile was created.
  - **created_at_diff** (string) - Human-readable difference from the creation time.
  - **note** (string) - Any notes associated with the profile.
  - **last_open** (string/null) - Timestamp of the last time the profile was opened.
  - **last_open_diff** (string/null) - Human-readable difference from the last open time.
  - **status** (string/null) - Status of the profile.
  - **status_chil** (integer) - Child status indicator.
  - **tags** (array) - List of tags associated with the profile.

#### Response Example
```json
{
    "type": "success",
    "title": "Request successfully.",
    "content": {
        "uuid": "99801eb6-41c0-4f94-a3f7-f14d2886f594",
        "name": "Xander Crist I [3]",
        "config": {
            "name": "Xander Crist I [3]",
            "version": 112,
            "os": "win",
            "browser_type": "hidemium",
            "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.5615.121 Safari/537.36",
            "osVersion": "Windows NT 10.0; Win64; x64",
            "browserVersion": "112.0.5615.121",
            "Resolution": {
                "width": 1920,
                "height": 1080,
                "pixelRatio": 2
            },
            "canvas": "noise",
            "WebGLImage": true,
            "WebGLMeta": true,
            "clientRectsEnable": false,
            "WebGLMetadataVendor": "Google Inc. (NVIDIA)",
            "WebGLMetadataRenderer": "ANGLE (NVIDIA, NVIDIA GeForce GTX 1070 Ti Direct3D11 vs_5_0 ps_5_0, D3D11-27.21.14.5671)",
            "languages": "en-US,en;q=0.9",
            "mediaDevices": true,
            "timezone": "Asia/Bangkok"
        },
        "proxy": "",
        "created_at": "2023-06-26T04:58:23.000000Z",
        "created_at_diff": "1 day ago",
        "note": "",
        "last_open": null,
        "last_open_diff": null,
        "status": null,
        "status_chil": 0,
        "tags": []
    }
}
```
```

--------------------------------

### GET /v2/automation/script

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/automation/list-scripts

Retrieves a paginated list of scripts (workflows) available in the system. You can control the page number and the number of items per page.

```APIDOC
## GET /v2/automation/script

### Description
Returns a list of scripts (workflows).

### Method
GET

### Endpoint
/v2/automation/script

### Query Parameters
- **page** (integer) - Optional - The page number of the results to retrieve.
- **limit** (integer) - Optional - The maximum number of items to return per page.

### Request Example
```json
{
  "example": "GET http://127.0.0.1:2222/v2/automation/script?page=1&limit=10"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the response details.
  - **type** (string) - Indicates the status of the request (e.g., "success").
  - **title** (string) - A brief message about the request status (e.g., "Request successfully.").
  - **content** (array) - An array containing the script data. The exact structure of items in this array is not detailed here.

#### Response Example
```json
{
  "data": {
    "type": "success",
    "title": "Request successfully.",
    "content": [
      //content information 
    ]
  }
}
```
```

--------------------------------

### Schedule Campaign Creation (JSON Body)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/create-schedule

Defines the structure for scheduling a campaign execution. It requires a campaign ID, execution frequency, start time, and task type. Optional parameters like interval time, execution time, and day can be included based on the frequency.

```json
{
    "name": "Run Campaign - Reg Etsy Bằng Gmail",
    "campaign_id": 25, //Enter the campaign ID, use the get campaign API to get the ID
    "execution_frequency": 1, // Once = 1, Interval = 2, Daily = 3, Weekly = 4, Monthly = 5, 
   // "interval_time": 60, // for interval
    //"execute_time": "10:59", // for Daily, Weekly, Monthly
   // "execute_day": 0, // for Weekly 0->6 : Sunday -> Saturday
    //"execute_day": "4" // 0 -> 31 dates of month
    "start_time": "2024-12-17 10:25:37",
    //"end_time": "2024-12-18 10:51:34",
    "task_type": 2, // Fixed = 2
    "isRunning": false
}
```

--------------------------------

### Example JSON Response for Campaign Deletion

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/delete-campaign

This snippet shows the expected JSON response when a campaign deletion request is successful. It includes a confirmation message.

```JSON
{
    "message": "Campaign deleted"
}
```

--------------------------------

### GET /openProfile

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/1

Retrieves and opens a user profile based on the provided UUID. This endpoint allows for optional command and proxy parameters to customize the profile opening behavior.

```APIDOC
## GET /openProfile

### Description
Returns an open profile associated with the given UUID. It supports additional parameters to specify commands and proxy configurations.

### Method
GET

### Endpoint
api_url/openProfile?uuid={uuid}

### Parameters
#### Query Parameters
- **uuid** (string) - Required - The unique identifier for the profile to be opened.
- **command** (string) - Optional - A command string to be executed when the profile opens. This can include window size and position settings.
- **proxy** (string) - Optional - Proxy configuration string. Format: `TYPE|IP|PORT|USERNAME|PASSWORD`. Supported types include HTTP, SOCKS5, SOCKS4, SSH. The type must be uppercase.

### Request Example
```json
{
  "example": "GET http://127.0.0.1:2222/openProfile?uuid=22387ee6-7386-4710-815c-d47d03a69f58&command=--window-position=500,500 --window-size=1280,800&proxy=HTTP|117.7.228.236|60001|E9Jr0ZzaPQD8|0vBZs1uroVnm"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success status of the operation. Example: "successfully".
- **data** (object) - Contains details about the opened profile.
  - **remote_port** (integer) - The remote port associated with the profile.
  - **profile_path** (string) - The file system path to the opened profile.
  - **execute_path** (string) - The execution path of the browser or application used to open the profile.

#### Response Example
```json
{
  "status": "successfully",
  "data": {
    "remote_port": 4000,
    "profile_path": "C:\\Users\\*****\\AppData\\Local\\Temp\\.hidemium\\99bed28d-7d71-432e-87c8-71d24926acb3",
    "execute_path": "C:\\Users\\*****\\.hidemium\\browser\\mulbrowser\\115.0.0.0_v6\\chrome.exe"
  }
}
```
```

--------------------------------

### Delete Schedule Response - JSON Example

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/campaign/delete-schedule

This snippet illustrates a successful response after executing the delete schedule request. It confirms the deletion with a success message.

```json
{
    "message": "Delete success"
}
```

--------------------------------

### GET /authorize

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/3

Retrieves the status of a profile, indicating whether it is open or closed.

```APIDOC
## GET /authorize

### Description
Retrieves the status of a profile, indicating whether it is open or closed.

### Method
GET

### Endpoint
api_url/authorize?uuid={uuid}

### Parameters
#### Query Parameters
- **uuid** (string) - Required - UUID of the profile to check.

### Request Example
```json
{
  "example": "http://127.0.0.1:2222/authorize?uuid=992bd6f1-0a4c-40b2-88c0-d6ae54db7347"
}
```

### Response
#### Success Response (200)
- **status** (boolean) - True if the profile is open, false if the profile is closed.

#### Response Example
```json
{
    "status": true
}
```
```

--------------------------------

### Delete Profile Response Example

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/interact-profile/8

Shows a successful response after a profile deletion request. The 'type' field indicates success, and the 'title' provides a confirmation message. An empty 'content' array suggests no additional data is returned upon successful deletion.

```json
{
    "type": "success",
    "title": "Delete successfully.",
    "content": []
}
```

--------------------------------

### List Tags API Response (JSON)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/4

Example JSON response structure for the /v2/tag API endpoint. Each tag object contains a 'value' (numeric ID) and a 'label' (string name).

```json
[
    {
        "value": 132,
        "label": "tag 1"
    },
    {
        "value": 136,
        "label": "tag 2"
    },
    {
        "value": 137,
        "label": "tag 3"
    },
    {
        "value": 138,
        "label": "tag 4"
    }
]
```

--------------------------------

### GET /v2/status-profile

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/get-profile/3

Retrieves a list of status profiles. This endpoint supports filtering to display either local or cloud-based profiles.

```APIDOC
## GET /v2/status-profile

### Description
Returns a list of status profiles. You can specify whether to show local or cloud profiles.

### Method
GET

### Endpoint
/v2/status-profile

### Parameters
#### Query Parameters
- **is_local** (boolean) - Required - Determines whether to show local profiles (`true`) or cloud profiles (`false`).

### Request Example
```json
{
  "example": "GET http://127.0.0.1:2222/v2/status-profile?is_local=true"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the status profile.
- **name** (string) - The name of the status profile.
- **color** (string) - A color code associated with the status profile.

#### Response Example
```json
[
    {
        "id": 58,
        "name": "12345",
        "color": "btn-outline-purple"
    },
    {
        "id": 59,
        "name": "hahaha",
        "color": "btn-outline-warning"
    },
    {
        "id": 65,
        "name": "red",
        "color": "btn-outline-secondary"
    },
    {
        "id": 70,
        "name": "blue",
        "color": "btn-outline-primary"
    },
    {
        "id": 71,
        "name": "green",
        "color": "btn-outline-primary"
    }
]
```
```

--------------------------------

### Example API Response for Profile Status

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/3

This code block shows the expected JSON response from the Hidemium API when checking a profile's status. A 'status' field with a boolean value indicates if the profile is open (true) or closed (false).

```JSON
{
    "status": true
}
```

--------------------------------

### POST /v1/folder/{folder_uuid}/add-browser

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/interact-profile/9

Adds a browser profile to a specified folder. You can obtain the `folder_uuid` from the 'Get List Folder' API.

```APIDOC
## POST /v1/folder/{folder_uuid}/add-browser

### Description
Adds a browser profile to a specified folder. The `folder_uuid` can be obtained from the 'Get List Folder' API.

### Method
POST

### Endpoint
`http://localhost:2222/v1/folder/{folder_uuid}/add-browser?is_local=true`

### Parameters
#### Path Parameters
- **folder_uuid** (string) - Required - The unique identifier for the folder.

#### Query Parameters
- **is_local** (boolean) - Optional - If `true`, adds local profiles; if `false`, adds cloud profiles.

#### Request Body
- **uuid_browser** (array of strings) - Required - A list of browser UUIDs to add to the folder.

### Request Example
```json
{
    "uuid_browser": [
        "local-67b14672-c02d-4be0-9eb1-580d8e7edf47"
    ]
}
```

### Response
#### Success Response (200)
- **title** (string) - A success message indicating the profiles were added.
- **type** (string) - The status type of the operation, expected to be 'success'.

#### Response Example
```json
{
    "title": "Add browser to folder successfully!",
    "type": "success"
}
```
```

--------------------------------

### Add Browser to Folder Request (Example Body)

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/interact-profile/9

This snippet demonstrates the JSON structure for the request body when adding a browser profile to a folder. It specifies the 'uuid_browser' which is an array containing the identifier of the browser profile to be added.

```json
{
    "uuid_browser": [
        "local-67b14672-c02d-4be0-9eb1-580d8e7edf47"
    ]
}
```

--------------------------------

### Delete Profile Request Example

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/interact-profile/8

Demonstrates the structure of a DELETE request to remove profiles. The 'uuid_browser' field in the request body contains a list of profile UUIDs to be deleted. The 'is_local' query parameter determines whether to delete local or cloud profiles.

```http
DELETE /v1/browser/destroy?is_local=false HTTP/1.1
Host: 127.0.0.1:2222
Content-Type: application/json

{"uuid_browser":[
    "734c3c7a-f2fa-495e-a81c-4884d53c1aa9",
    "734c3a04-9052-4167-83bc-9f4cc06d1922"
]}
```

```json
{
    "uuid_browser":[
        "734c3c7a-f2fa-495e-a81c-4884d53c1aa9",
        "734c3a04-9052-4167-83bc-9f4cc06d1922"
      ]
}
```

--------------------------------

### Check Profile Status API Request

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/api-automation-v4/remote-profile/3

This snippet demonstrates how to make a GET request to the Hidemium API to check the status of a profile. The request requires a UUID as a parameter. The response indicates whether the profile is open (true) or closed (false).

```HTTP
GET api_url/authorize?uuid={uuid}
```

--------------------------------

### Remove extended attributes from Hidemium4 app

Source: https://docs.hidemium.io/hidemium-4/i.-bat-dau-voi-hidemium/installation-guide-for-hidemium4-on-macos

This command is used to remove extended attributes from the Hidemium4 application bundle. It is essential for ensuring the app can run correctly on macOS, especially after installation or updates. This command requires no specific inputs other than the application path.

```bash
xattr -cr /Applications/Hidemium4.app
```