Summary

The setSubdomainSettings() mutation sets the subdomain settings for an organization. This overrides previously configured settings.

API Stability Preview

Syntax

graphql
setSubdomainSettings(
      input: SetSubdomainSettingsInput!
   ): Organization!

For input datatype, you would give the name of the primary sub-domain, then the secondary sub-domains, and whether to enforce sub-domains. See the Input Parameters section.

For the results, you can get the organization's configuration and URLs, any organization limits, and other data. See the Returned Values section for more.

Example

Raw
graphql
mutation {
  setSubdomainSettings( input:
    { primarySubdomain: "sales",
      secondarySubdomains: [ "service", "admin" ],
      enforceSubdomains: true
    }
  ) 
  { id }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  setSubdomainSettings( input:
    { primarySubdomain: \"sales\",
      secondarySubdomains: [ \"service\", \"admin\" ],
      enforceSubdomains: true
    }
  ) 
  { id }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  setSubdomainSettings( input:
    { primarySubdomain: \"sales\",
      secondarySubdomains: [ \"service\", \"admin\" ],
      enforceSubdomains: true
    }
  ) 
  { id }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  setSubdomainSettings( input: ^
    { primarySubdomain: \"sales\", ^
      secondarySubdomains: [ \"service\", \"admin\" ], ^
      enforceSubdomains: true ^
    } ^
  )  ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setSubdomainSettings( input:
    { primarySubdomain: \"sales\",
      secondarySubdomains: [ \"service\", \"admin\" ],
      enforceSubdomains: true
    }
  ) 
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  setSubdomainSettings( input:
    { primarySubdomain: \"sales\",
      secondarySubdomains: [ \"service\", \"admin\" ],
      enforceSubdomains: true
    }
  ) 
  { id }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  setSubdomainSettings( input:
    { primarySubdomain: \"sales\",
      secondarySubdomains: [ \"service\", \"admin\" ],
      enforceSubdomains: true
    }
  ) 
  { id }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  setSubdomainSettings( input:
    { primarySubdomain: \"sales\",
      secondarySubdomains: [ \"service\", \"admin\" ],
      enforceSubdomains: true
    }
  ) 
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "setSubdomainSettings": {
      "id": "SINGLE_ORGANIZATION_ID"
    }
  }
}

Input Parameters

For the input, you'll only have to give the name of the primary sub-domain, then the secondary sub-domains, and whether to enforce sub-domains. The table below describes these parameters:

Table: SetSubdomainSettingsInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 12, 2026 
enforceSubdomainsBooleanyes Preview The sub-domain on which to enforce.
primarySubdomainStringyes Preview The primary sub-domain.
secondarySubdomainsStringyes Preview The secondary sub-domain.

Returned Values

For the results, you can get the organization's configuration and URLs, any organization limits, and other data. The table below lists what's possible:

Table: Organization Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 12, 2026 
actionOrganizationAction):Booleanyes Short-Term The action to check if a user is allowed to perform on an organization.
cidString  Short-Term The CID corresponding to the organization.
configsOrganizationConfigsyes Short-Term Organization configurations and settings. See OrganizationDetails.
createdAtLong  Short-Term Date organization was created.
defaultCachePolicyCachePolicy  Short-Term The default cache policy of the organization. See CachePolicy. This is a preview and subject to change.
deletedAtLong  Short-Term Day organization was deleted if it was marked for deletion.
descriptionString  Short-Term The description for the Organization. Can be null.
detailsOrganizationDetailsyes Short-Term Any additional details related to the organization. See OrganizationDetails.
externalGroupSynchronizationBooleanyes Short-Term Whether there is group synchronization.
externalPermissionsBooleanyes Short-Term Whether permissions are managed externally.
idStringyes Short-Term The unique id for the Organization.
ingestUrlString  Short-Term The ingest URL for the organization.
limitsLimityes Short-Term Limits assigned to the organization. See Limit.
limitsV2LimitV2yes Short-Term Limits assigned to the organization. See LimitV2.
nameStringyes Short-Term The name for the Organization.
publicUrlString  Short-Term The public URL for the organization.
readonlyDashboardIPFilterString  Short-Term IP filter for readonly dashboard links.
searchDomainsSearchDomainyes Short-Term Search domains within the organization. See SearchDomain.
statsOrganizationStatsyes Short-Term Statistics of the organization. See OrganizationStats.
trialStartedAtLong  Short-Term Date organization's trial started.