Bifrost Bifrost
POSThttps://api.dev.bifrostgaming.com/v1/graphql

partnerServerAction

v1

Permanently cancels a game server. This is a soft-cancel — the server record is preserved for audit purposes but marked as CANCELLED with serverActive set to false. This action is irreversible. The server must belong to a guild owned by the specified ownerId.

Operation Type

Mutation

Rate Limit: 30 requests per minute per partner

Rate limits are applied per partner. Bulk operations should be spaced out.

Important usage notes

  • The server must belong to a guild owned by the specified ownerId. If the ownership does not match, a 403 error is returned.
  • This is a soft-cancel: the server database record is preserved for billing and audit history, but the server is marked as CANCELLED and serverActive is set to false.
  • This action is irreversible. Once a server is cancelled, it cannot be reactivated. You must create a new server instead.
  • If the server is already in a terminal state (CANCELLED or CANCELLEDREFUNDED), a 400 error is returned.
  • Include a reason field to document why the server is being cancelled (recommended for audit trail).

Input Fields

FieldTypeRequiredDescription
partnerIdString!RequiredYour unique partner identifier. This was provided to you when your partner account was created.
encryptedDataString!RequiredYour JSON payload encrypted with AES-256-GCM using your partner encryption key, then Base64 encoded. See the Encryption Guide for details.

Encrypted Payload Fields

FieldTypeRequiredDescription
actionStringRequiredMust be "DELETE".
timestampNumberRequiredCurrent time in Unix milliseconds. Must be within 5 minutes of server time.
nonceStringRequiredA unique random string, at least 16 characters. Use a UUID or similar.
ownerIdStringRequiredThe guild owner's email. Used to verify the server belongs to this guild.
gameServerIdStringRequiredThe server ID returned from Create Server.
reasonStringOptionalHuman-readable reason for cancellation. Recorded in the audit log.

These fields make up the JSON payload that is encrypted with AES-256-GCM before being sent as encryptedData.

Code Examples

# Step 1: Encrypt your payload (see Encryption Guide)
# Step 2: Send the encrypted payload

curl -X POST https://api.dev.bifrostgaming.com/v1/graphql \
  -H "Content-Type: application/json" \
  -d '{
    "query": "mutation PartnerServerAction($input: PartnerServerActionInput!) { partnerServerAction(input: $input) { success statusCode message serverId } }",
    "variables": {
      "input": {
        "partnerId": "your-partner-id",
        "encryptedData": "BASE64_ENCRYPTED_PAYLOAD_HERE"
      }
    }
  }'

Postman Collection

Download a ready-to-use Postman collection for this endpoint. Import it into Postman to start testing immediately.

How to import into Postman
  1. Open Postman and click Import (top-left)
  2. Drag and drop the downloaded .json file, or click Upload Files and select it
  3. Click Import to confirm
  4. The collection appears in your sidebar — expand it and select the request
  5. In the Body tab, update the placeholder values (your-partner-id, etc.) with your actual credentials
  6. Click Send

The collection uses Postman's GraphQL body type, which provides syntax highlighting and variable editing. Make sure your Postman version is 7.2+ for GraphQL support.

Success Response200

{
  "data": {
    "partnerServerAction": {
      "success": true,
      "statusCode": 200,
      "message": "Server cancelled successfully",
      "serverId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }
}

Error Responses

Response Fields

FieldTypeRequiredDescription
successBooleanRequiredtrue if the server was cancelled successfully.
statusCodeIntRequiredHTTP-style status code. 200 = ok, 400 = bad request, 401 = unauthorized, 403 = ownership mismatch, 404 = not found, 500 = error.
messageStringRequiredA human-readable description of the result.
serverIdStringOptionalThe ID of the server that was cancelled.

In partnership with

Brilliant game servers for communities large and small.

Get yours today!

Shrapnelworks Logo

A Shrapnelworks product