Pangolin

https://docs.pangolin.net
Admin
Pangolin is an open-source, identity-based remote access platform built on WireGuard that enables...
Tokens:7,351
Snippets:71
Trust Score:8.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /readyz

Source: https://docs.pangolin.net/self-host/advanced/observability

Readiness check endpoint for the controller.

```APIDOC
## GET /readyz

### Description
Readiness check endpoint to verify the controller is ready to process requests.

### Method
GET

### Endpoint
/readyz
```

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

### Config Parse Duration Histogram Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Example of the duration bucket for configuration parsing.

```text
pangolin_controller_config_parse_duration_seconds_bucket{section="full",le="0.1"} 2
```

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

### SNI Connection Metrics

Source: https://docs.pangolin.net/self-host/advanced/observability

Examples of metric output for SNI connection tracking.

```text
gerbil_sni_connections_total{result="success"} 3
```

```text
gerbil_sni_connection_duration_seconds_bucket{le="10"} 4
```

```text
gerbil_sni_active_connections 2
```

```text
gerbil_sni_route_cache_hits_total{result="hit"} 10
```

```text
gerbil_sni_route_api_requests_total{result="success"} 5
```

```text
gerbil_sni_route_api_latency_seconds_bucket{le="0.25"} 4
```

```text
gerbil_sni_local_override_total{hit="true"} 1
```

```text
gerbil_sni_trusted_proxy_events_total{event="parsed"} 2
```

```text
gerbil_sni_proxy_protocol_parse_errors_total 1
```

```text
gerbil_sni_data_bytes_total{direction="ingress"} 4096
```

```text
gerbil_sni_tunnel_terminations_total{reason="client_close"} 1
```

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

### Create Site with Defaults Response

Source: https://docs.pangolin.net/manage/common-api-routes

Example response for site creation when using values retrieved from the pick-site-defaults endpoint.

```json
{
  "data": {
    "siteId": 8723,
    "niceId": "quiet-lerista-labialis",
    "name": "My Site",
    "type": "newt",
    "online": false,
    "address": "100.90.128.0/24"
    "newtId": "se897rmyjvamy5q",
    "secret": "ystsahnvqetgx1fhn2udylq0zqgv611zbfp6ya3jvfrprn7q"
  },
  "success": true,
  "error": false,
  "message": "Site created successfully",
  "status": 201
}
```

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

### GET /metrics

Source: https://docs.pangolin.net/self-host/advanced/observability

Retrieves the Prometheus-formatted metrics for the Pangolin Kubernetes Controller.

```APIDOC
## GET /metrics

### Description
Returns the current state of controller metrics in Prometheus format. This endpoint is served on the configured METRICS_ADDR (default :9090).

### Method
GET

### Endpoint
/metrics
```

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

### Create HTTP Resource Response

Source: https://docs.pangolin.net/manage/common-api-routes

Example JSON response returned after successfully creating an HTTP resource.

```json
{
  "data": {
    "resourceId": 9942,
    "niceId": "decent-louisiana-waterthrush",
    "name": "My Resource",
    "subdomain": "my-subdomain",
    "fullDomain": "my-subdomain.pangolin.net",
    "domainId": "pg3i1k4lhibhl3i"
  },
  "success": true,
  "error": false,
  "message": "Http resource created successfully",
  "status": 201
}
```

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

### Create Newt Site Response

Source: https://docs.pangolin.net/manage/common-api-routes

Example response returned after successfully creating a new site with the Newt type.

```json
{
  "data": {
    "siteId": 8723,
    "niceId": "quiet-lerista-labialis",
    "name": "My Site",
    "type": "newt",
    "online": false,
    "address": "100.90.128.0",
    "newtId": "se897rmyjvamy5q",
    "secret": "ystsahnvqetgx1fhn2udylq0zqgv611zbfp6ya3jvfrprn7q"
  },
  "success": true,
  "error": false,
  "message": "Site created successfully",
  "status": 201
}
```

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

### Retrieve Site Defaults Response

Source: https://docs.pangolin.net/manage/common-api-routes

Example response from the pick-site-defaults endpoint, providing template values for site creation.

```json
{
  "data": {
    "newtId": "jwhk5154mfmos0s",
    "newtSecret": "8afipi4i79jjbsxjqpkgc0xe2ge143s54oi64mw5567mxgr8",
    "clientAddress": "100.90.128.0"
  },
  "success": true,
  "error": false,
  "message": "Site defaults chosen successfully",
  "status": 200
}
```

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

