setSubdomainSettings()

API Stability	`Preview`

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

Syntax

Below is the syntax for the setSubdomainSettings() mutation field:

graphql

setSubdomainSettings(
      input: SetSubdomainSettingsInput!
   ): Organization!

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

Show:

graphql

mutation {
  setSubdomainSettings( input:
    { primarySubdomain: "sales",
      secondarySubdomains: [ "service", "admin" ],
      enforceSubdomains: true
    }
  ) 
  { id }
}

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

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

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

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  setSubdomainSettings( input:
    { primarySubdomain: \"sales\",
      secondarySubdomains: [ \"service\", \"admin\" ],
      enforceSubdomains: true
    }
  ) 
  { id }
}"
}';
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

#! /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)

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/graphql',
  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

Show:

json

{
  "data": {
    "setSubdomainSettings": {
      "id": "SINGLE_ORGANIZATION_ID"
    }
  }
}

Given Datatypes

SetSubdomainSettingsInput has a few parameters. Below is a list of them along with a description of each:

Table: SetSubdomainSettingsInput

Parameter	Type	Required	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 19, 2024
`enforceSubdomains`	boolean	yes	The sub-domain on which to enforce.
`primarySubdomain`	string	yes	The primary sub-domain.
`secondarySubdomains`	[string]	yes	The secondary sub-domain.

Returned Datatypes

The returned datatype Organization has its own parameters. Below is a list of them along with a description of each:

Table: Organization

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 27, 2024
`cid`	string		`Short-Term`	The CID corresponding to the organization.
`configs`	`OrganizationConfigs`	yes	`Short-Term`	Organization configurations and settings. See `OrganizationDetails`.
`createdAt`	long		`Short-Term`	Date organization was created.
`defaultCachePolicy`	`CachePolicy`		`Preview`	The default cache policy of the organization. See `CachePolicy`. This is a preview and subject to change.
`description`	string		`Short-Term`	The description for the Organization. Can be null.
`details`	`OrganizationDetails`	yes	`Short-Term`	Any additional details related to the organization. See `OrganizationDetails`.
`externalGroupSynchronization`	boolean	yes	`Short-Term`	Whether there is group synchronization.
`externalPermissions`	boolean	yes	`Short-Term`	Whether permissions are managed externally.
`id`	string	yes	`Short-Term`	The unique id for the Organization.
`ingestUrl`	string		`Short-Term`	The ingest URL for the organization.
`isActionAllowed`	multiple	yes	`Short-Term`	Check if user has a permission in organization. The datatype consists of `(action: OrganizationAction): boolean`. For `OrganizationAction`, give the action to check if a user is allowed to perform on the organization. See `OrganizationAction`.
`limits`	[`Limit`]	yes	`Short-Term`	Limits assigned to the organization. See `Limit`.
`limitsV2`	[`LimitV2`]	yes	`Short-Term`	Limits assigned to the organization. See `LimitV2`.
`name`	string	yes	`Short-Term`	The name for the Organization.
`publicUrl`	string		`Short-Term`	The public URL for the organization.
`readonlyDashboardIPFilter`	string		`Short-Term`	IP filter for readonly dashboard links.
`searchDomains`	[`SearchDomain`]	yes	`Short-Term`	Search domains within the organization. See `SearchDomain`.
`stats`	`OrganizationStats`	yes	`Short-Term`	Statistics of the organization. See `OrganizationStats`.
`trialStartedAt`	long		`Short-Term`	Date organization's trial started.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes