Proxy

This section covers the API endpoints for managing proxy configurations in the admin panel.

List Proxies

GET /v1/admin/proxies

Returns a list of all proxy configurations.

Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": [
        {
            "id": "103c8a70-bcd0-11ed-812c-019857032f1c",
            "name": "scrapingbee Freelance Subscription",
            "proxy": "MTPDHEXZDCT81D5UIYW1LM86LBI1SEQ1JCRAQ2T5Z8KETGZ8PEWG2YQ0V07205CBOE41D7HZ60PKYHFE:render_js=false@proxy.scrapingbee.com:8887",
            "protocol": "HTTPS",
            "created_at": "2023-03-07 10:08:52",
            "updated_at": "2023-03-07 13:12:04",
            "active": true
        }
    ],
    "status_code": 200
}

Create Proxy

POST /v1/admin/proxies

Create a new proxy configuration.

Request Body

Parameter	Type	Description
name	string	Name of the proxy (3-255 characters)
proxy	string	Proxy address (must be unique)
protocol	string	Protocol type (3-18 characters)
active	boolean	Proxy status (true/false)

Response

{
    "success": true,
    "message": "ok",
    "data": {
        "id": "74947d90-05ac-11f0-a5be-6f439b95d3a0",
        "name": "Belgium Brussels",
        "proxy": "9FL0TVB7I5RZQLALOHNF6ZZ9PIRO42Z6NNQLY3NDD79EBQO2HASZMJAY16AIJM9VKZZ9MRRUGHIC58NW@proxy.scrapingbee.com:8887",
        "protocol": "HTTPS",
        "created_at": "2025-03-20 16:57:49",
        "updated_at": "2025-03-20 16:57:49",
        "active": true
    },
    "status_code": 200
}

Show Proxy

GET /v1/admin/proxies/{id}

Retrieve details of a specific proxy configuration.

Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "id": "103c8a70-bcd0-11ed-812c-019857032f1c",
        "name": "scrapingbee Freelance Subscription",
        "proxy": "MTPDHEXZDCT81D5UIYW1LM86LBI1SEQ1JCRAQ2T5Z8KETGZ8PEWG2YQ0V07205CBOE41D7HZ60PKYHFE:render_js=false@proxy.scrapingbee.com:8887",
        "protocol": "HTTPS",
        "created_at": "2023-03-07 10:08:52",
        "updated_at": "2023-03-07 13:12:04",
        "active": true
    },
    "status_code": 200
}

Update Proxy

PATCH /v1/admin/proxies/{id}

Update an existing proxy configuration.

Request Body

Parameter	Type	Description
name	string	Name of the proxy (3-255 characters)
proxy	string	Proxy address
protocol	string	Protocol type (3-18 characters)
active	boolean	Proxy status (true/false)

Response

{
    "success": true,
    "message": "تم تحديث البيانات بنجاح.",
    "data": {
        "id": "60df038d-9273-4f8b-a2e6-bdf961a445e8",
        "name": "Updated Proxy",
        "proxy": "192.168.1.100:8080",
        "protocol": "http",
        "active": true,
        "created_at": "2023-01-01 12:00:00",
        "updated_at": "2023-01-01 12:30:00"
    },
    "status_code": 200
}

Delete Proxy

DELETE /v1/admin/proxies

Delete an existing proxy configuration.

Request Body

Parameter	Type	Description
ids	array	Array of proxy UUIDs to delete

Response

{
    "success": true,
    "message": "تم حذف البيانات بنجاح.",
    "data": null,
    "status_code": 200
}

Authorization

All proxy endpoints require admin authorization. The user must have the appropriate permissions to perform these operations.

Notes

• The proxy address must be unique in the system
• The protocol field typically accepts values like 'http', 'https', 'socks5'
• Active status determines if the proxy is currently in use