🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

Secondary subdomains exist to support zero-downtime subdomain rotation. When you promote a new subdomain to primary using setPrimarySubdomain(), the previous primary becomes a secondary so that existing clients can continue to resolve the old address while traffic migrates.

The removeSecondarySubdomain() mutation removes a secondary subdomain from the organization once rotation is complete. Call this mutation after all clients have migrated to the new primary subdomain and the secondary is no longer needed.

This mutation is in Preview and carries Short-Term API stability. The signature may change in future releases.

Syntax

graphql
removeSecondarySubdomain(
      input: RemoveSecondarySubdomainInput!
   ): Organization!

The required input argument takes a RemoveSecondarySubdomainInput object containing the subdomain string to remove. The mutation returns the updated Organization! object. See the Input Parameters section for argument details.

The returned Organization object provides access to the organization's subdomain configuration, URLs, and metadata. Request id and name to confirm the targeted organization. See the Returned Values section for the full field list.

Example

Raw
graphql
mutation {
  removeSecondarySubdomain( 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 {
  removeSecondarySubdomain( 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 {
  removeSecondarySubdomain( 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 { ^
  removeSecondarySubdomain( 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 {
  removeSecondarySubdomain( 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 {
  removeSecondarySubdomain( 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 {
  removeSecondarySubdomain( 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 {
  removeSecondarySubdomain( 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": {
    "removeOrganizationBucketConfig": {
      "id": "abc123"
    }
  }
}

Input Parameters

The input argument requires a RemoveSecondarySubdomainInput object. Provide the secondary subdomain string to remove in the subdomain field. The following table describes the input fields:

Table: RemoveSecondarySubdomainInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
subdomainStringyes Preview The secondary subdomain to remove.

Returned Values

The mutation returns the updated Organization! object. Request id and name to confirm the targeted organization. To verify the removal, query the subdomain configuration fields available through the returned object. The following table lists all available fields:

Table: Organization Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
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.