updatePackageFromZip()

API Stability	`Long-Term`

The updatePackageFromZip() GraphQL mutation is used to update a package from a file provided in multipart/form-data (i.e., name=file) in a specified view.

For more information on packages, see the Packages documentation page.

Syntax

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

graphql

updatePackageFromZip(
      viewName: string!
      conflictResolutions: [ConflictResolutionConfiguration!]!
      queryOwnershipType: QueryOwnershipType
   ): BooleanResultType!

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

Show:

graphql

mutation {
  updatePackageFromZip(
       viewName: "humio",
       conflictResolutions: [ { entityType: Dashboard, 
                                entityName: "Errors",
                                conflictResolution: Ours },
                              { entityType: Dashboard, 
                                entityName: "Hosts",
                                conflictResolution: Ours }],
       queryOwnershipType: Organization
  )
  { result }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updatePackageFromZip(
       viewName: \"humio\",
       conflictResolutions: [ { entityType: Dashboard, 
                                entityName: \"Errors\",
                                conflictResolution: Ours },
                              { entityType: Dashboard, 
                                entityName: \"Hosts\",
                                conflictResolution: Ours }],
       queryOwnershipType: Organization
  )
  { result }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updatePackageFromZip(
       viewName: \"humio\",
       conflictResolutions: [ { entityType: Dashboard, 
                                entityName: \"Errors\",
                                conflictResolution: Ours },
                              { entityType: Dashboard, 
                                entityName: \"Hosts\",
                                conflictResolution: Ours }],
       queryOwnershipType: Organization
  )
  { result }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updatePackageFromZip( ^
       viewName: \"humio\", ^
       conflictResolutions: [ { entityType: Dashboard,  ^
                                entityName: \"Errors\", ^
                                conflictResolution: Ours }, ^
                              { entityType: Dashboard,  ^
                                entityName: \"Hosts\", ^
                                conflictResolution: Ours }], ^
       queryOwnershipType: Organization ^
  ) ^
  { result } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updatePackageFromZip(
       viewName: \"humio\",
       conflictResolutions: [ { entityType: Dashboard, 
                                entityName: \"Errors\",
                                conflictResolution: Ours },
                              { entityType: Dashboard, 
                                entityName: \"Hosts\",
                                conflictResolution: Ours }],
       queryOwnershipType: Organization
  )
  { result }
}"
}'
    "$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 {
  updatePackageFromZip(
       viewName: \"humio\",
       conflictResolutions: [ { entityType: Dashboard, 
                                entityName: \"Errors\",
                                conflictResolution: Ours },
                              { entityType: Dashboard, 
                                entityName: \"Hosts\",
                                conflictResolution: Ours }],
       queryOwnershipType: Organization
  )
  { result }
}"
}';
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 {
  updatePackageFromZip(
       viewName: \"humio\",
       conflictResolutions: [ { entityType: Dashboard, 
                                entityName: \"Errors\",
                                conflictResolution: Ours },
                              { entityType: Dashboard, 
                                entityName: \"Hosts\",
                                conflictResolution: Ours }],
       queryOwnershipType: Organization
  )
  { result }
}"
}'''

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 {
  updatePackageFromZip(
       viewName: \"humio\",
       conflictResolutions: [ { entityType: Dashboard, 
                                entityName: \"Errors\",
                                conflictResolution: Ours },
                              { entityType: Dashboard, 
                                entityName: \"Hosts\",
                                conflictResolution: Ours }],
       queryOwnershipType: Organization
  )
  { result }
}"
}
);


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

Given Datatypes

For ConflictResolutionConfiguration, there are a few parameters. Below is a list of them along with their a description of each:

Table: ConflictResolutionConfiguration

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 17, 2024
`conflictResolution`	`MergeStrategy`	yes	`Long-Term`	How conflicts are resolved. See `MergeStrategy`.
`entityName`	string	yes	`Long-Term`	The name of the entity. The type, `VersionedPackageSpecifier` is a scalar.
`entityType`	`AssetType`	yes	`Long-Term`	The type of entity. See `AssetType`.

QueryOwnershipType is an enumerated list of choices. Below is a list of them:

Table: QueryOwnershipType

Parameter	Type	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 16, 2024
`Organization`	boolean	`Long-Term`	Queries run on behalf of the organization.
`User`	boolean	`Long-Term`	Queries run on behalf of the user.

Returned Datatypes

BooleanResultType has a simple, boolean parameter. See the example above to understand better.

Table: BooleanResultType

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 24, 2024
`results`	boolean	yes	`Long-Term`	Whether the mutation was performed.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes