Summary

The setOrgDefaultCachePolicy() GraphQL mutation is used to set the default cache policy of the current organization. This policy will be applied to repositories within the current organization if a repository cache policy is set. This field is not yet available. It's described here as a preview. Cache policies are a limited feature and is subject to change.

API Stability Preview

Syntax

graphql
setOrgDefaultCachePolicy(
     input: SetOrgDefaultCachePolicyInput!
   ): boolean

For the input, you'll have to give the default cache policy, the newest caching segments that have priority. See the Input Parameters section.

For the results, the mutation returns true if it's successful, and false if not.

Example

Raw
graphql
mutation {
  setOrgDefaultCachePolicy( input:
    {
       policy: { prioritizeMillis: 1000 }
    }
  )
}
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 {
  setOrgDefaultCachePolicy( input:
    {
       policy: { prioritizeMillis: 1000 }
    }
  )
}"
}
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 {
  setOrgDefaultCachePolicy( input:
    {
       policy: { prioritizeMillis: 1000 }
    }
  )
}"
}
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 { ^
  setOrgDefaultCachePolicy( input: ^
    { ^
       policy: { prioritizeMillis: 1000 } ^
    } ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setOrgDefaultCachePolicy( input:
    {
       policy: { prioritizeMillis: 1000 }
    }
  )
}"
}'
    "$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 {
  setOrgDefaultCachePolicy( input:
    {
       policy: { prioritizeMillis: 1000 }
    }
  )
}";
$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 {
  setOrgDefaultCachePolicy( input:
    {
       policy: { prioritizeMillis: 1000 }
    }
  )
}"
}'''

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 {
  setOrgDefaultCachePolicy( input:
    {
       policy: { prioritizeMillis: 1000 }
    }
  )
}"
}
);


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": {
    "setOrgDefaultCachePolicy": true
  }
}

Input Parameters

For the input, you'll have to give the default cache policy, the newest caching segments that have priority. The table below provides the parameter to set, including a link to the sub-parameter needed:

Table: SetOrgDefaultCachePolicyInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
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: Sep 19, 2024
policyCachePolicyInput  PreviewThe organization's default cache policy to set. See CachePolicyInput.