Set Server Type

Update the server type.

PATCH https://api.sonorancms.com/v2/community/servers/1/type

Rate limit: 18 requests per minute

Authenticated v2 endpoints are rate limited per credential rather than per IP address.

Update the server type.

Route Parameters

| --- | --- | --- | --- |

Request Body

| --- | --- | --- | --- |

Example Request

local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CMS,
  apiKey = "YOUR_API_KEY",
  communityId = "YOUR_COMMUNITY_ID",
  defaultServerId = 1,
  timeoutMs = 30000,
})

local serverId = 1
local payload = {
  ["type"] = "FiveM"
}

local response = sonoran.cms:setServerTypeV2(serverId, payload)

if response.success then
  print(response.data)
else
  print(response.reason)
end

const Sonoran = require("sonoran.js");

const instance = Sonoran.instance({
  apiKey: "YOUR_API_KEY",
  communityId: "YOUR_COMMUNITY_ID",
  product: Sonoran.productEnums.CMS,
  serverId: 1,
});

async function main() {
  const serverId = 1;
  const payload = {
  "type": "FiveM"
};

  const response = await instance.cms.setServerTypeV2(serverId, payload);

  if (response.success) {
    console.log(response.data);
  } else {
    console.error(response.reason);
  }
}

main().catch((error) => {
  console.error(error);
});

from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CMS,
    serverId=1,
)

serverId = 1
payload = {
  "type": "FiveM"
}

response = instance.cms.setServerTypeV2(serverId, payload)

if response.success:
    print(response.data)
else:
    print(response.reason)

using Sonoran;
using System.Text.Json;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CMS,
    apiKey = "YOUR_API_KEY",
    communityId = "YOUR_COMMUNITY_ID",
    defaultServerId = 1
});

var serverId = 1;
var payload = new {
  type = "FiveM"
};

var response = await sonoran.Cms.setServerTypeV2(serverId, payload);

if (response.success)
{
    Console.WriteLine(JsonSerializer.Serialize(response.data));
}
else
{
    Console.WriteLine(response.reason);
}

openapi: "3.0.3"

info:

  title: "Sonoran CMS v2 - Set Server Type"

  version: "1.0.0"

  description: "Update the server type."

servers:

  -

    url: "https://api.sonorancms.com"

paths:

  /v2/community/servers/{serverId}/type:

    patch:

      summary: "Set Server Type"

      operationId: "setServerType"

      parameters:

        -

          description: "Target server id."

          name: "serverId"

          in: "path"

          schema:

            type: "integer"

          required: true

      requestBody:

        required: true

        content:

          application/json:

            schema:

              type: "object"

      security:

        -

          bearerAuth: []

      responses:

        "200":

          description: "Successful response"

          content:

            application/json:

              schema:

                type: "object"

              example:

                success: true

                data:

                  id: 1

                  name: "Main Server"

                  description: "Primary gameplay server"

                  ip: "127.0.0.1"

                  port: "30120"

                  typeLastUpdated: "2026-04-15T00:00:00.000Z"

                  type: "erlc"

                  robloxJoinCode: "ABCD-1234"

                  aceConfig:

                    mappings:

                      -

                        ranks:

                          - "22222222-2222-2222-2222-222222222222"

                        principal: "group:123456"

                meta:

                  timestamp: "2026-04-15T00:00:00.000Z"

                  path: "/v2/community/servers/1/type"

components:

  securitySchemes:

    bearerAuth:

      type: "http"

      scheme: "bearer"

      bearerFormat: "JWT"

curl --request PATCH \

  --url "https://api.sonorancms.com/v2/community/servers/1/type" \

  --header "Authorization: Bearer YOUR_API_KEY" \

  --header "Accept: application/json" \

  --data '{"type":"FiveM"}'

Response

The data object is the updated server row. It includes the new type and typeLastUpdated values.


{

  "success": true,

  "data": {

    "id": 1,

    "name": "Main Server",

    "description": "Primary gameplay server",

    "ip": "127.0.0.1",

    "port": "30120",

    "typeLastUpdated": "2026-04-15T00:00:00.000Z",

    "type": "erlc",

    "robloxJoinCode": "ABCD-1234",

    "aceConfig": {

      "mappings": [

        {

          "ranks": [

            "22222222-2222-2222-2222-222222222222"

          ],

          "principal": "group:123456"

        }

      ]

    }

  },

  "meta": {

    "timestamp": "2026-04-15T00:00:00.000Z",

    "path": "/v2/community/servers/1/type"

  }

}

PreviousSet ACE Config NextVerify Whitelist

Last updated 28 days ago

Was this helpful?

openapi: "3.0.3"

info:

  title: "Sonoran CMS v2 - Set Server Type"

  version: "1.0.0"

  description: "Update the server type."

servers:

  -

    url: "https://api.sonorancms.com"

paths:

  /v2/community/servers/{serverId}/type:

    patch:

      summary: "Set Server Type"

      operationId: "setServerType"

      parameters:

        -

          description: "Target server id."

          name: "serverId"

          in: "path"

          schema:

            type: "integer"

          required: true

      requestBody:

        required: true

        content:

          application/json:

            schema:

              type: "object"

      security:

        -

          bearerAuth: []

      responses:

        "200":

          description: "Successful response"

          content:

            application/json:

              schema:

                type: "object"

              example:

                success: true

                data:

                  id: 1

                  name: "Main Server"

                  description: "Primary gameplay server"

                  ip: "127.0.0.1"

                  port: "30120"

                  typeLastUpdated: "2026-04-15T00:00:00.000Z"

                  type: "erlc"

                  robloxJoinCode: "ABCD-1234"

                  aceConfig:

                    mappings:

                      -

                        ranks:

                          - "22222222-2222-2222-2222-222222222222"

                        principal: "group:123456"

                meta:

                  timestamp: "2026-04-15T00:00:00.000Z"

                  path: "/v2/community/servers/1/type"

components:

  securitySchemes:

    bearerAuth:

      type: "http"

      scheme: "bearer"

      bearerFormat: "JWT"