Delete Server API

Remove VPN servers from your infrastructure permanently

Infrastructure

Delete Server API

Remove VPN servers from your infrastructure. This permanently deletes the server configuration and associated data from the platform.

Remove Servers

Delete server configurations.

Clean Data

Remove all associated records.

Controlled Removal

Safe decommissioning process.


Endpoint Overview

MUTATION/graphql

Delete a server from the platform by its unique identifier. This removes the server configuration and prevents new connections.

Authentication:Bearer Token
Required scopes:admin

Request Parameters

idInt!Required

The unique identifier of the server to delete.


GraphQL Mutation

mutation deleteServer($id: Int!) {
  deleteServer(id: $id) {
    id
    hostName
    publicIp
    type
    city
    country
  }
}

Variables:

{
  "id": 12345
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
  -d '{
    "query": "mutation deleteServer($id: Int!) { deleteServer(id: $id) { id hostName publicIp } }",
    "variables": {
      "id": 12345
    }
  }'

Response

200Server Deleted Successfully
{
  "data": {
    "deleteServer": {
      "id": "12345",
      "hostName": "us-west-1.vpn.example.com",
      "publicIp": "203.0.113.100",
      "type": "wireguard",
      "city": "Los Angeles",
      "country": "US"
    }
  }
}
400Server Not Found
{
  "errors": [
    {
      "message": "Server with ID 12345 not found",
      "path": ["deleteServer"],
      "extensions": {
        "code": "NOT_FOUND"
      }
    }
  ],
  "data": null
}
400Active Connections
{
  "errors": [
    {
      "message": "Cannot delete server with active connections",
      "path": ["deleteServer"],
      "extensions": {
        "code": "HAS_ACTIVE_CONNECTIONS",
        "activeConnections": 15
      }
    }
  ],
  "data": null
}

What Gets Deleted

Server Config

All configuration and settings.

SSH Credentials

Stored SSH keys and usernames.

Location Data

Geographic and routing information.

Metadata

Description and custom fields.


Decommissioning Process

Check Active Users

Migrate Traffic

Delete from Platform

Shutdown Physical Server


Best Practices

Disconnect First

Ensure no active connections before deleting.

Backup Config

Save configuration before removal.

Update DNS

Remove DNS records pointing to server.

Document Removal

Record why server was decommissioned.



Irreversible Action

Server deletion is permanent. The configuration cannot be recovered once deleted. Always backup configuration before proceeding.

Need a Replacement Server?

Create a new server to replace the one you're removing.

Create Server