API Stability Preview

The setSubdomainSettings() GraphQL mutation is used to set the subdomain settings for an organization. This overrides previously configured settings.

To remove sub-domain settings, use the removeSubdomainSettings() mutation. There are a few other related mutations: addSubdomain() to add a sub-domain; setPrimarySubdomain() to set a sub-domain to the primary one; and removeSecondarySubdomain() to remove a secondary. To enforce sub-domains, use setEnforceSubdomains().

To get the names of the primary and secondary sub-domains, and to see if sub-domains are enforced, you could execute the organization() like this:

graphql
organization {
     configs {
       subdomains: {
         primarySubdomain,
         secondarySubdomains,
         enforceSubdomains }
     }
   }

Syntax

graphql
setSubdomainSettings(
      input: SetSubdomainSettingsInput!
   ): Organization!

Example

Below is an example of how this mutation field might be used:

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"
    }
  }
}

Given Datatype

For input datatype, 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

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 19, 2024
enforceSubdomainsbooleanyes PreviewThe sub-domain on which to enforce.
primarySubdomainstringyes PreviewThe primary sub-domain.
secondarySubdomains[string]yes PreviewThe secondary sub-domain.

Returned Datatype

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

Table: Organization

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Aug 21, 2025
cidstring  Short-TermThe CID corresponding to the organization.
configsOrganizationConfigsyes Short-TermOrganization configurations and settings. See OrganizationDetails.
createdAtlong  Short-TermDate organization was created.
defaultCachePolicyCachePolicy  PreviewThe default cache policy of the organization. See CachePolicy. This is a preview and subject to change.
deletedAtlong  Short-TermDay organization was deleted if it was marked for deletion.
descriptionstring  Short-TermThe description for the Organization. Can be null.
detailsOrganizationDetailsyes Short-TermAny additional details related to the organization. See OrganizationDetails.
externalGroupSynchronizationbooleanyes Short-TermWhether there is group synchronization.
externalPermissionsbooleanyes Short-TermWhether permissions are managed externally.
idstringyes Short-TermThe unique id for the Organization.
ingestUrlstring  Short-TermThe ingest URL for the organization.
isActionAllowed(action: OrganizationAction): booleanmultipleyes Short-TermCheck if user has a permission in organization. For OrganizationAction, give the action to check if a user is allowed to perform on the organization. See OrganizationAction.
limits[Limit]yes Short-TermLimits assigned to the organization. See Limit.
limitsV2[LimitV2]yes Short-TermLimits assigned to the organization. See LimitV2.
namestringyes Short-TermThe name for the Organization.
publicUrlstring  Short-TermThe public URL for the organization.
readonlyDashboardIPFilterstring  Short-TermIP filter for readonly dashboard links.
searchDomains[SearchDomain]yes Short-TermSearch domains within the organization. See SearchDomain.
statsOrganizationStatsyes Short-TermStatistics of the organization. See OrganizationStats.
trialStartedAtlong  Short-TermDate organization's trial started.