### Configure DNS Provider

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Sets up the DNS provider with credentials and domain. Supported providers include Cloudflare, Netlify, DigitalOcean, and Porkbun.

```bash
# Cloudflare
curl -X POST http://localhost:4949/api/settings/dns \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "cloudflare",
    "config": {
      "token": "your-cloudflare-api-token",
      "zoneId": "your-zone-id",
      "domain": "example.com"
    }
  }'

# Netlify
curl -X POST http://localhost:4949/api/settings/dns \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "netlify",
    "config": {
      "token": "your-netlify-token",
      "zoneId": "your-dns-zone-id",
      "domain": "example.com"
    }
  }'

# DigitalOcean
curl -X POST http://localhost:4949/api/settings/dns \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "digitalocean",
    "config": {
      "token": "your-do-token",
      "domain": "example.com"
    }
  }'

# Porkbun
curl -X POST http://localhost:4949/api/settings/dns \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "porkbun",
    "config": {
      "apiKey": "your-api-key",
      "secretKey": "your-secret-key",
      "domain": "example.com"
    }
  }'
```

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

### POST /api/settings/dns

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Sets up the DNS provider with credentials and domain.

```APIDOC
## POST /api/settings/dns

### Description
Sets up the DNS provider with credentials and domain.

### Method
POST

### Endpoint
/api/settings/dns

### Request Body
- **provider** (string) - Required - The DNS provider (cloudflare, netlify, digitalocean, or porkbun)
- **config** (object) - Required - Provider-specific configuration credentials

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful
- **validation** (object) - Validation status
```

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

### POST /api/settings/proxy

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Sets up the reverse proxy provider (NPM or Caddy).

```APIDOC
## POST /api/settings/proxy

### Description
Sets up the reverse proxy provider (NPM or Caddy).

### Method
POST

### Endpoint
/api/settings/proxy

### Request Body
- **provider** (string) - Required - The proxy provider (npm or caddy)
- **config** (object) - Required - Provider-specific configuration (url, username, password)

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful
- **validation** (object) - Validation status
```

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

### Configure Proxy Provider

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Sets up the reverse proxy provider, supporting Nginx Proxy Manager (NPM) or Caddy.

```bash
# Nginx Proxy Manager
curl -X POST http://localhost:4949/api/settings/proxy \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "npm",
    "config": {
      "url": "http://192.168.1.50:81",
      "username": "admin@example.com",
      "password": "your-npm-password"
    }
  }'

# Caddy
curl -X POST http://localhost:4949/api/settings/proxy \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "caddy",
    "config": {
      "url": "http://192.168.1.50:2019"
    }
  }'
```

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

### Deploy autoxpose with Docker Compose

Source: https://github.com/mostafa-wahied/autoxpose/blob/main/README.md

Recommended deployment method using a docker-compose.yml file.

```yaml
services:
  autoxpose:
    image: mostafawahied/autoxpose:latest
    ports:
      - '4949:3000'
    environment:
      - SERVER_IP=your-public-ip
      - LAN_IP=your-lan-ip
    volumes:
      - autoxpose-data:/app/packages/backend/data
      - /var/run/docker.sock:/var/run/docker.sock:ro
    restart: unless-stopped

volumes:
  autoxpose-data:
```

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

### Deploy autoxpose with Docker Run

Source: https://github.com/mostafa-wahied/autoxpose/blob/main/README.md

Alternative deployment method using the docker run command.

```sh
docker run -d \
  --name autoxpose \
  --restart unless-stopped \
  -p 4949:3000 \
  -e SERVER_IP=your-public-ip \
  -e LAN_IP=your-lan-ip \
  -v autoxpose-data:/app/packages/backend/data \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  mostafawahied/autoxpose:latest
```

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

### Create Manual Service with autoxpose API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Creates a service entry for services not managed by Docker. Requires specifying name, subdomain, port, and scheme.

```bash
curl -X POST http://localhost:4949/api/services \
  -H "Content-Type: application/json" \
  -d '{
    "name": "external-service",
    "subdomain": "external",
    "port": 3000,
    "scheme": "http"
  }'
```

```json
{
  "service": {
    "id": "svc_new123",
    "name": "external-service",
    "subdomain": "external",
    "port": 3000,
    "scheme": "http",
    "enabled": true,
    "source": "manual"
  }
}
```

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

### Sync All Services via API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Synchronizes all services with their provider configurations using a POST request.

```bash
curl -X POST http://localhost:4949/api/services/sync/all

# Response
{ "synced": 5, "errors": [] }
```

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

### POST /api/services/expose

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Creates DNS record and proxy host for a service with automatic SSL certificate provisioning.

```APIDOC
## POST /api/services/:id/expose

### Description
Creates DNS record and proxy host for a service with automatic SSL certificate provisioning.

### Method
POST

### Endpoint
/api/services/:id/expose

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.
```

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

### Expose Service with autoxpose API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Initiates the process to expose a service by creating necessary DNS records and proxy hosts, including automatic SSL certificate provisioning.

```bash
curl -X POST http://localhost:4949/api/services/svc_abc123/expose
```

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

### Reset All Settings

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Clears all provider configurations and service records from the system.

```bash
curl -X POST http://localhost:4949/api/settings/reset
```

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

### List All Services with autoxpose API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Retrieves all managed services. Use `includeExternal=true` to also fetch services configured externally by proxy providers. The response includes detailed service information.

```bash
# Get all managed services
curl http://localhost:4949/api/services
```

```bash
# Include externally configured services from proxy provider
curl "http://localhost:4949/api/services?includeExternal=true"
```

```json
{
  "services": [
    {
      "id": "svc_abc123",
      "name": "my-app",
      "subdomain": "myapp",
      "port": 8080,
      "scheme": "http",
      "enabled": true,
      "source": "docker",
      "sourceId": "container_id_here",
      "dnsRecordId": "dns_123",
      "proxyHostId": "proxy_456",
      "exposedSubdomain": "myapp",
      "sslPending": false,
      "tags": "[\"web\",\"nodejs\"]"
    }
  ]
}
```

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

### Export/Import Settings

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Exports or imports provider configurations for backup or migration purposes.

```bash
# Export
curl http://localhost:4949/api/settings/export

# Import
curl -X POST http://localhost:4949/api/settings/import \
  -H "Content-Type: application/json" \
  -d '{
    "dns": { "provider": "cloudflare", "config": { "token": "...", "zoneId": "...", "domain": "example.com" } },
    "proxy": { "provider": "npm", "config": { "url": "...", "username": "...", "password": "..." } }
  }'
```

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

### Streaming Expose with Progress

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Exposes a service while receiving real-time progress updates via Server-Sent Events.

```bash
curl -N http://localhost:4949/api/services/svc_abc123/expose/stream
```

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

### Configure Wildcard Mode

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Enables wildcard DNS/SSL mode to skip per-service DNS record creation. Includes detection of existing certificates.

```bash
# Detect existing wildcard certificate
curl http://localhost:4949/api/settings/wildcard/detect

# Enable wildcard mode
curl -X POST http://localhost:4949/api/settings/wildcard \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "domain": "example.com"
  }'
```

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

### POST /api/services

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Creates a new service entry for manual (non-Docker) services.

```APIDOC
## POST /api/services

### Description
Creates a service entry for manual (non-Docker) services.

### Method
POST

### Endpoint
/api/services

### Parameters
#### Request Body
- **name** (string) - Required - Name of the service
- **subdomain** (string) - Required - Subdomain for the service
- **port** (integer) - Required - Port number
- **scheme** (string) - Required - Protocol scheme (e.g., http, https)

### Response
#### Success Response (200)
- **service** (object) - The created service object.
```

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

### Get Settings Status

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Returns the current configuration status for DNS, proxy, and network settings.

```bash
curl http://localhost:4949/api/settings/status
```

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

### Expose Proxy Only

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Creates a proxy host without creating a DNS record.

```bash
curl -X POST http://localhost:4949/api/services/svc_abc123/proxy-only
```

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

### POST /api/settings/dns/test and /api/settings/proxy/test

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Validates connectivity to configured providers.

```APIDOC
## POST /api/settings/dns/test
## POST /api/settings/proxy/test

### Description
Validates connectivity to configured providers.

### Method
POST

### Endpoint
/api/settings/dns/test or /api/settings/proxy/test

### Response
#### Success Response (200)
- **ok** (boolean) - Connection status
```

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

### Test Provider Connections

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Validates connectivity to the currently configured DNS or proxy providers.

```bash
# Test DNS provider
curl -X POST http://localhost:4949/api/settings/dns/test

# Test proxy provider
curl -X POST http://localhost:4949/api/settings/proxy/test
```

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

### Configure Docker Container Labels

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Defines discovery settings for containers using labels in Docker Compose or CLI.

```yaml
# docker-compose.yml
services:
  my-webapp:
    image: nginx:latest
    labels:
      # Required: Enable autoxpose discovery
      - autoxpose.enable=true        # Show in UI, manual expose
      # or
      - autoxpose.enable=auto        # Auto-expose on discovery

      # Optional: Custom subdomain (defaults to container name)
      - autoxpose.subdomain=webapp

      # Optional: Override auto-detected port
      - autoxpose.port=8080

      # Optional: Override auto-detected scheme
      - autoxpose.scheme=https

      # Optional: Custom display name
      - autoxpose.name=My Web Application
    ports:
      - "8080:80"

  database:
    image: postgres:15
    labels:
      - autoxpose.enable=true
      - autoxpose.subdomain=db
      - autoxpose.port=5432
```

```bash
# Docker CLI
docker run -d \
  --name my-app \
  --label autoxpose.enable=auto \
  --label autoxpose.subdomain=myapp \
  --label autoxpose.port=3000 \
  -p 3000:3000 \
  my-app:latest
```

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

### Expose DNS Only

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Creates a DNS record without configuring a proxy host.

```bash
curl -X POST http://localhost:4949/api/services/svc_abc123/dns-only
```

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

### Configure Docker Socket Proxy and Autoxpose Service

Source: https://github.com/mostafa-wahied/autoxpose/blob/main/README.md

This YAML configuration sets up a read-only Docker socket proxy and the Autoxpose service. It specifies environment variables for server and LAN IPs, and connects to the Docker proxy. Ensure `SERVER_IP` and `LAN_IP` are set correctly for your environment.

```yaml
services:
  docker-proxy:
    image: tecnativa/docker-socket-proxy:latest
    restart: unless-stopped
    environment:
      - CONTAINERS=1
      - EVENTS=1
      - INFO=1
      - NETWORKS=1
      - POST=0
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
    ports:
      - '2375:2375'

  autoxpose:
    image: mostafawahied/autoxpose:latest
    ports:
      - '4949:3000'
    environment:
      - SERVER_IP=203.0.113.50
      - LAN_IP=192.168.1.100
      - DOCKER_HOST=tcp://docker-proxy:2375
    volumes:
      - autoxpose-data:/app/packages/backend/data
    depends_on:
      - docker-proxy

volumes:
  autoxpose-data:
```

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

### List Proxy Hosts

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Retrieves all proxy hosts from the configured provider.

```bash
curl http://localhost:4949/api/proxy/hosts
```

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

### Scan and Sync Containers

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Triggers a full container scan and syncs with the database.

```bash
curl -X POST http://localhost:4949/api/discovery/scan
```

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

### Migrate Subdomain

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Updates DNS and proxy configurations to migrate a service to a new subdomain.

```bash
curl -X POST http://localhost:4949/api/services/svc_abc123/migrate \
  -H "Content-Type: application/json" \
  -d '{ "targetSubdomain": "newsubdomain" }'
```

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

### Export/Import Settings

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Exports or imports provider configurations for backup/migration.

```APIDOC
## GET /api/settings/export
## POST /api/settings/import

### Description
Exports or imports provider configurations.

### Method
GET / POST

### Endpoint
/api/settings/export or /api/settings/import

### Request Body (POST)
- **dns** (object) - Optional - DNS configuration
- **proxy** (object) - Optional - Proxy configuration

### Response
#### Success Response (200)
- **success** (boolean) - Operation status
```

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

### Docker CLI Labels for Autoxpose

Source: https://github.com/mostafa-wahied/autoxpose/blob/main/README.md

Use the `--label` flag with the `docker run` command to apply Autoxpose configuration labels. Note that labels cannot be added to running containers; the container must be recreated.

```sh
docker run -d \
  --name myapp \
  --label autoxpose.enable=true \
  --label autoxpose.subdomain=myapp \
  myapp:latest
```

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

### POST /api/settings/reset

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Clears all provider configurations and service records.

```APIDOC
## POST /api/settings/reset

### Description
Clears all provider configurations and service records.

### Method
POST

### Endpoint
/api/settings/reset

### Response
#### Success Response (200)
- **success** (boolean) - Operation status
- **clearedSettings** (number) - Count of cleared settings
- **clearedServices** (number) - Count of cleared services
```

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

### Sync API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Manages synchronization between autoxpose state and actual provider configurations.

```APIDOC
## GET /api/services/sync/status
## POST /api/services/sync/:serviceId

### Description
Returns sync status or triggers synchronization for a specific service.

### Method
GET / POST

### Endpoint
/api/services/sync/status or /api/services/sync/:serviceId

### Parameters
#### Path Parameters
- **serviceId** (string) - Required - The ID of the service to sync

### Response
#### Success Response (200)
- **statuses** (array) - List of sync statuses
- **synced** (boolean) - Sync completion status
```

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

### GET /api/discovery/containers

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Returns all Docker containers with autoxpose labels.

```APIDOC
## GET /api/discovery/containers

### Description
Returns all Docker containers with autoxpose labels.

### Method
GET

### Endpoint
/api/discovery/containers

### Response
#### Success Response (200)
- **containers** (array) - List of discovered containers with their configuration details.
```

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

### Probe Service Backend with autoxpose API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Tests if a service backend is responsive and attempts to auto-detect the scheme (http/https). Can probe a specific service by ID or an arbitrary host and port.

```bash
# Probe specific service
curl -X POST http://localhost:4949/api/services/svc_abc123/probe
```

```json
{
  "responsive": true,
  "detectedScheme": "https",
  "currentScheme": "http",
  "updated": true
}
```

```bash
# Probe arbitrary host:port
curl -X POST http://localhost:4949/api/services/probe \
  -H "Content-Type: application/json" \
  -d '{ "host": "192.168.1.100", "port": 8443 }'
```

```json
{ "responsive": true, "scheme": "https" }
```

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

### POST /api/services/:id/migrate

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Migrates a service to a new subdomain, updating DNS and proxy configurations.

```APIDOC
## POST /api/services/:id/migrate

### Description
Migrates a service to a new subdomain, updating DNS and proxy configurations.

### Method
POST

### Endpoint
/api/services/:id/migrate

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

#### Request Body
- **targetSubdomain** (string) - Required - The new subdomain to migrate to.

### Response
#### Success Response (200)
- **service** (object) - The updated service object.
- **oldSubdomain** (string) - The previous subdomain.
- **newSubdomain** (string) - The new subdomain.
```

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

### Configure Container Labels

Source: https://github.com/mostafa-wahied/autoxpose/blob/main/README.md

Labels to add to your Docker containers to enable autoxpose functionality.

```yaml
labels:
  - autoxpose.enable=true # or 'auto' for automatic exposure
```

```yaml
- autoxpose.subdomain=myapp # recommended
```

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

### GET /api/services

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Retrieves all registered services, with an optional flag to include externally configured services from proxy providers.

```APIDOC
## GET /api/services

### Description
Retrieves all registered services with optional external source merging from proxy providers.

### Method
GET

### Endpoint
/api/services

### Parameters
#### Query Parameters
- **includeExternal** (boolean) - Optional - If true, includes externally configured services from the proxy provider.

### Response
#### Success Response (200)
- **services** (array) - List of service objects.
```

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