### HTTP API Metrics

Source: https://docs.pangolin.net/self-host/advanced/observability

Example of metric output for HTTP management API requests.

```text
gerbil_http_requests_total{endpoint="/peer",method="POST",status_code="200"} 1
```

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

### Create Site Resource Request

Source: https://docs.pangolin.net/manage/common-api-routes

Example JSON payload for the PUT /org/{orgId}/site-resource endpoint.

```json
{
  "name": "My Private Resource",
  "siteId": 8723,
  "mode": "host",
  "destination": "localhost",
  "alias": "private-resource.internal",
  "tcpPortRangeString": "*",
  "udpPortRangeString": "",
  "disableIcmp": false,
  "authDaemonMode": "site",
  "roleIds": [],
  "userIds": []
}
```

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

### Controller Loop Iterations Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Example of the total iterations counter for the controller loop.

```text
pangolin_controller_loop_iterations_total{outcome="success"} 10
```

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

### GET /org/{orgId}/pick-site-defaults

Source: https://docs.pangolin.net/manage/common-api-routes

Retrieves template values and default configuration settings required for site creation.

```APIDOC
## GET /org/{orgId}/pick-site-defaults

### Description
Retrieves template values and default configuration settings to be used when calling the create-site endpoint.

### Method
GET

### Endpoint
/org/{orgId}/pick-site-defaults

### Parameters
#### Path Parameters
- **orgId** (string) - Required - organization ID

### Response
#### Success Response (200)
- **data** (object) - Default configuration values
- **success** (boolean) - Indicates success
- **error** (boolean) - Indicates error status
- **message** (string) - Status message
- **status** (integer) - HTTP status code
```

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

### List Domains Response

Source: https://docs.pangolin.net/manage/common-api-routes

Example JSON response returned when listing organization domains.

```json
{
  "data": {
    "domains": [
      {
        "domainId": "pg3i1k4lhibhl3i",
        "baseDomain": "pangolin.net",
        "verified": true,
        "type": "ns"
      },
      {
        "domainId": "q1ngj5341k7oydo",
        "baseDomain": "bitwarden.pangolin.net",
        "verified": true,
        "type": "cname"
      }
    ],
    "pagination": {
      "total": 2,
      "limit": 1000,
      "offset": 0
    }
  },
  "success": true,
  "error": false,
  "message": "Domains retrieved successfully",
  "status": 200
}
```

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

### Add Target Request and Response

Source: https://docs.pangolin.net/manage/common-api-routes

Example request body and corresponding success response for adding a backend target to a resource.

```json
{
  "ip": "localhost",
  "port": 8080,
  "method": "http",
  "siteId": 5165
}
```

```json
{
  "data": {
    "targetId": 11280,
    "resourceId": 9942,
    "siteId": 8723,
    "ip": "localhost",
    "method": "http",
    "port": 8080
  },
  "success": true,
  "error": false,
  "message": "Target created successfully",
  "status": 201
}
```

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

### Create HTTP Resource Request

Source: https://docs.pangolin.net/manage/common-api-routes

Example JSON request body for creating a new public HTTP resource.

```json
{
  "name": "My Resource",
  "http": true,
  "subdomain": "my-subdomain",
  "domainId": "pg3i1k4lhibhl3i",
  "protocol": "tcp"
}
```

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

### Fetch Duration Histogram Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Example of the duration bucket for remote fetch cycle HTTP requests.

```text
pangolin_controller_fetch_duration_seconds_bucket{status_code="200",status_class="2xx",le="0.25"} 4
```

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

### Kubernetes API Request Duration Histogram Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Example of the duration bucket for Kubernetes API requests.

```text
pangolin_controller_k8s_request_duration_seconds_bucket{verb="patch",resource_kind="IngressRoute",result="success",forced="false",le="0.25"} 3
```

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

### Kubernetes API Requests Total Counter Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Example of the total count for Kubernetes API requests.

```text
pangolin_controller_k8s_requests_total{verb="patch",resource_kind="IngressRoute",result="success",forced="false"} 1
```

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

### GET /healthz

Source: https://docs.pangolin.net/self-host/advanced/observability

Health check endpoint for the controller.

