Atlassian: Sanitize JQL queries

Atlassian jql.sanitiseJqlQueries: arguments, response, policy and SDK examples.

Operation atlassian.sanitisejqlqueries

Provider route: POST /{cloudId}/rest/api/3/jql/sanitize. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["jql"]["sanitiseJqlQueries"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.jql.sanitiseJqlQueries(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.jql.sanitise_jql_queries(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`body`	Model	Required within parent	Expand Sanitize JQL queries — request body — body

Referenced models: Sanitize JQL queries — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Sanitize JQL queries — response body

Referenced models: Sanitize JQL queries — response body

Schemas

Sanitize JQL queries — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	The list of JQL queries to sanitize for the given account IDs. write Only: true Additional keys: not allowed
`queries`	array	Required within parent	The list of JQL queries to sanitize. Must contain unique values. Maximum of 20 queries.
`queries[]`	Model	Each item	Expand Sanitize JQL queries — request body — body queries item

Referenced models: Sanitize JQL queries — request body — body queries item

Sanitize JQL queries — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The sanitized JQL queries for the given account IDs.
`queries`	JSON	Optional
`queries (anyOf 1)`	array	Alternative	The list of sanitized JQL queries.
`queries (anyOf 1)[]`	Model	Each item	Expand Sanitize JQL queries — response body — queries The list of sanitized JQL queries item
`queries (anyOf 2)`	null	Alternative

Referenced models: Sanitize JQL queries — response body — queries The list of sanitized JQL queries item

Sanitize JQL queries — request body — body queries item

Field	Type	Presence	Description and constraints
`$`	object	Root	The JQL query to sanitize for the account ID. If the account ID is null, sanitizing is performed for an anonymous user. write Only: true Additional keys: not allowed
`accountId`	JSON	Optional
`accountId (anyOf 1)`	string	Alternative	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Maximum length: 128
`accountId (anyOf 2)`	null	Alternative
`query`	string	Required within parent	The query to sanitize.

Sanitize JQL queries — response body — queries The list of sanitized JQL queries item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the sanitized JQL query.
`accountId`	JSON	Optional
`accountId (anyOf 1)`	JSON	Alternative
`accountId (anyOf 1) (anyOf 1)`	string	Alternative	The account ID of the user for whom sanitization was performed. Maximum length: 128
`accountId (anyOf 1) (anyOf 2)`	null	Alternative
`accountId (anyOf 2)`	null	Alternative
`errors`	JSON	Optional
`errors (anyOf 1)`	Model	Alternative	Expand Validate project key — response body The list of errors.
`errors (anyOf 2)`	null	Alternative
`initialQuery`	JSON	Optional
`initialQuery (anyOf 1)`	string	Alternative	The initial query.
`initialQuery (anyOf 2)`	null	Alternative
`sanitizedQuery`	JSON	Optional
`sanitizedQuery (anyOf 1)`	JSON	Alternative
`sanitizedQuery (anyOf 1) (anyOf 1)`	string	Alternative	The sanitized query, if there were no errors.
`sanitizedQuery (anyOf 1) (anyOf 2)`	null	Alternative
`sanitizedQuery (anyOf 2)`	null	Alternative

Referenced models: Validate project key — response body

Validate project key — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Error messages from an operation.
`errorMessages`	JSON	Optional
`errorMessages (anyOf 1)`	array	Alternative	The list of error messages produced by this operation. For example, "input parameter 'key' must be provided"
`errorMessages (anyOf 1)[]`	string	Each item
`errorMessages (anyOf 2)`	null	Alternative
`errors`	JSON	Optional
`errors (anyOf 1)`	object	Alternative	The list of errors by parameter returned by the operation. For example,"projectKey": "Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters." Additional keys: see wildcard field
`errors (anyOf 1).*`	string	Additional keys
`errors (anyOf 2)`	null	Alternative
`status`	JSON	Optional
`status (anyOf 1)`	JSON	Alternative
`status (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int32
`status (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`status (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.sanitisejqlqueries. Catalog operation: sanitisejqlqueries. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["manage:jira-configuration"]

Official provider source

Report an issue with this page