API Stability Preview

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

For information on configuring a cache, see the CACHE_STORAGE_DIRECTORY reference page.

Syntax

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

graphql
setOrgDefaultCachePolicy(
     input: SetOrgDefaultCachePolicyInput!
   ): boolean

There are no special return datatypes for this mutation field. Below is an example of how it might be used:

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 $json = '{"query" : "mutation {
  setOrgDefaultCachePolicy( input:
    {
       policy: { prioritizeMillis: 1000 }
    }
  )
}"
}';
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/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": {
    "setOrgDefaultCachePolicy": true
  }
}

Given Datatypes

SetOrgDefaultCachePolicyInput has one parameter and a sub-parameter. See the description below and the link to the sub-parameter table:

Table: SetOrgDefaultCachePolicyInput

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