```APIDOC
## GET /healthz

### Description
Standard health check endpoint to verify the controller is running.

### Method
GET

### Endpoint
/healthz
```

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

### Garbage Collection Run Duration Histogram Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Example of the duration bucket for garbage collection runs.

```text
pangolin_controller_gc_run_duration_seconds_bucket{result="success",le="0.5"} 1
```

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

### GET /org/{orgId}/users

Source: https://docs.pangolin.net/manage/common-api-routes

Retrieves a list of users available in the organization.

```APIDOC
## GET /org/{orgId}/users

### Description
Returns a list of users in the organization. Use the returned id as userId when assigning users to resources.

### Method
GET

### Endpoint
/org/{orgId}/users

### Parameters
#### Path Parameters
- **orgId** (number) - Required - The organization ID.

#### Query Parameters
- **limit** (number) - Optional - Limit the number of results.
- **offset** (number) - Optional - Offset for pagination.
```

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

### GET /org/{orgId}/roles

Source: https://docs.pangolin.net/manage/common-api-routes

Retrieves a list of roles available in the organization.

```APIDOC
## GET /org/{orgId}/roles

### Description
Returns a list of roles in the organization. Use the returned roleId for assigning roles to resources.

### Method
GET

### Endpoint
/org/{orgId}/roles

### Parameters
#### Path Parameters
- **orgId** (number) - Required - The organization ID.

#### Query Parameters
- **limit** (number) - Optional - Limit the number of results.
- **offset** (number) - Optional - Offset for pagination.
```

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

### SSA Apply Retries Total Counter Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Example of the total count for retry attempts in the SSA apply loop.

```text
pangolin_controller_retries_total{reason="conflict",operation="patch",resource_kind="IngressRoute"} 1
```

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

### GET /metrics

Source: https://docs.pangolin.net/self-host/advanced/observability

Retrieves the current state of Gerbil metrics in Prometheus format. This endpoint is only available when METRICS_BACKEND is set to 'prometheus'.

```APIDOC
## GET /metrics

### Description
Exposes Gerbil system and WireGuard metrics in Prometheus format. This endpoint is only active when the environment variable METRICS_BACKEND is set to 'prometheus'.

### Method
GET

### Endpoint
/metrics

### Response
#### Success Response (200)
- **Content-Type** (text/plain) - Prometheus metric exposition format.
```

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

### GET /org/{orgId}/domains

Source: https://docs.pangolin.net/manage/common-api-routes

Retrieves a list of all domains associated with the specified organization. This is a prerequisite for obtaining a domainId to create resources.

```APIDOC
## GET /org/{orgId}/domains

### Description
Returns all domains for the organization. Use the domainId from a domain when creating a resource.

### Method
GET

### Endpoint
/org/{orgId}/domains

### Parameters
#### Path Parameters
- **orgId** (string) - Required - organization ID

#### Query Parameters
- **limit** (number) - Optional - Max domains to return (Default: 1000)
- **offset** (number) - Optional - Pagination offset (Default: 0)

### Response
#### Success Response (200)
- **data** (object) - Contains domains list and pagination info
- **success** (boolean) - Indicates if the request was successful
- **message** (string) - Status message

#### Response Example
{
  "data": {
    "domains": [
      {
        "domainId": "pg3i1k4lhibhl3i",
        "baseDomain": "pangolin.net",
        "verified": true,
        "type": "ns"
      }
    ],
    "pagination": {
      "total": 2,
      "limit": 1000,
      "offset": 0
    }
  },
  "success": true,
  "error": false,
  "message": "Domains retrieved successfully",
  "status": 200
}
```

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

### Useful command reference

Source: https://docs.pangolin.net/self-host/manual/kubernetes/pangolin/troubleshooting

A collection of kubectl commands for inspecting cluster state, logs, resource usage, and port-forwarding for local testing.

```bash
# General cluster info
kubectl cluster-info
kubectl version

# Namespace overview
kubectl get all --namespace "$PANGOLIN_NAMESPACE"
kubectl get pvc,secret,configmap --namespace "$PANGOLIN_NAMESPACE"
kubectl get events --namespace "$PANGOLIN_NAMESPACE" --sort-by=.lastTimestamp

# Logs
kubectl logs --namespace "$PANGOLIN_NAMESPACE" \
  -l app.kubernetes.io/name=pangolin \
  --tail=200

kubectl logs --namespace "$PANGOLIN_NAMESPACE" \
  -l app.kubernetes.io/name=gerbil \
  --tail=200

# Dashboard local test
kubectl port-forward --namespace "$PANGOLIN_NAMESPACE" svc/pangolin 8080:3002

# Traefik resources
kubectl get ingressroute --namespace "$PANGOLIN_NAMESPACE"

# Resource usage
kubectl top pod --namespace "$PANGOLIN_NAMESPACE"
kubectl top node
```

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

### Create Site Resource Response

Source: https://docs.pangolin.net/manage/common-api-routes

Successful response returned after creating a new site resource.

```json
{
  "data": {
    "siteResourceId": 1165,
    "siteId": 8723,
    "niceId": "unsung-round-tailed-ground-squirrel",
    "name": "My Private Resource",
    "mode": "host",
    "destination": "localhost",
    "alias": "private-resource.internal",
    "tcpPortRangeString": "*",
    "udpPortRangeString": "",
    "disableIcmp": false,
    "authDaemonPort": 22123,
    "authDaemonMode": "site"
  },
  "success": true,
  "error": false,
  "message": "Site resource created successfully",
  "status": 201
}
```

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

### Collect basic diagnostics

Source: https://docs.pangolin.net/self-host/manual/kubernetes/pangolin/troubleshooting

Commands to export current Helm release status, values, manifests, pod information, and cluster events for troubleshooting.

```bash
kubectl version
helm version

helm status "$PANGOLIN_RELEASE" --namespace "$PANGOLIN_NAMESPACE"
helm get values "$PANGOLIN_RELEASE" --namespace "$PANGOLIN_NAMESPACE" --all > pangolin-values.yaml
helm get manifest "$PANGOLIN_RELEASE" --namespace "$PANGOLIN_NAMESPACE" > pangolin-manifest.yaml

kubectl get pods --namespace "$PANGOLIN_NAMESPACE" -o wide > pangolin-pods.txt
kubectl get events --namespace "$PANGOLIN_NAMESPACE" --sort-by=.lastTimestamp > pangolin-events.txt
```

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

### Heap Profile Written Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Counts the total number of heap profile files generated.

```text
gerbil_heap_profiles_written_total 1
```

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

### POST /site-resource/{siteResourceId}/users/add

Source: https://docs.pangolin.net/manage/common-api-routes

Assigns a user to a private site resource.

```APIDOC
## POST /site-resource/{siteResourceId}/users/add

### Description
Grants access to a private site resource to a specific user.

### Method
POST

### Endpoint
/site-resource/{siteResourceId}/users/add

### Parameters
#### Path Parameters
- **siteResourceId** (number) - Required - The site resource ID.

#### Request Body
- **userId** (string) - Required - The ID of the user to assign.

### Response
#### Success Response (201)
- **data** (object) - Empty object
- **success** (boolean) - True
- **error** (boolean) - False
- **message** (string) - Status message
- **status** (number) - 201
```

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

### Configuration Reload Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Tracks the total number of configuration reloads.

```text
gerbil_config_reloads_total{result="success"} 1
```

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

### POST /resource/{resourceId}/users/add

Source: https://docs.pangolin.net/manage/common-api-routes

Assigns a user to a public resource.

```APIDOC
## POST /resource/{resourceId}/users/add

### Description
Grants access to a public resource to a specific user.

### Method
POST

### Endpoint
/resource/{resourceId}/users/add

### Parameters
#### Path Parameters
- **resourceId** (number) - Required - The resource ID.

#### Request Body
- **userId** (string) - Required - The ID of the user to assign.

### Response
#### Success Response (201)
- **data** (object) - Empty object
- **success** (boolean) - True
- **error** (boolean) - False
- **message** (string) - Status message
- **status** (number) - 201
```

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

### PUT /org/{orgId}/site

Source: https://docs.pangolin.net/manage/common-api-routes

Creates a new site within the specified organization. This endpoint supports the creation of 'newt' type sites.

```APIDOC
## PUT /org/{orgId}/site

### Description
Creates a new site within the specified organization.

### Method
PUT

### Endpoint
/org/{orgId}/site

### Parameters
#### Path Parameters
- **orgId** (string) - Required - organization ID

#### Request Body
- **name** (string) - Required - Display name for the site
- **type** (string) - Required - Use "newt"
- **address** (string) - Required - From pick-site-defaults clientAddress
- **newtId** (string) - Required - From pick-site-defaults newtId
- **secret** (string) - Required - From pick-site-defaults newtSecret

### Response
#### Success Response (201)
- **data** (object) - Site creation details
- **success** (boolean) - Indicates success
- **error** (boolean) - Indicates error status
- **message** (string) - Status message
- **status** (integer) - HTTP status code
```

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

### POST /site-resource/{siteResourceId}/roles/add

Source: https://docs.pangolin.net/manage/common-api-routes

Assigns a role to a private site resource.

```APIDOC
## POST /site-resource/{siteResourceId}/roles/add

### Description
Grants a role to a private site resource. The role must belong to the same organization as the site resource. The Admin role cannot be assigned.

### Method
POST

### Endpoint
/site-resource/{siteResourceId}/roles/add

### Parameters
#### Path Parameters
- **siteResourceId** (number) - Required - The site resource ID.

#### Request Body
- **roleId** (number) - Required - The ID of the role to assign.

### Response
#### Success Response (201)
- **data** (object) - Empty object
- **success** (boolean) - True
- **error** (boolean) - False
- **message** (string) - Status message
- **status** (number) - 201
```

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

### Active Reconcile Routines Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Tracks the number of active reconcile routines by phase.

```text
pangolin_controller_active_reconcile_routines{phase="routers"} 1
```

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

### Reconcile Phase Duration Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Histogram tracking the duration of reconcile phases in the Kubernetes controller.

```text
pangolin_controller_reconcile_phase_duration_seconds_bucket{phase="routers",result="success",le="0.5"} 3
```

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

### PUT /resource/{resourceId}/target

Source: https://docs.pangolin.net/manage/common-api-routes

Adds a backend target to a resource using the resource ID.

```APIDOC
## PUT /resource/{resourceId}/target

### Description
Add a target (backend) to a resource. The target is the site and address (ip + port) that will receive traffic for the resource.

### Method
PUT

### Endpoint
/resource/{resourceId}/target

### Parameters
#### Path Parameters
- **resourceId** (number) - Required - From create-resource response

#### Request Body
- **siteId** (number) - Required - Site that hosts the backend
- **ip** (string) - Required - Backend IP or hostname
- **port** (number) - Required - Backend port
- **method** (string) - Required - e.g. "http" for HTTP resources

### Request Example
{
  "ip": "localhost",
  "port": 8080,
  "method": "http",
  "siteId": 5165
}

### Response
#### Success Response (201)
- **data** (object) - The created target object
- **success** (boolean) - Indicates success
- **error** (boolean) - Indicates error status
- **message** (string) - Status message
- **status** (number) - HTTP status code

#### Response Example
{
  "data": {
    "targetId": 11280,
    "resourceId": 9942,
    "siteId": 8723,
    "ip": "localhost",
    "method": "http",
    "port": 8080
  },
  "success": true,
  "error": false,
  "message": "Target created successfully",
  "status": 201
}
```

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

### POST /resource/{resourceId}/roles/add

Source: https://docs.pangolin.net/manage/common-api-routes

Assigns a role to a public resource.

```APIDOC
## POST /resource/{resourceId}/roles/add

### Description
Grants a role to a public resource. The Admin role cannot be assigned.

### Method
POST

### Endpoint
/resource/{resourceId}/roles/add

### Parameters
#### Path Parameters
- **resourceId** (number) - Required - The resource ID.

#### Request Body
- **roleId** (number) - Required - The ID of the role to assign.

### Response
#### Success Response (201)
- **data** (object) - Empty object
- **success** (boolean) - True
- **error** (boolean) - False
- **message** (string) - Status message
- **status** (number) - 201
```

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

### Process Restart Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Counts the total number of process restarts.

```text
gerbil_restart_total 1
```

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

### PUT /org/{orgId}/resource

Source: https://docs.pangolin.net/manage/common-api-routes

Creates a new public HTTP resource for the specified organization using a valid domainId.

```APIDOC
## PUT /org/{orgId}/resource

### Description
Creates a public HTTP resource. Requires a valid domainId obtained from the list-domains endpoint.

### Method
PUT

### Endpoint
/org/{orgId}/resource

### Parameters
#### Path Parameters
- **orgId** (string) - Required - organization ID

#### Request Body
- **name** (string) - Required - Display name for the resource (1–255 chars)
- **http** (boolean) - Required - Use true for public HTTP resource
- **domainId** (string) - Required - From list-domains
- **protocol** (string) - Required - "tcp"
- **subdomain** (string | null) - Optional - Subdomain to combine with base domain

### Request Example
{
  "name": "My Resource",
  "http": true,
  "subdomain": "my-subdomain",
  "domainId": "pg3i1k4lhibhl3i",
  "protocol": "tcp"
}

### Response
#### Success Response (201)
- **data** (object) - Contains created resource details including resourceId and fullDomain
- **success** (boolean) - Indicates if the request was successful
- **message** (string) - Status message

#### Response Example
{
  "data": {
    "resourceId": 9942,
    "niceId": "decent-louisiana-waterthrush",
    "name": "My Resource",
    "subdomain": "my-subdomain",
    "fullDomain": "my-subdomain.pangolin.net",
    "domainId": "pg3i1k4lhibhl3i"
  },
  "success": true,
  "error": false,
  "message": "Http resource created successfully",
  "status": 201
}
```

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

### PUT /org/{orgId}/site-resource

Source: https://docs.pangolin.net/manage/common-api-routes

Creates a new private site resource associated with a specific organization and site.

```APIDOC
## PUT /org/{orgId}/site-resource

### Description
Creates a new private site resource within an organization. This resource requires an existing site ID and defines access via host or CIDR modes.

### Method
PUT

### Endpoint
/org/{orgId}/site-resource

### Parameters
#### Path Parameters
- **orgId** (string) - Required - Organization ID

#### Request Body
- **name** (string) - Required - Display name (1–255 chars)
- **siteId** (number) - Required - Site that hosts the resource
- **mode** (string) - Required - "host" or "cidr"
- **destination** (string) - Required - For host: IP or hostname. For cidr: CIDR.
- **alias** (string) - Optional - Alias hostname. Required when destination is a domain.
- **tcpPortRangeString** (string) - Required - TCP port range string (e.g., "*", "80,443", "8000-9000")
- **udpPortRangeString** (string) - Required - UDP port range string
- **disableIcmp** (boolean) - Optional - Default false
- **authDaemonMode** (string) - Optional - "site" or "remote"
- **roleIds** (number[]) - Optional - Role IDs that can access
- **userIds** (string[]) - Optional - User IDs that can access

### Request Example
{
  "name": "My Private Resource",
  "siteId": 8723,
  "mode": "host",
  "destination": "localhost",
  "alias": "private-resource.internal",
  "tcpPortRangeString": "*",
  "udpPortRangeString": "",
  "disableIcmp": false,
  "authDaemonMode": "site",
  "roleIds": [],
  "userIds": []
}

### Response
#### Success Response (201)
- **data** (object) - The created site resource object
- **success** (boolean) - Indicates success
- **message** (string) - Success message

#### Response Example
{
  "data": {
    "siteResourceId": 1165,
    "siteId": 8723,
    "niceId": "unsung-round-tailed-ground-squirrel",
    "name": "My Private Resource",
    "mode": "host",
    "destination": "localhost",
    "alias": "private-resource.internal",
    "tcpPortRangeString": "*",
    "udpPortRangeString": "",
    "disableIcmp": false,
    "authDaemonPort": 22123,
    "authDaemonMode": "site"
  },
  "success": true,
  "error": false,
  "message": "Site resource created successfully",
  "status": 201
}
```

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

### Firewall Rule Applied Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Records the total number of firewall rules applied, categorized by result and chain.

```text
gerbil_firewall_rules_applied_total{result="success",chain="FORWARD"} 1
```

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

### ACL Denied Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Tracks access-control denied events by interface, peer, and policy.

```text
gerbil_acl_denied_total{ifname="wg0",peer="abc",policy="deny"} 1
```

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

### Memory Spike Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Counts memory spikes detected, categorized by severity.

```text
gerbil_memory_spike_total{severity="warning"} 1
```

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

### Authentication Failure Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Records authentication or peer validation failures with associated peer and reason labels.

```text
gerbil_auth_failures_total{peer="abc",reason="invalid_key"} 1
```

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

### Certificate Expiry Metric

Source: https://docs.pangolin.net/self-host/advanced/observability

Reports the number of days remaining until certificate expiry as a gauge.

```text
gerbil_certificate_expiry_days{cert_name="server",ifname="wg0"} 42
```
Tokens:
Raw