API StabilityLongTerm

The addSubdomain() GraphQL mutation is used to add a subdomain to the organization. Becomes primary subdomain if no primary has been set, and secondary otherwise. This is a preview and subject to change.

Syntax

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

graphql
addSubdomain(
      input: AddSubdomainInput!
   ): Organization!

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

Raw
graphql
mutation {
   addSubdomain(input: {subdomain: "sales" } ) 
   {id, name }
}
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 {
   addSubdomain(input: {subdomain: \"sales\" } ) 
   {id, name }
}"
}
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 {
   addSubdomain(input: {subdomain: \"sales\" } ) 
   {id, name }
}"
}
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 { ^
   addSubdomain(input: {subdomain: \"sales\" } )  ^
   {id, name } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
   addSubdomain(input: {subdomain: \"sales\" } ) 
   {id, name }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
   addSubdomain(input: {subdomain: \"sales\" } ) 
   {id, name }
}"
}';
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 {
   addSubdomain(input: {subdomain: \"sales\" } ) 
   {id, name }
}"
}'''

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 {
   addSubdomain(input: {subdomain: \"sales\" } ) 
   {id, name }
}"
}
);


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
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "addSubdomain": {
      "id": "SINGLE_ORGANIZATION_ID",
      "name": "SingleOrganization"
    }
  }
}

Given Datatypes

For AddSubdomainInput, there are a few parameters:

Table: AddSubdomainInput

ParameterTypeRequiredDefaultStabilityDescription
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 17, 2024
subdomainstringyes  The subdomain to add.

Returned Datatypes

For Organization, there are a few parameters:

Table: Organization

ParameterTypeRequiredDefaultStabilityDescription
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
cidstring   The CID corresponding to the organization.
configsOrganizationConfigsyes  Organization configurations and settings. See OrganizationDetails.
createdAtlong   Date organization was created.
defaultCachePolicyCachePolicy   The default cache policy of the organization. See CachePolicy. This is a preview and subject to change.
descriptionstring   The description for the Organization. Can be null.
detailsOrganizationDetailsyes  Any additional details related to the organization. See OrganizationDetails.
externalGroupSynchronizationbooleanyes  Whether there is group synchronization.
externalPermissionsbooleanyes  Whether permissions are managed externally.
idstringyes  The unique id for the Organization.
ingestUrlstring   The ingest URL for the organization.
isActionAllowedmultipleyes  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  Limits assigned to the organization. See Limit.
limitsV2[LimitV2]yes  Limits assigned to the organization. See LimitV2.
namestringyes  The name for the Organization.
publicUrlstring   The public URL for the organization.
readonlyDashboardIPFilterstring   IP filter for readonly dashboard links.
searchDomains[SearchDomain]yes  Search domains within the organization. See SearchDomain.
statsOrganizationStatsyes  Statistics of the organization. See OrganizationStats.
trialStartedAtlong   Date organization's trial started.