Set Servers

Replace configured community servers.

PUT https://api.sonorancad.com/v2/general/servers

Rate limit: 10 requests per minute Authenticated v2 endpoints are rate limited per API key rather than per IP address.

Replace the configured server list for the authenticated community.

Request Body

Each servers[] item can include id, name, description, signal, mapUrl, mapIp, listenerPort, differingOutbound, outboundIp, enableMap, mapType, isStatic, and liveMapFormat.

{
  "deployMap": true,
  "servers": [
    {
      "id": 1,
      "name": "Main Server",
      "description": "Primary patrol server",
      "signal": "100",
      "mapUrl": "https://example.com/tiles/{z}/{x}/{y}.png",
      "mapIp": "203.0.113.10",
      "listenerPort": "30120",
      "differingOutbound": false,
      "outboundIp": "",
      "enableMap": true,
      "mapType": "NORMAL",
      "isStatic": false,
      "liveMapFormat": 0
    }
  ]
}

Example Request

-- luarocks install sonoran.lua
-- For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
local Sonoran = require("sonoran")

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

local response = sonoran.cad:setServersV2({
    // See the request body above for the full server config shape.
    { id = 1, name = 'Main Server' },
  }, true)

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

Use this tab only when calling the v2 API from the server side of an in-game FiveM resource.

Sonoran.lua and Sonoran.js: use the sonorancad export to get the ready CAD client.
Sonoran.Net: FiveM exports do not return a .NET client. Read the Sonoran CAD convars and create a fresh client.
Sonoran.py: FiveM does not run Python resources; use the Python tab for external integrations.

The API key is stored in sonoran_apiKey as a protected FiveM convar. FiveM restricts a convar after add_convar_permission is configured, so only explicitly permitted resources can read it. Grant another resource access with add_convar_permission your-resource-name read sonoran_apiKey. If you change the API key in config.json, fully restart the sonorancad resource before reading the updated convar value.

Sonoran.lua

local cad = exports["sonorancad"]:getCadClient()

Sonoran.js

const cad = exports["sonorancad"].getCadClient();

Sonoran.Net

// dotnet add package Sonoran.Net
using CitizenFX.Core.Native;
using Sonoran;

var communityId = API.GetConvar("sonoran_communityID", "");
var apiKey = API.GetConvar("sonoran_apiKey", "");
var serverIdRaw = API.GetConvar("sonoran_serverId", "1");
var serverId = int.TryParse(serverIdRaw, out var parsedServerId) ? parsedServerId : 1;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = communityId,
    apiKey = apiKey,
    defaultServerId = serverId
});

After getting the Lua export client:

local response = cad:setServersV2({
    // See the request body above for the full server config shape.
    { id = 1, name = 'Main Server' },
  }, true)

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

// npm install @sonoransoftware/sonoran.js
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
const Sonoran = require('@sonoransoftware/sonoran.js');

(async () => {
  const instance = new Sonoran.Instance({
    communityId: 'YOUR_COMMUNITY_ID',
    apiKey: 'YOUR_API_KEY',
    product: Sonoran.productEnums.CAD,
    serverId: 1,
  });

  const response = await instance.cad.setServersV2([
    // See the request body above for the full server config shape.
    { id: 1, name: 'Main Server' },
  ], true);
  console.log(response);
})();

# pip install Sonoran.py
# Sonoran.py is for external Python integrations; FiveM resources should use the SonoranCADFiveM tab.
from sonoran import Instance, productEnums

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

response = instance.cad.setServersV2([
    # See the request body above for the full server config shape.
    { "id": 1, "name": 'Main Server' },
  ], True)

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

// dotnet add package Sonoran.Net
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab; .NET creates a fresh client from convars.
using Sonoran;

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

var response = await sonoran.Cad.setServersV2(
    new[]
    {
        new CadServerV2
        {
            Id = 1,
            Config = new Dictionary<string, object?>
            {
                ["name"] = "Main Server",
                ["enableMap"] = true
            }
        }
    },
    true
);

Console.WriteLine(response.success);
Console.WriteLine(response.data);

Import this YAML into Postman with Import -> Raw text to create a single-endpoint request collection for this route.

openapi: "3.0.3"
info:
  title: "Sonoran CAD v2 - Set Servers"
  version: "1.0.0"
  description: "Replace configured community servers."
servers:
  -
    url: "https://api.sonorancad.com"
paths:
  /v2/general/servers:
    put:
      summary: "Set Servers"
      operationId: "setServers"
      responses:
        200:
          description: "Successful response"
          content:
            application/json:
              schema:
                type: "object"
              example:
                servers:
                  id: 1
                  name: "Main Server"
                  description: "Primary patrol server"
                  signal: "100"
                  mapUrl: "https://example.com/tiles/{z}/{x}/{y}.png"
                  mapIp: "203.0.113.10"
                  listenerPort: "30120"
                  differingOutbound: false
                  outboundIp: ""
                  enableMap: true
                  mapType: "NORMAL"
                  isStatic: false
                  liveMapFormat: 0
      security:
        -
          bearerAuth:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: "object"
            example:
              deployMap: true
              servers:
                id: 1
                name: "Main Server"
                description: "Primary patrol server"
                signal: "100"
                mapUrl: "https://example.com/tiles/{z}/{x}/{y}.png"
                mapIp: "203.0.113.10"
                listenerPort: "30120"
                differingOutbound: false
                outboundIp: ""
                enableMap: true
                mapType: "NORMAL"
                isStatic: false
                liveMapFormat: 0
components:
  securitySchemes:
    bearerAuth:
      type: "http"
      scheme: "bearer"
      bearerFormat: "JWT"

curl --request PUT \
  --url "https://api.sonorancad.com/v2/general/servers" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
  "deployMap": true,
  "servers": [
    {
      "id": 1,
      "name": "Main Server",
      "description": "Primary patrol server",
      "signal": "100",
      "mapUrl": "https://example.com/tiles/{z}/{x}/{y}.png",
      "mapIp": "203.0.113.10",
      "listenerPort": "30120",
      "differingOutbound": false,
      "outboundIp": "",
      "enableMap": true,
      "mapType": "NORMAL",
      "isStatic": false,
      "liveMapFormat": 0
    }
  ]
}'

Response

Successful requests return application/json.

{
  "servers": [
    {
      "id": 1,
      "name": "Main Server",
      "description": "Primary patrol server",
      "signal": "100",
      "mapUrl": "https://example.com/tiles/{z}/{x}/{y}.png",
      "mapIp": "203.0.113.10",
      "listenerPort": "30120",
      "differingOutbound": false,
      "outboundIp": "",
      "enableMap": true,
      "mapType": "NORMAL",
      "isStatic": false,
      "liveMapFormat": 0
    }
  ]
}

Enumeration Values

LIVE_MAP_FORMAT

Value

Description

0

GTA_V

1

ROBLOX

PreviousGet Servers NextAuth Street Signs

Last updated 24 days ago

Was this helpful?