Export an NQL

Export large datasets to S3 and track export status

Export an NQL

get

Starts the execution of a query that will finish with the export of the results to a file in S3. The service response contains an identifier that can be used in the "status" operation to obtain the URL of the file with the results.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

queryIdstringRequired

Identifier of the query which is going to be executed.

Example: #my_query_id

compressionstringOptional

The compression algorithm for the export. If not set, no compression is applied. Allowed values: NONE, ZSTD, GZIP.

Example: ZSTD

Header parameters

AuthorizationstringOptional

Responses

200

OK - Successful execution.

application/json

401

Unauthorized - No valid authentication credentials.

403

No permission - Not authorized to execute queries.

application/json

404

Not found - No query associated with that ID.

500

Internal server error.

application/json

503

Service unavailable.

get

/api/v1/nql/export

HTTPcURLJavaScriptPython

GET /api/v1/nql/export?queryId=text HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "exportId": "text"
}

Export an NQL

post

Starts the execution of a query that will finish with the export of the results to a file in S3. The service response contains an identifier that can be used in the "status" operation to obtain the URL of the file with the results.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

AuthorizationstringOptional

Body

application/json

queryIdstring · min: 1 · max: 255Required

Identifier of the query which is going to be executed.

Example: #my_query_idPattern: ^#[a-z0-9_]{2,255}$

compressionstring · enum · nullableOptional

The compression algorithm for the export. If not set, no compression is applied.

Example: ZSTDPossible values:

Responses

200

OK - Successful execution.

application/json

401

Unauthorized - No valid authentication credentials.

403

No permission - Not authorized to execute queries

application/json

404

Not found - No query associated with that ID.

500

Internal server error.

application/json

503

Service unavailable.

post

/api/v1/nql/export

HTTPcURLJavaScriptPython

POST /api/v1/nql/export HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "queryId": "#my_query_id",
  "parameters": {
    "parameterName1": "parameterValue1",
    "parameterName2": "parameterValue2"
  },
  "compression": "ZSTD"
}

{
  "exportId": "text"
}

Status of an export

get

Retrieve the status of an export given its identifier.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

exportIdstringRequired

Export identifier

Header parameters

AuthorizationstringOptional

Responses

200

OK - Successful execution.

application/json

206

Partial Content - The query results were truncated because the maximum number of results allowed by the license was reached

application/json

401

Unauthorized - No valid authentication credentials.

403

No permission - Not authorized to execute queries.

application/json

404

Not found - No export associated with that ID.

429

Too many requests - The user has reached the daily request limit.

500

Internal server error.

application/json

503

Service unavailable.

get

/api/v1/nql/status/{exportId}

HTTPcURLJavaScriptPython

GET /api/v1/nql/status/{exportId} HTTP/1.1
Host: instance.api.region.nexthink.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "SUBMITTED",
  "resultsFileUrl": "text",
  "errorDescription": "text"
}