Add Servers

Append one or more servers to the configuration.

POST https://api.sonorancms.com/v2/community/servers

Rate limit: 9 requests per minute

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

Append one or more servers to the configuration.

Request Body

| Name | Type | Required | Description |

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

| servers | array | Yes | See example request for the shape. |

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 payload = {
  ["servers"] = {
    {
      ["id"] = 1,
      ["name"] = "Main Server",
      ["description"] = "Primary community server",
      ["ip"] = "127.0.0.1",
      ["port"] = "30120",
      ["type"] = "FiveM",
      ["erlcApiKey"] = "",
      ["robloxJoinCode"] = "ABC123",
      ["aceConfig"] = { },
      ["robloxMetadata"] = { }
    }
  }
}

local response = sonoran.cms:addServersV2(payload)

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

Response

The data object is the community servers container. It exposes the server list the backend stores for the community.

Last updated

Was this helpful?