Summary

The setPrimarySubdomain() mutation sets the primary subdomain for an organization. Each organization has one primary subdomain that defines the canonical URL for accessing that organization. If a primary subdomain is already configured, this mutation demotes it to a secondary subdomain and promotes the specified subdomain to primary. Use this mutation to change which subdomain acts as the canonical access point for an organization.

Stability Level Short-Term

Syntax

graphql
setPrimarySubdomain(
      input: SetPrimarySubdomainInput!
   ): Organization!

The mutation takes a single required input argument of type SetPrimarySubdomainInput. Provide the name of the subdomain to promote to primary. The return type Organization! is non-nullable: the mutation always returns the updated organization object. See the Input Parameters section for details on the fields within that input type.

The mutation returns an Organization object reflecting the state after the promotion. Use the returned configs.subdomains fields to confirm the new primary subdomain and verify that the previous primary subdomain appears in the secondary subdomains list. See the Returned Values section for the available fields.

Example

Raw
graphql
mutation {
  setPrimarySubdomain( input:
    { subdomain: "sales" }
  ) 
  { 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 {
  setPrimarySubdomain( input:
    { subdomain: \"sales\" }
  ) 
  { 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 {
  setPrimarySubdomain( input:
    { subdomain: \"sales\" }
  ) 
  { 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 { ^
  setPrimarySubdomain( input: ^
    { subdomain: \"sales\" } ^
  )  ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setPrimarySubdomain( input:
    { subdomain: \"sales\" }
  ) 
  { 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 {
  setPrimarySubdomain( input:
    { subdomain: \"sales\" }
  ) 
  { 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 {
  setPrimarySubdomain( input:
    { subdomain: \"sales\" }
  ) 
  { 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 {
  setPrimarySubdomain( input:
    { subdomain: \"sales\" }
  ) 
  { 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": {
    "setPrimarySubdomain": {
      "id": "SINGLE_ORGANIZATION_ID"
    }
  }
}

Input Parameters

The input requires a single field: the name of the subdomain to promote to primary. The subdomain must already exist as a configured subdomain for the organization. To retrieve existing subdomains, use the query in the collapsed example in the Related section. The following table describes the input fields.

Table: SetPrimarySubdomainInput 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 14, 2026 
subdomainStringyes Preview The name of the primary sub-domain.

Returned Values

The mutation returns an Organization object representing the updated organization. To confirm the subdomain change, request configs.subdomains.primarySubdomain to verify the new primary and configs.subdomains.secondarySubdomains to confirm the former primary was demoted. The configs.subdomains.enforceSubdomains field indicates whether subdomain-based access enforcement is active for the organization. The object also includes configuration settings, organization limits, and related metadata. The following table lists the available fields.

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 14, 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.