Settings
Rename server
Renames the server
Fields
| Name | Required? | Type | Description | Rules |
|---|---|---|---|---|
| name | required | string | New name for the server | |
| description | optional | string | New description for the server |
POST
/api/client/servers/{server}/settings/renameAuthorization
ClientToken AuthorizationBearer <token>
Client API key (generated at /account/api)
In: header
Path Parameters
server*string
Server identifier (short 8-character ID)
Request Body
application/json
name*string
description?|
Response Body
curl -X POST "https://pterodactyl.file.properties/api/client/servers/1a7ce997/settings/rename" \ -H "Authorization: Bearer ptlc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "name": "Gaming", "description": "Our community survival server"}'Empty