### List DNS Records

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Retrieves all DNS records from the configured provider.

```bash
curl http://localhost:4949/api/dns/records
```

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

### Docker Compose Labels for Autoxpose

Source: https://github.com/mostafa-wahied/autoxpose/blob/main/README.md

Add these labels to your service definition in a docker-compose.yml file to enable and configure Autoxpose for your application. Ensure you apply changes using `docker-compose up -d`.

```yaml
services:
  myapp:
    image: myapp:latest
    labels:
      - autoxpose.enable=true
      - autoxpose.subdomain=myapp
```

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

### List Discovered Containers

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Retrieves all Docker containers tagged with autoxpose labels.

```bash
curl http://localhost:4949/api/discovery/containers
```

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

### Sync Single Service

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Synchronizes a specific service with the configured providers.

```bash
curl -X POST http://localhost:4949/api/services/sync/svc_abc123
```

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

### Get Sync Status

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Returns the synchronization status for all services, comparing database state with provider configurations.

```bash
curl http://localhost:4949/api/services/sync/status
```

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

### Wildcard Mode API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Manages wildcard DNS/SSL mode settings.

```APIDOC
## GET /api/settings/wildcard/detect
## POST /api/settings/wildcard

### Description
Detects existing wildcard certificates or enables wildcard mode.

### Method
GET / POST

### Endpoint
/api/settings/wildcard/detect or /api/settings/wildcard

### Request Body (POST)
- **enabled** (boolean) - Required - Enable wildcard mode
- **domain** (string) - Required - Domain for wildcard mode

### Response
#### Success Response (200)
- **success** (boolean) - Operation status
- **config** (object) - Current wildcard configuration
```

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

### POST /api/services/:id/probe

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Tests if a service backend is responsive and auto-detects the scheme.

```APIDOC
## POST /api/services/:id/probe

### Description
Tests if a service backend is responsive and auto-detects the scheme (http/https).

### Method
POST

### Endpoint
/api/services/:id/probe

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

### Response
#### Success Response (200)
- **responsive** (boolean) - Backend responsiveness
- **detectedScheme** (string) - Auto-detected scheme
```

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

### Retry SSL Certificate

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Attempts to re-provision an SSL certificate for a service.

```bash
curl -X POST http://localhost:4949/api/services/svc_abc123/retry-ssl
```

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

### Check Service Online Status with autoxpose API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Verifies if an exposed service is reachable at its public domain. Returns the domain and protocol if online.

```bash
curl -X POST http://localhost:4949/api/services/svc_abc123/online
```

```json
{
  "online": true,
  "domain": "myapp.example.com",
  "protocol": "https"
}
```

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

### Delete Service with autoxpose API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Removes a service. Use the `unexpose=true` query parameter to also clean up associated DNS records and proxy hosts.

```bash
# Delete service only (keep DNS/proxy)
curl -X DELETE http://localhost:4949/api/services/svc_abc123
```

```bash
# Delete and unexpose (remove DNS record and proxy host)
curl -X DELETE "http://localhost:4949/api/services/svc_abc123?unexpose=true"
```

```json
{ "success": true }
```

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

### Unexpose Service

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Removes DNS record and proxy host for a specific service.

```bash
curl -X POST http://localhost:4949/api/services/svc_abc123/unexpose
```

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

### Retrieve Orphaned Resources

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Detects DNS records and proxy hosts that are no longer associated with any tracked service.

```bash
curl http://localhost:4949/api/services/orphans

# Response
{
  "orphans": [
    {
      "type": "dns",
      "id": "orphan_dns_123",
      "hostname": "old-service.example.com"
    },
    {
      "type": "proxy",
      "id": "orphan_proxy_456",
      "domain": "deleted-app.example.com"
    }
  ]
}
```

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

### POST /api/services/:id/online

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Verifies if an exposed service is reachable at its public domain.

```APIDOC
## POST /api/services/:id/online

### Description
Verifies if an exposed service is reachable at its public domain.

### Method
POST

### Endpoint
/api/services/:id/online

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

### Response
#### Success Response (200)
- **online** (boolean) - Reachability status
- **domain** (string) - Public domain
- **protocol** (string) - Protocol used
```

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

### POST /api/services/check-bulk

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Checks online status for multiple services in a single request.

```APIDOC
## POST /api/services/check-bulk

### Description
Checks online status for multiple services in a single request.

### Method
POST

### Endpoint
/api/services/check-bulk

### Parameters
#### Request Body
- **serviceIds** (array) - Required - List of service IDs to check.

### Response
#### Success Response (200)
- **results** (object) - Map of service IDs to their status.
```

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

### Update Service with autoxpose API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Updates an existing service's properties such as subdomain, port, scheme, or enabled status. Specify the service ID in the URL.

```bash
curl -X PATCH http://localhost:4949/api/services/svc_abc123 \
  -H "Content-Type: application/json" \
  -d '{
    "subdomain": "newname",
    "port": 9000,
    "scheme": "https"
  }'
```

```json
{
  "service": {
    "id": "svc_abc123",
    "name": "my-app",
    "subdomain": "newname",
    "port": 9000,
    "scheme": "https"
  }
}
```

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

### Bulk Service Status Check with autoxpose API

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Checks the online status for multiple services concurrently by providing a list of service IDs. The response maps each service ID to its online status and protocol.

```bash
curl -X POST http://localhost:4949/api/services/check-bulk \
  -H "Content-Type: application/json" \
  -d '{
    "serviceIds": ["svc_abc123", "svc_def456", "svc_ghi789"]
  }'
```

```json
{
  "results": {
    "svc_abc123": { "online": true, "protocol": "https" },
    "svc_def456": { "online": false, "protocol": null },
    "svc_ghi789": { "online": true, "protocol": "http" }
  }
}
```

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

### POST /api/services/:id/unexpose

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Removes DNS record and proxy host, making the service no longer publicly accessible.

```APIDOC
## POST /api/services/:id/unexpose

### Description
Removes DNS record and proxy host, making the service no longer publicly accessible.

### Method
POST

### Endpoint
/api/services/:id/unexpose

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

### Response
#### Success Response (200)
- **service** (object) - The updated service object with enabled set to false and null DNS/proxy IDs.
```

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

### DELETE /api/services/:id

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Removes a service, with an optional flag to unexpose resources.

```APIDOC
## DELETE /api/services/:id

### Description
Removes a service with optional unexpose to clean up DNS and proxy resources.

### Method
DELETE

### Endpoint
/api/services/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

#### Query Parameters
- **unexpose** (boolean) - Optional - If true, removes DNS record and proxy host.

### Response
#### Success Response (200)
- **success** (boolean) - Status of the deletion.
```

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

### PATCH /api/services/:id

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Updates properties of an existing service.

```APIDOC
## PATCH /api/services/:id

### Description
Updates service properties including subdomain, port, scheme, or enabled state.

### Method
PATCH

### Endpoint
/api/services/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the service.

#### Request Body
- **subdomain** (string) - Optional - New subdomain
- **port** (integer) - Optional - New port
- **scheme** (string) - Optional - New scheme

### Response
#### Success Response (200)
- **service** (object) - The updated service object.
```

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

### Delete DNS Record

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Removes a specific DNS record by its ID.

```bash
curl -X DELETE http://localhost:4949/api/dns/records/cf_123abc
```

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

### DELETE /api/dns/records/:id

Source: https://context7.com/mostafa-wahied/autoxpose/llms.txt

Removes a specific DNS record by ID.

```APIDOC
## DELETE /api/dns/records/:id

### Description
Removes a specific DNS record by ID.

### Method
DELETE

### Endpoint
/api/dns/records/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the DNS record.

### Response
#### Success Response (200)
- **deleted** (string) - The ID of the deleted record.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.